Skip to content

Commit 833f915

Browse files
chore(config): use generic placeholder URLs in the OIDC example (#329)
The EXTERNAL SSO / OIDC sample in .env.example hardcoded PGAN's pogoalerts.net endpoints as the example provider. PoracleWeb is fully OIDC-provider-agnostic and open source, so the example should not be branded to one deployment. Replace the sample provider name and authorize/token/userinfo URLs with neutral placeholders (My SSO / https://sso.example.com/...), generalize the intro to list common providers (Keycloak, Authentik, Auth0, Okta), and add a note to swap in your provider's real endpoints. The per-provider reference matrix (which carries no URLs) is unchanged.
1 parent 8dfcca5 commit 833f915

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

.env.example

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,16 @@ TELEGRAM_ENABLED=false
7878
# ═══════════════════════════════════════════════════════════════════════════════
7979
# EXTERNAL SSO / OIDC (optional — delegate login to your own OAuth2/OIDC provider)
8080
# ═══════════════════════════════════════════════════════════════════════════════
81-
# Point PoracleWeb at any OAuth2/OIDC provider (e.g. PogoAlerts) for single sign-on.
81+
# Point PoracleWeb at any OAuth2/OIDC provider (Keycloak, Authentik, Auth0, Okta, …) for SSO.
8282
# The provider's userinfo endpoint must return a claim holding the user's Poracle id
8383
# (a Discord/Telegram id) — set OIDC_IDENTITY_CLAIM to that claim name.
8484
# Enabled is auto-inferred when ClientId + the three URLs are all set; set explicitly to override.
85+
# Replace the example URLs below with your provider's actual endpoints.
8586
# OIDC_ENABLED=true
86-
# OIDC_PROVIDER_NAME=PogoAlerts
87-
# OIDC_AUTHORIZATION_URL=https://pogoalerts.net/login
88-
# OIDC_TOKEN_URL=https://pogoalerts.net/api/oauth/token
89-
# OIDC_USERINFO_URL=https://pogoalerts.net/api/oauth/userinfo
87+
# OIDC_PROVIDER_NAME=My SSO
88+
# OIDC_AUTHORIZATION_URL=https://sso.example.com/authorize
89+
# OIDC_TOKEN_URL=https://sso.example.com/oauth/token
90+
# OIDC_USERINFO_URL=https://sso.example.com/oauth/userinfo
9091
# OIDC_CLIENT_ID=your_oidc_client_id
9192
# OIDC_CLIENT_SECRET=your_oidc_client_secret
9293
# OIDC_SCOPES=openid profile email

0 commit comments

Comments
 (0)