Skip to content

Commit 6a32753

Browse files
authored
Merge pull request #634 from Classic298/patch-2
Add warnings and infos to set `OPENID_PROVIDER_URL`
2 parents b40b957 + e8d21e9 commit 6a32753

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/getting-started/env-configuration.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2562,6 +2562,12 @@ Strictly return in JSON format:
25622562

25632563
## OAuth
25642564

2565+
:::info
2566+
2567+
You can only configure one OAUTH provider at a time. You cannot have two or more OAUTH providers configured simultaneously.
2568+
2569+
:::
2570+
25652571
#### `ENABLE_OAUTH_SIGNUP`
25662572

25672573
- Type: `bool`
@@ -2616,6 +2622,12 @@ If the OAuth picture claim is disabled by setting `OAUTH_PICTURE_CLAIM` to `''`
26162622

26172623
See https://support.google.com/cloud/answer/6158849?hl=en
26182624

2625+
:::info
2626+
2627+
You must also set `OPENID_PROVIDER_URL` or otherwise logout may not work.
2628+
2629+
:::
2630+
26192631
#### `GOOGLE_CLIENT_ID`
26202632

26212633
- Type: `str`
@@ -2646,6 +2658,12 @@ See https://support.google.com/cloud/answer/6158849?hl=en
26462658

26472659
See https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app
26482660

2661+
:::info
2662+
2663+
You must also set `OPENID_PROVIDER_URL` or otherwise logout may not work.
2664+
2665+
:::
2666+
26492667
#### `MICROSOFT_CLIENT_ID`
26502668

26512669
- Type: `str`
@@ -2682,6 +2700,12 @@ See https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-registe
26822700

26832701
See https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps
26842702

2703+
:::info
2704+
2705+
You must also set `OPENID_PROVIDER_URL` or otherwise logout may not work.
2706+
2707+
:::
2708+
26852709
#### `GITHUB_CLIENT_ID`
26862710

26872711
- Type: `str`
@@ -2728,6 +2752,13 @@ See https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-o
27282752
- Description: Path to the `.well-known/openid-configuration` endpoint
27292753
- Persistence: This environment variable is a `PersistentConfig` variable.
27302754

2755+
:::danger
2756+
2757+
The environment variable `OPENID_PROVIDER_URL` MUST be configured, otherwise the logout functionality will not work for most providers.
2758+
Even when using Microsoft, GitHub or other providers, you MUST set the `OPENID_PROVIDER_URL` environment variable.
2759+
2760+
:::
2761+
27312762
#### `OPENID_REDIRECT_URI`
27322763

27332764
- Type: `str`

0 commit comments

Comments
 (0)