@@ -6,21 +6,22 @@ OpenID Connect is a OAuth2 extension support by most identity providers.
66
77To configure OIDC, you must set the following environment variables:
88
9- | Variable | Usage |
10- | -------------------------------- | --------------------------------------------------------------------------------------------------- |
11- | ` OIDC_CLIENT_ID ` | Client ID from your identity provider. |
12- | ` OIDC_CLIENT_SECRET ` | Client secret from your identity provider. |
13- | ` OIDC_ADMIN_GROUP ` | Grant admin to users with this group configured in your identity provider. Tested with Authentik. |
14- | ` DISABLE_SIMPLE_AUTH ` (optional) | Disable simple auth |
15- | ` OIDC_USERNAME_CLAIM ` (optional) | Change the field that Drop pulls the username claim from. Users are merged based on their usernames |
9+ | Variable | Usage |
10+ | -------------------------------- | ----------------------------------------------------------------------------------------------------------- |
11+ | ` OIDC_CLIENT_ID ` | Client ID from your identity provider. |
12+ | ` OIDC_CLIENT_SECRET ` | Client secret from your identity provider. |
13+ | ` OIDC_ADMIN_GROUP ` | Grant admin to users with this group configured in your identity provider. Tested with Authentik. |
14+ | ` DISABLE_SIMPLE_AUTH ` (optional) | Disable simple auth |
15+ | ` OIDC_USERNAME_CLAIM ` (optional) | Change the field that Drop pulls the username claim from. Users are merged based on their usernames |
16+ | ` OIDC_PROVIDER_NAME ` (optional) | Change the name of the oidc provider that is displayed on the sign-in page. Default is ` external provider ` . |
1617
1718And then, you must configure ** either** :
1819
19- #### ` OIDC_WELLKNOWN ` : A unprotected endpoint that returns a OIDC well-known JSON. Fetched on startup.
20+ #### ` OIDC_WELLKNOWN ` : A unprotected endpoint that returns a OIDC well-known JSON. Fetched on startup
2021
2122---
2223
23- #### Individual endpoints:
24+ #### Individual endpoints
2425
2526| Variable | Usage |
2627| -------------------- | ------------------------------------------------------------------------- |
@@ -29,6 +30,6 @@ And then, you must configure **either**:
2930| ` OIDC_USERINFO ` | Userinfo endpoint. Usually ends with ` userinfo ` . |
3031| ` OIDC_SCOPES ` | Comma separated list of scopes. Requires, at least, ` openid ` and ` email ` . |
3132
32-
3333## Redirect URL
34- Drop uses the ` EXTERNAL_URL ` environment variable to create the callback URL: ` $EXTERNAL_URL/auth/callback/oidc ` .
34+
35+ Drop uses the ` EXTERNAL_URL ` environment variable to create the callback URL: ` $EXTERNAL_URL/auth/callback/oidc ` .
0 commit comments