diff --git a/docs/configuration.md b/docs/configuration.md index 88c8a5094..2867ef5bf 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1301,3 +1301,31 @@ started by the container. v1.9.2. A one-time migration is performed for users who have this setting set. This setting is always ignored if the corresponding 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=` + +: If this environment variable is set to true the button to login with SSO is enabled + +`PAPERLESS_SSO_DISABLE_NORMAL_AUTH=` + +: If this environment variable, the normal form to login is disabled + +`PAPERLESS_SSO_OIDC_KEY=` + +: Client ID of this application + +`PAPERLESS_SSO_OIDC_ENDPOINT=` + +: This variable must contain the OpenID configuration issuer, without `.well-known/openid-configuration` + +`PAPERLESS_SSO_OIDC_SECRET=` + +: Client secret of this application + +`PAPERLESS_SSO_OIDC_NAME=` + +: Value to display inside the button to login with openidconnect