lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation for sso configuration

Browse Source
This commit is contained in:
Louis Chauvet 2023-07-10 22:35:40 +02:00 committed by shamoon
parent 467bacdbd6
commit ff9cfb1958
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/configuration.md
View File

@ -1301,3 +1301,31 @@ started by the container.
v1.9.2. A one-time migration is performed for users who have this v1.9.2. A one-time migration is performed for users who have this
setting set. This setting is always ignored if the corresponding setting set. This setting is always ignored if the corresponding
frontend setting has been set. frontend setting has been set.
## SSO with OpenIDConnect
To configure OpenIDConnect you need a provider. The redirect url is `${PAPERLESS_URL}/accounts/complete/oidc/`.
`PAPERLESS_SSO_OIDC_ENABLE=<bool>`
: If this environment variable is set to true the button to login with SSO is enabled
`PAPERLESS_SSO_DISABLE_NORMAL_AUTH=<bool>`
: If this environment variable, the normal form to login is disabled
`PAPERLESS_SSO_OIDC_KEY=<str>`
: Client ID of this application
`PAPERLESS_SSO_OIDC_ENDPOINT=<url>`
: This variable must contain the OpenID configuration issuer, without `.well-known/openid-configuration`
`PAPERLESS_SSO_OIDC_SECRET=<str>`
: Client secret of this application
`PAPERLESS_SSO_OIDC_NAME=<str>`
: Value to display inside the button to login with openidconnect