Skip to content

Commit

Permalink
Update comments for env vars related to SSO
Browse files Browse the repository at this point in the history
  • Loading branch information
Bubka committed Dec 9, 2023
1 parent b9f4d94 commit 9d5d270
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ WEBAUTHN_USER_VERIFICATION=preferred

#### SSO settings (for Socialite) ####

# Uncomment lines for the OAuth providers you need.
# Uncomment and complete lines for the OAuth providers you want to enable.

# OPENID_AUTHORIZE_URL=
# OPENID_TOKEN_URL=
Expand Down
9 changes: 9 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,15 @@ ENV \
# 'preferred' (default) : Will ask for user verification IF POSSIBLE
# 'discouraged' : Will NOT ask for user verification (for example, to minimize disruption to the user interaction flow)
WEBAUTHN_USER_VERIFICATION=preferred \
#### SSO settings (for Socialite) ####
# Uncomment and complete lines for the OAuth providers you want to enable.
# OPENID_AUTHORIZE_URL= \
# OPENID_TOKEN_URL= \
# OPENID_USERINFO_URL= \
# OPENID_CLIENT_ID= \
# OPENID_CLIENT_SECRET= \
# GITHUB_CLIENT_ID= \
# GITHUB_CLIENT_SECRET= \
# Use this setting to declare trusted proxied.
# Supported:
# '*': to trust any proxy
Expand Down
15 changes: 9 additions & 6 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,6 @@ services:
# authentication checks. That means your proxy is fully responsible of the authentication process, 2FAuth will
# trust him as long as headers are presents.
- AUTHENTICATION_GUARD=web-guard
# OpenId settings
# - OPENID_AUTHORIZE_URL=
# - OPENID_TOKEN_URL=
# - OPENID_USERINFO_URL=
# - OPENID_CLIENT_ID=
# - OPENID_CLIENT_SECRET=
# Name of the HTTP headers sent by the reverse proxy that identifies the authenticated user at proxy level.
# Check your proxy documentation to find out how these headers are named (i.e 'REMOTE_USER', 'REMOTE_EMAIL', etc...)
# (only relevant when AUTHENTICATION_GUARD is set to 'reverse-proxy-guard')
Expand Down Expand Up @@ -113,6 +107,15 @@ services:
# 'preferred' (default) : Will ask for user verification IF POSSIBLE
# 'discouraged' : Will NOT ask for user verification (for example, to minimize disruption to the user interaction flow)
- WEBAUTHN_USER_VERIFICATION=preferred
#### SSO settings (for Socialite) ####
# Uncomment and complete lines for the OAuth providers you want to enable.
# - OPENID_AUTHORIZE_URL=
# - OPENID_TOKEN_URL=
# - OPENID_USERINFO_URL=
# - OPENID_CLIENT_ID=
# - OPENID_CLIENT_SECRET=
# - GITHUB_CLIENT_ID=
# - GITHUB_CLIENT_SECRET=
# Use this setting to declare trusted proxied.
# Supported:
# '*': to trust any proxy
Expand Down

0 comments on commit 9d5d270

Please sign in to comment.