From 9d5d2705e484573c6186fc30c895789993f9489d Mon Sep 17 00:00:00 2001
From: Bubka <858858+Bubka@users.noreply.github.com>
Date: Sat, 9 Dec 2023 17:35:34 +0100
Subject: [PATCH] Update comments for env vars related to SSO

---
 .env.example              |  2 +-
 Dockerfile                |  9 +++++++++
 docker/docker-compose.yml | 15 +++++++++------
 3 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/.env.example b/.env.example
index eff1e90a..a6b13005 100644
--- a/.env.example
+++ b/.env.example
@@ -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=
diff --git a/Dockerfile b/Dockerfile
index 8067afbb..ae5be575 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -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
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index 2f751829..05313561 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -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')
@@ -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