Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Auth0

了解如何配置 LibreChat 以使用 Auth0 进行用户身份验证。

第一步:在 Auth0 中创建 SAML 应用程序

  1. 登录您的 Auth0 Dashboard。
  2. 导航至 Applications > Applications
  3. 点击 Create Application
  4. 输入一个应用程序名称(例如 LibreChat)并选择 Regular Web Application
  5. 点击 Create

auth0-1

第 2 步:配置 SAML 插件

  1. 在 Auth0 中打开新创建的应用程序。
  2. 前往 Addons 选项卡。
  3. 点击滑块以启用 SAML2 Web App
  4. 点击 SAML2 Web App 面板。
  5. 配置以下设置:
    • 应用程序回调 URL (Application Callback URL):将其设置为您的 LibreChat SAML 回调 URL: https://YOUR_DOMAIN/oauth/saml/callback
    • 设置(JSON 格式):使用以下配置:
      {
          "mappings": {
              "email": "email",
              "name": "username"
          }
      }

      注意

      如果您的应用程序需要其他属性(例如 given_namefamily_nameusernamepicture),请确保在 Auth0 SAML 设置中正确配置了这些映射。

  6. 点击 Save

auth0-2 auth0-3

步骤 3:获取 Auth0 SAML 元数据

  1. 一旦启用 SAML,请返回 SAML2 Web App 设置。
  2. 前往 Usage 选项卡。
  3. 点击 Identity Provider Certificate: Download Atuh0 certificate
  4. 使用 Issuer 来配置 SAML_ISSUER
  5. 使用 Identity Provider Login URL 来设置 SAML_ENTRY_POINT
  6. 将下载的 cert 文件复制到您的项目文件夹中

auth0-4

第 4 步:使用 SAML 配置 LibreChat

打开项目文件夹中的 .env 文件并添加以下变量:

SAML_ENTRY_POINT=https://dev-xxxxx.us.auth0.com/samlp/aaaaaa
SAML_ISSUER=urn:dev-xxxxx.us.auth0.com
SAML_CERT=dev-xxxxx.pem
SAML_CALLBACK_URL=/oauth/saml/callback
SAML_SESSION_SECRET=[JustGenerateARandomSessionSecret]
 
# Attribute mappings (optional)
SAML_EMAIL_CLAIM=
SAML_USERNAME_CLAIM=
SAML_GIVEN_NAME_CLAIM=
SAML_FAMILY_NAME_CLAIM=
SAML_PICTURE_CLAIM=
SAML_NAME_CLAIM=
 
# Logint buttion settings (optional)
SAML_BUTTON_LABEL=
SAML_IMAGE_URL=
 
# Whether the SAML Response should be signed.
# - If "true", the entire `SAML Response` will be signed.
# - If "false" or unset, only the `SAML Assertion` will be signed (default behavior).
# SAML_USE_AUTHN_RESPONSE_SIGNED=

这篇指南怎么样?