trustchain-oc1-orchestral
/
authentik
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

website/docs: fix config options with double-underscores not showing correctly 

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer 2021-04-22 22:31:24 +02:00
parent 799d186510
commit d67d5f73c5
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
website/docs/installation/docker-compose-config.md
View File

@ -13,51 +13,51 @@ Defaults to `info`.
## AUTHENTIK_ERROR_REPORTING ## AUTHENTIK_ERROR_REPORTING
- AUTHENTIK_ERROR_REPORTING__ENABLED - `AUTHENTIK_ERROR_REPORTING__ENABLED`
Enable error reporting. Defaults to `false`. Enable error reporting. Defaults to `false`.
Error reports are sent to https://sentry.beryju.org, and are used for debugging and general feedback. Anonymous performance data is also sent. Error reports are sent to https://sentry.beryju.org, and are used for debugging and general feedback. Anonymous performance data is also sent.
- AUTHENTIK_ERROR_REPORTING__ENVIRONMENT - `AUTHENTIK_ERROR_REPORTING__ENVIRONMENT`
Unique environment that is attached to your error reports, should be set to your email address for example. Defaults to `customer`. Unique environment that is attached to your error reports, should be set to your email address for example. Defaults to `customer`.
- AUTHENTIK_ERROR_REPORTING__SEND_PII - `AUTHENTIK_ERROR_REPORTING__SEND_PII`
Whether or not to send personal data, like usernames. Defaults to `false`. Whether or not to send personal data, like usernames. Defaults to `false`.
## AUTHENTIK_EMAIL ## AUTHENTIK_EMAIL
- AUTHENTIK_EMAIL__HOST - `AUTHENTIK_EMAIL__HOST`
Default: `localhost` Default: `localhost`
- AUTHENTIK_EMAIL__PORT - `AUTHENTIK_EMAIL__PORT`
Default: `25` Default: `25`
- AUTHENTIK_EMAIL__USERNAME - `AUTHENTIK_EMAIL__USERNAME`
Default: `""` Default: `""`
- AUTHENTIK_EMAIL__PASSWORD - `AUTHENTIK_EMAIL__PASSWORD`
Default: `""` Default: `""`
- AUTHENTIK_EMAIL__USE_TLS - `AUTHENTIK_EMAIL__USE_TLS`
Default: `false` Default: `false`
- AUTHENTIK_EMAIL__USE_SSL - `AUTHENTIK_EMAIL__USE_SSL`
Default: `false` Default: `false`
- AUTHENTIK_EMAIL__TIMEOUT - `AUTHENTIK_EMAIL__TIMEOUT`
Default: `10` Default: `10`
- AUTHENTIK_EMAIL__FROM - `AUTHENTIK_EMAIL__FROM`
Default: `authentik@localhost` Default: `authentik@localhost`
@ -65,20 +65,20 @@ Defaults to `info`.
## AUTHENTIK_OUTPOSTS ## AUTHENTIK_OUTPOSTS
- AUTHENTIK_OUTPOSTS__DOCKER_IMAGE_BASE - `AUTHENTIK_OUTPOSTS__DOCKER_IMAGE_BASE`
This is the prefix used for authentik-managed outposts. Default: `beryju/authentik`. This is the prefix used for authentik-managed outposts. Default: `beryju/authentik`.
## AUTHENTIK_AUTHENTIK ## AUTHENTIK_AUTHENTIK
- AUTHENTIK_AUTHENTIK__AVATARS - `AUTHENTIK_AUTHENTIK__AVATARS`
Controls which avatars are shown. Defaults to `gravatar`. Can be set to `none` to disable avatars. Controls which avatars are shown. Defaults to `gravatar`. Can be set to `none` to disable avatars.
- AUTHENTIK_AUTHENTIK__BRANDING__TITLE - `AUTHENTIK_AUTHENTIK__BRANDING__TITLE`
Branding title used throughout the UI. Defaults to `authentik`. Branding title used throughout the UI. Defaults to `authentik`.
- AUTHENTIK_AUTHENTIK__BRANDING__LOGO - `AUTHENTIK_AUTHENTIK__BRANDING__LOGO`
Logo shown in the sidebar and flow executions. Defaults to `/static/dist/assets/icons/icon_left_brand.svg` Logo shown in the sidebar and flow executions. Defaults to `/static/dist/assets/icons/icon_left_brand.svg`