From 8828436adfa4a31970bff1d915ad7db730c1ff8e Mon Sep 17 00:00:00 2001 From: Bert-Jan Fikse Date: Wed, 14 Jan 2026 15:47:42 +0100 Subject: [PATCH] chore: add minimal readme --- roles/authentik/README.md | 45 +++++++++++---------------------------- 1 file changed, 13 insertions(+), 32 deletions(-) diff --git a/roles/authentik/README.md b/roles/authentik/README.md index 225dd44..2fb18d1 100644 --- a/roles/authentik/README.md +++ b/roles/authentik/README.md @@ -1,38 +1,19 @@ -Role Name -========= +# Authentik -A brief description of the role goes here. +Deploys Authentik identity provider with Docker Compose. -Requirements ------------- +## Variables -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +See `defaults/main.yml` for all available variables. -Role Variables --------------- +## Blueprints -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +The role renders blueprints for: +- Local users (`authentik_local_users`) +- OIDC applications (`authentik_oidc_apps`) +- Proxy applications (`authentik_proxy_apps`) +- Proxy outposts (`authentik_proxy_outposts`) +- Entra ID sources (`authentik_entra_sources`) +- Login screen sources (`authentik_login_source_ids`) -Dependencies ------------- - -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. - -Example Playbook ----------------- - -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } - -License -------- - -BSD - -Author Information ------------------- - -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +Secrets are passed via `authentik_blueprint_env` using environment variable references. \ No newline at end of file