🏢 docs: GitHub Enterprise Auth SSO (#217)

* updated GitHub auth for enterprise login. * dotenv.mdx
LibreChat-AI · Feb 7, 2025 · af3097c · af3097c
1 parent d1aba87
commit af3097c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/pages/docs/configuration/authentication/OAuth2-OIDC/github.mdx b/pages/docs/configuration/authentication/OAuth2-OIDC/github.mdx
@@ -8,7 +8,7 @@ description: Learn how to configure LibreChat to use GitHub for user authenticat
 ## Create a GitHub Application
 
 - Go to your **[Github Developer settings](https://github.com/settings/apps)**
-- Create a new Github app
+- Create a new GitHub app
 
 ![image](https://github.com/danny-avila/LibreChat/assets/138638445/3a8b88e7-78f8-426e-bfc2-c5e3f8b21ccb)
 
@@ -57,8 +57,13 @@ DOMAIN_SERVER=https://your-domain.com # use http://localhost:3080 if not using a
 GITHUB_CLIENT_ID=your_client_id
 GITHUB_CLIENT_SECRET=your_client_secret
 GITHUB_CALLBACK_URL=/oauth/github/callback
+
+# GitHub Enterprise (optional)
+# Uncomment and configure the following if you are using GitHub Enterprise for authentication
+# GITHUB_ENTERPRISE_BASE_URL=https://your-ghe-instance.com
+# GITHUB_ENTERPRISE_USER_AGENT=YourEnterpriseAppName
 ```
 
 - Save the `.env` file
 
-> Note: If using docker, run `docker compose up -d` to apply the .env configuration changes
+> **Note:** If using Docker, run `docker compose up -d` to apply the .env configuration changes
diff --git a/pages/docs/configuration/dotenv.mdx b/pages/docs/configuration/dotenv.mdx
@@ -810,6 +810,8 @@ For more information: **[GitHub Authentication](/docs/configuration/authenticati
     ['GITHUB_CLIENT_ID', 'string', 'Your GitHub client ID.','GITHUB_CLIENT_ID='],
     ['GITHUB_CLIENT_SECRET', 'string', 'Your GitHub client secret.','GITHUB_CLIENT_SECRET='],
     ['GITHUB_CALLBACK_URL', 'string', 'The callback URL for GitHub authentication.','GITHUB_CALLBACK_URL=/oauth/github/callback'],
+    ['GITHUB_ENTERPRISE_BASE_URL', 'string', 'Optional: The base URL for your GitHub Enterprise instance.', 'GITHUB_ENTERPRISE_BASE_URL='],
+    ['GITHUB_ENTERPRISE_USER_AGENT', 'string', 'Optional: The user agent for GitHub Enterprise requests.', 'GITHUB_ENTERPRISE_USER_AGENT='],
   ]}
 />