Minor additions to the documentation

This commit is contained in:
Moritz Pflanzer 2024-02-07 16:00:01 +01:00
parent 01f0c4385f
commit c9b12b8fb1

View File

@ -665,17 +665,17 @@ for more information.
As an example, to set up login via Github, the following environment variables would need to be As an example, to set up login via Github, the following environment variables would need to be
set: set:
qweqweqweq
```conf ```conf
PAPERLESS_APPS="allauth.socialaccount.providers.github" PAPERLESS_APPS="allauth.socialaccount.providers.github"
PAPERLESS_SOCIALACCOUNT_PROVIDERS='{"github": {"APPS": [{"provider_id": "github","name": "Github","client_id": "<CLIENT_ID>","secret": "<CLIENT_SECRET>"}]}}' PAPERLESS_SOCIALACCOUNT_PROVIDERS='{"github": {"APPS": [{"provider_id": "github","name": "Github","client_id": "<CLIENT_ID>","secret": "<CLIENT_SECRET>"}]}}'
``` ```
Or, to use OpenID Connect ("OIDC"): Or, to use OpenID Connect ("OIDC"), via Keycloak in this example:
```conf ```conf
PAPERLESS_APPS="allauth.socialaccount.providers.openid_connect" PAPERLESS_APPS="allauth.socialaccount.providers.openid_connect"
PAPERLESS_SOCIALACCOUNT_PROVIDERS=' PAPERLESS_SOCIALACCOUNT_PROVIDERS='
{"openid_connect": {"APPS": [{"provider_id": "keycloak","name": "Keycloak","client_id": "paperless","secret": "<CLIENT_SECRET>","settings": { "server_url": "https://<KEYCLOAK_SERVER>/realms/<REALM>/.well-known/openid-configuration"}}]}}' {"openid_connect": {"APPS": [{"provider_id": "keycloak","name": "Keycloak","client_id": "paperless","secret": "<CLIENT_SECRET>","settings": { "server_url": "https://<KEYCLOAK_SERVER>/realms/<REALM>/.well-known/openid-configuration"}}]}}'
``` ```
More details about configuration option for various providers can be found in the allauth documentation: https://docs.allauth.org/en/latest/socialaccount/providers/index.html#provider-specifics