Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
LibreChat/docs/install/configuration/OAuth2-and-OIDC/github.md
Danny Avila 1bafe80e78
🛂 feat: Required OpenID Role (#2279) 
* feat: add possibility to filter by roles for OpenID provider

---------

Co-authored-by: Sirius <siriusfrk@gmail.com>
2024-04-02 03:08:17 -04:00

2.3 KiB
Raw Blame History

title description weight
GitHub Learn how to configure LibreChat to use GitHub for user authentication. -10

GitHub

Create a GitHub Application

image

GitHub Application Configuration

  • Give it a GitHub App name and set your Homepage URL
    • Example for localhost: http://localhost:3080
    • Example for a domain: https://example.com

image

  • Add a valid Callback URL:
    • Example for localhost: http://localhost:3080/oauth/github/callback
    • Example for a domain: https://example.com/oauth/github/callback

image

  • Uncheck the box labeled Active in the Webhook section

image

  • Scroll down to Account permissions and set Email addresses to Access: Read-only

image

image

  • Click on Create GitHub App

image

.env Configuration

  • Click Generate a new client secret

image

  • Copy the Client ID and Client Secret in the .env file

image

DOMAIN_CLIENT=https://your-domain.com # use http://localhost:3080 if not using a custom domain
DOMAIN_SERVER=https://your-domain.com # use http://localhost:3080 if not using a custom domain

GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secret
GITHUB_CALLBACK_URL=/oauth/github/callback
  • Save the .env file

Note: If using docker, run docker compose up -d to apply the .env configuration changes