@lobehub/chat 1.0.0 → 1.0.2

package/docs/self-hosting/advanced/sso-providers/github.zh-CN.mdx

@@ -0,0 +1,95 @@
+---
+title: 在 LobeChat 中配置 Github 身份验证服务
+description: 学习如何在 LobeChat 中配置Github身份验证服务，包括创建新的Github App、设置权限和环境变量。
+tags:
+  - Github 身份验证
+  - Github App
+  - 环境变量配置
+  - 单点登录
+  - LobeChat
+---
+
+# 配置 Github 身份验证服务
+
+## Github 配置流程
+
+<Steps>
+  ### 创建 Github 提供应用
+
+点击[这里](https://github.com/settings/apps/new) 创建一个新的 Github App。
+
+填写Github App name、Homepage URL、Callbak URL
+
+<Image
+  alt="创建 Github 提供程序"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/64475363/2f919f99-2aaa-4fa7-9938-169d3ed09db7"
+/>
+按照自己所需设置Webhook回调地址
+
+<Image
+  alt="填写其他字段"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/64475363/d7ef5ad1-b1a3-435e-b1bc-4436d2b6fecd"
+/>
+
+设置读取邮件地址权限
+
+<Image
+  alt="设置所需权限"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/64475363/23131ca1-9e84-4a89-a840-ef79c4bc0251"
+/>
+<Image
+  alt="设置读取邮件地址权限"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/64475363/358bca8d-3d82-4e76-9a5e-90d16a39efde"
+/>
+
+设置公开访问还是仅自己访问
+
+<Image
+  alt="设置公开访问还是仅自己访问"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/64475363/995780cb-9096-4a36-ab17-d422703ab970"
+/>
+
+点击「Create Github App」
+
+创建成功后，点击「Generate a new client secret」创建客户端Secret
+
+<Image
+  alt="创建新的客户端密钥"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/64475363/6d69bdca-7d18-4cbc-b3e0-220d8815cd29"
+/>
+
+创建成功后， 将 `客户端 ID` 和 `客户端 Secret` 保存下来。
+
+<Image
+  alt="创建新的客户端密钥"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/64475363/c6108133-a918-48b0-ab1a-e3fa607572a4"
+/>
+
+### 配置环境变量
+
+在部署 LobeChat 时，你需要配置以下环境变量：
+
+| 环境变量 | 类型 | 描述 |
+| --- | --- | --- |
+| `ENABLE_OAUTH_SSO` | 必选 | 为 LobeChat 启用单点登录 (SSO)。设置为 `1` 以启用单点登录。 |
+| `NEXTAUTH_SECRET` | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥： `openssl rand -base64 32` |
+| `SSO_PROVIDERS` | 必选 | 选择 LoboChat 的单点登录提供商。使用 Github 请填写 `github`。 |
+| `GITHUB_CLIENT_ID` | 必选 | Github App详情页的 客户端 ID |
+| `GITHUB_CLIENT_SECRET` | 必选 | Github App详情页的 客户端 Secret |
+| `ACCESS_CODE` | 必选 | 添加访问此服务的密码，你可以设置一个足够长的随机密码以 “禁用” 访问码授权 |
+| `NEXTAUTH_URL` | 可选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址，当默认生成的重定向地址发生不正确时才需要设置。`https://example.com/api/auth` |
+
+  <Callout type={'tip'}>
+    前往 [📘 环境变量](/docs/self-hosting/environment-variable#Github) 可查阅相关变量详情。
+
+</Callout>
+</Steps>
+
+<Callout type={'info'}>部署成功后，用户将可以通过Github身份认证并使用 LobeChat。</Callout>

package/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.mdx

@@ -0,0 +1,106 @@
+---
+title: Configuration of Microsoft Entra ID Authentication Service for LobeChat
+description: >-
+  Learn how to configure Microsoft Entra ID Authentication Service for LobeChat,
+  create applications, add users, and set up environment variables for seamless
+  integration.
+tags:
+  - Microsoft Entra ID
+  - Authentication Service
+  - Azure Portal
+  - SSO
+  - Environment Variables
+  - LobeChat
+---
+
+# Configuration of Microsoft Entra ID Authentication Service
+
+<Steps>
+  ### Create a Microsoft Entra ID Application
+
+In your [Microsoft Azure Portal][microsoft-azure-portal], go to Microsoft Entra ID -> App registrations -> New registration to create a new application.
+
+Fill in the desired application name to be displayed to organizational users, choose the account types you wish to support, and if only internal users are supported, select `Accounts in this organizational directory only (Default Directory only - Single tenant)`.
+
+In the `Redirect URI (optional)` section, for the application type, select `Web`, and in the Callback URL, enter:
+
+```bash
+https://your-domain/api/auth/callback/azure-ad
+```
+
+<Callout type={'info'}>
+  - You can fill in or modify the Redirect URIs after registering, but make sure the URL you enter
+  matches the deployed URL. - Please replace "your-domain" with your own domain.
+</Callout>
+
+<Image
+  alt="App Register"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/13883964/4f9d83bd-b3fc-4abc-bcf4-ccbad65c219d"
+/>
+
+Click on "Register".
+
+After successfully creating the application, click on the corresponding application to enter the application details page, and switch to the "Overview" tab to view the corresponding configuration information.
+
+<Image
+  alt="App Overview"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/13883964/48a0b702-05bd-4ce4-a007-a8ad00a36e5a"
+/>
+
+Go to "Certificates & secrets", select the "Client secrets" tab, click on "New client secret", fill in the description, select the expiration time, and click on "Add" to create a new client secret.
+
+<Image
+  alt="Create App Client Secret"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/13883964/c9d66fa0-158c-4bd3-a1fa-969e638259d2"
+/>
+
+<Callout type={'important'}>
+  Please make sure to save your client secret as this is your only chance to view it.
+</Callout>
+
+### Add Users
+
+Go back to the "Microsoft Entra ID" interface, enter "Users", click on "New user", fill in the user information, and click on "Create" to create a user for using LobeChat.
+
+### Configure Environment Variables
+
+When deploying LobeChat, you need to configure the following environment variables:
+
+| Environment Variable | Type | Description |
+| --- | --- | --- |
+| `ENABLE_OAUTH_SSO` | Required | Enable single sign-on (SSO) for LobeChat. Set to `1` to enable single sign-on. |
+| `NEXTAUTH_SECRET` | Required | Key used to encrypt Auth.js session tokens. You can generate the key using the following command: `openssl rand -base64 32` |
+| `SSO_PROVIDERS` | Required | Select the single sign-on provider for LoboChat. Use `azure-ad` for Microsoft Entra ID. |
+| `AZURE_AD_CLIENT_ID` | Required | Client ID of the Microsoft Entra ID application. |
+| `AZURE_AD_CLIENT_SECRET` | Required | Client Secret of the Microsoft Entra ID application. |
+| `AZURE_AD_TENANT_ID` | Required | Tenant ID of the Microsoft Entra ID application. |
+| `ACCESS_CODE` | Required | Add a password for accessing this service, you can set a sufficiently long random password to "disable" access code authorization. |
+| `NEXTAUTH_URL` | Optional | This URL is used to specify the callback address for Auth.js when performing OAuth authentication. It is only necessary to set it when the default generated redirect address is incorrect. `https://example.com/api/auth` |
+
+<Callout type={'tip'}>
+  You can refer to [📘 environment
+  variables](/docs/self-hosting/environment-variable#microsoft-entra-id) for details on related
+  variables.
+</Callout>
+
+</Steps>
+
+<Callout>
+  After successful deployment, users will be able to authenticate and use LobeChat using the users
+  configured in Microsoft Entra ID.
+</Callout>
+
+## Advanced Configuration
+
+Please explore further in the [Microsoft Entra ID Learning Center][microsoft-learn-entra].
+
+## Related Resources
+
+- [Quickstart: Register an app][microsoft-entra-register-app]
+
+[microsoft-azure-portal]: https://portal.azure.com/
+[microsoft-entra-register-app]: https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app
+[microsoft-learn-entra]: https://learn.microsoft.com/en-us/entra/identity/

package/docs/self-hosting/advanced/sso-providers/microsoft-entra-id.zh-CN.mdx

@@ -0,0 +1,100 @@
+---
+title: 在 LobeChat 中配置 Microsoft Entra ID 身份验证服务
+description: 学习如何在 LobeChat 中配置 Microsoft Entra ID 身份验证服务，包括创建应用、新增用户和配置环境变量。详细步骤和相关资料。
+tags:
+  - Microsoft Entra ID
+  - Microsoft Azure Portal
+  - 身份验证服务
+  - 应用注册
+  - 环境变量
+  - 用户管理
+---
+
+# 配置 Microsoft Entra ID 身份验证服务
+
+## Microsoft Entra ID 配置流程
+
+<Steps>
+  ### 创建 Microsoft Entra ID 应用
+
+在你的 [Microsoft Azure Portal][microsoft-azure-portal] 进入 Microsoft Entra ID -> App registrations -> New registration 创建一个新的应用。
+
+填写你想向组织用户显示的应用名称，选择你期望支持的账户类型，如果只支持内部用户请选择 `Accounts in this organizational directory only (Default Directory only - Single tenant)`。
+
+在 `Redirect URI (optional)` 中，应用类型选择 `Web`，Callback URL, 处填写：
+
+```bash
+https://your-domain/api/auth/callback/azure-ad
+```
+
+<Callout type={'info'}>
+  - 可以在 Register 后再填写或修改 Redirect URIs，但是务必保证填写的 URL 与部署的 URL 一致。 -
+  your-domain 请填写自己的域名
+</Callout>
+
+<Image
+  alt="App Register"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/13883964/4f9d83bd-b3fc-4abc-bcf4-ccbad65c219d"
+/>
+
+点击「Register」
+
+创建成功后，点击相应的应用，进入应用详情页，切换到「Overview」标签页，就可以看到相应的配置信息。
+
+<Image
+  alt="App Overview"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/13883964/48a0b702-05bd-4ce4-a007-a8ad00a36e5a"
+/>
+
+进入「Certificates & secrets」，选择「Client secrets」标签，点击「New client secret」，填写描述，选择过期时间，点击「Add」，创建一个新的客户端密钥。
+
+<Image
+  alt="Create App Client Secret"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/13883964/c9d66fa0-158c-4bd3-a1fa-969e638259d2"
+/>
+
+<Callout type={'important'}>请务必保存好你的客户端密钥，因为这是你唯一的机会查看它。</Callout>
+
+### 新增用户
+
+回到「Microsoft Entra ID」界面，进入「Users」，点击「New user」，填写用户信息，点击「Create」，创建用户以使用 LobeChat。
+
+### 配置环境变量
+
+在部署 LobeChat 时，你需要配置以下环境变量：
+
+| 环境变量 | 类型 | 描述 |
+| --- | --- | --- |
+| `ENABLE_OAUTH_SSO` | 必选 | 为 LobeChat 启用单点登录 (SSO)。设置为 `1` 以启用单点登录。 |
+| `NEXTAUTH_SECRET` | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥： `openssl rand -base64 32` |
+| `SSO_PROVIDERS` | 必选 | 选择 LoboChat 的单点登录提供商。使用 Microsoft Entra ID 请填写 `azure-ad`。 |
+| `AZURE_AD_CLIENT_ID` | 必选 | Microsoft Entra ID 应用程序的 Client ID |
+| `AZURE_AD_CLIENT_SECRET` | 必选 | Microsoft Entra ID 应用程序的 Client Secret |
+| `AZURE_AD_TENANT_ID` | 必选 | Microsoft Entra ID 应用程序的 Tenant ID |
+| `ACCESS_CODE` | 必选 | 添加访问此服务的密码，你可以设置一个足够长的随机密码以 “禁用” 访问码授权 |
+| `NEXTAUTH_URL` | 可选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址，当默认生成的重定向地址发生不正确时才需要设置。`https://example.com/api/auth` |
+
+  <Callout type={'tip'}>
+    前往 [📘 环境变量](/docs/self-hosting/environment-variable#microsoft-entra-id) 可查阅相关变量详情。
+
+</Callout>
+</Steps>
+
+<Callout type={'info'}>
+  部署成功后，用户将可以使用 Microsoft Entra ID 中配置的用户通过身份认证并使用 LobeChat。
+</Callout>
+
+## 进阶配置
+
+请在 [Microsoft Entra ID 学习中心][microsoft-learn-entra]，做进一步探索。
+
+## 相关资料
+
+- [快速注册应用指导][microsoft-entra-register-app]
+
+[microsoft-azure-portal]: https://portal.azure.com/
+[microsoft-entra-register-app]: https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app
+[microsoft-learn-entra]: https://learn.microsoft.com/en-us/entra/identity/

package/docs/self-hosting/advanced/sso-providers/zitadel.mdx

@@ -0,0 +1,120 @@
+---
+title: Configure ZITADEL Authentication Service for LobeChat
+description: >-
+  Learn how to configure ZITADEL Authentication Service for LobeChat deployment,
+  including creating ZITADEL applications, setting up environment variables, and
+  enabling single sign-on (SSO).
+tags:
+  - ZITADEL Authentication
+  - LobeChat Deployment
+  - Single Sign-On (SSO)
+  - Environment Variables
+  - ZITADEL Applications
+---
+
+# Configure ZITADEL Authentication Service
+
+<Steps>
+  ### Create ZITADEL Application
+
+Log in to the console of your ZITADEL instance using an account with at least a [`Project Owner` role](https://zitadel.com/docs/guides/manage/console/managers#roles), navigate to (or [create](https://zitadel.com/docs/guides/manage/console/projects#create-a-project)) the project you'd like to host your application in, and click the **New** button to create an application.
+
+<Image
+  alt="Create ZITADEL Application S1"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/b05473ad-04a6-4ebc-9810-116c778d4448"
+/>
+
+Fill in the name, choose **Web** as the application type, and click **Continue**.
+
+<Image
+  alt="Create ZITADEL Application S2"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/5a0e6c58-9e6f-4ffb-8af2-32e48cfb45b0"
+/>
+
+Choose **Code** as the authentication method.
+
+<Image
+  alt="Create ZITADEL Application S3"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/14ecaa12-74a1-4e2f-b171-9d9ac09d3d63"
+/>
+
+In the **Redirect URIs** field, fill in:
+
+```
+http(s)://your-domain/api/auth/callback/zitadel
+```
+
+<Image
+  alt="Create ZITADEL Application S4"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/4ff3c3a0-9ca0-45ff-8f3a-219f4445098b"
+/>
+
+<Callout type={'important'}>
+  - You can fill in or modify redirect URIs after creating the application, but make sure the filled
+  URL is consistent with the deployed URL.
+
+  - Replace `http(s)://your-domain` with the actual URL that LobeChat is deployed to.
+</Callout>
+
+Confirm the configuration and click **Create**.
+
+<Image
+  alt="Create ZITADEL Application S5"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/bee24764-aa42-47d9-ad43-bcb8e7b35bc3"
+/>
+
+Save the **ClientId** and **ClientSecret** for later use.
+
+<Image
+  alt="Create ZITADEL Application S6"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/407b4eed-7f21-4aa6-b68f-9bae2faf09d0"
+/>
+
+In the application settings page, navigate to the **Token Settings** tab, enable **User Info inside
+ID Token** option, and click **Save**.
+
+<Image
+  alt="Create ZITADEL Application S7"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/d84235b1-45f6-447d-bdd9-58ab9527dc9b"
+/>
+
+Navigate to the **URLs** tab, and save the **issuer** URL.
+
+<Image
+  alt="Create ZITADEL Application S8"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/d12a2661-7b98-484f-8f3d-07e84d42ae08"
+/>
+
+### Configure Environment Variables
+
+When deploying LobeChat, you need to configure the following environment variables:
+
+| Environment Variable | Type | Description |
+| --- | --- | --- |
+| `ENABLE_OAUTH_SSO` | Required | Enable single sign-on (SSO) for LobeChat. Set to `1` to enable single sign-on. |
+| `NEXTAUTH_SECRET` | Required | Key used to encrypt Auth.js session tokens. You can generate a key using the following command: `openssl rand -base64 32` |
+| `SSO_PROVIDERS` | Optional | Select the single sign-on provider for LoboChat. Use `zitadel` for ZITADEL. |
+| `ZITADEL_CLIENT_ID` | Required | Client ID (`ClientId` as shown in ZITADEL) of the ZITADEL application |
+| `ZITADEL_CLIENT_SECRET` | Required | Client Secret (`ClientSecret` as shown in ZITADEL) of the ZITADEL application |
+| `ZITADEL_ISSUER` | Required | Issuer URL of the ZITADEL application |
+| `ACCESS_CODE` | Required | Add a password to access this service. You can set a sufficiently long random password to "disable" access code authorization. |
+| `NEXTAUTH_URL` | Optional | The URL is used to specify the callback address for the execution of OAuth authentication in Auth.js. It needs to be set only when the default address is incorrect. `https://example.com/api/auth` |
+
+  <Callout type={'tip'}>
+    You can refer to the related variable details at [📘Environment Variables](/docs/self-hosting/environment-variables/auth#zitadel).
+
+</Callout>
+</Steps>
+
+<Callout>
+  After successful deployment, users will be able to authenticate and use LobeChat using existing
+  users configured in ZITADEL.
+</Callout>

package/docs/self-hosting/advanced/sso-providers/zitadel.zh-CN.mdx

@@ -0,0 +1,112 @@
+---
+title: 在 LobeChat 中配置 ZITADEL 身份验证服务
+description: 学习如何在 LobeChat 中配置 ZITADEL 身份验证服务，包括创建应用、配置环境变量等步骤。
+tags:
+  - ZITADEL
+  - 身份验证服务
+  - 环境变量配置
+  - 单点登录
+  - LobeChat
+---
+
+# 配置 ZITADEL 身份验证服务
+
+<Steps>
+  ### 创建 ZITADEL 应用
+
+使用具有 [`Project Owner` 角色](https://zitadel.com/docs/guides/manage/console/managers#roles)的账户登录到 ZITADEL 实例控制台，进入（或[创建](https://zitadel.com/docs/guides/manage/console/projects#create-a-project)）该应用所属的项目，点击「创建」按钮创建应用。
+
+<Image
+  alt="创建 ZITADEL 应用 1"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/3564110d-bef9-47f3-b775-e5f28b4275b2"
+/>
+
+填写应用名称，应用类型选择「Web」，点击「继续」。
+
+<Image
+  alt="创建 ZITADEL 应用 2"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/12451b47-8dcd-40a9-b18d-2806b07efecc"
+/>
+
+选择「Code」作为身份验证方式。
+
+<Image
+  alt="创建 ZITADEL 应用 3"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/9d5cb651-ad10-47c7-8c8b-2256163c5521"
+/>
+
+在「重定向 URLs」字段中填写：
+
+```
+http(s)://your-domain/api/auth/callback/zitadel
+```
+
+<Image
+  alt="创建 ZITADEL 应用 4"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/1699bf46-0c8d-4238-9eb5-34282bfe529a"
+/>
+
+<Callout type={'important'}>
+  - 可以创建应用后再填写或修改重定向 URL，但请确保填写的 URL 与部署的 URL 一致。
+
+  - 请将 `http(s)://your-domain` 替换为 LobeChat 部署的实际 URL。
+</Callout>
+
+确认配置并点击「创建」。
+
+<Image
+  alt="创建 ZITADEL 应用 5"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/375b3d73-6796-465c-9063-f2762093f763"
+/>
+
+记录下「ClientId」和「ClientSecret」备用。
+
+<Image
+  alt="创建 ZITADEL 应用 6"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/40bb6b4c-18e0-4ae5-abae-ae0cf202cf08"
+/>
+
+在应用设置页面中，切换到「令牌设置」选项卡，勾选「在 ID Token 中包含用户信息」选项，点击「保存」。
+
+<Image
+  alt="创建 ZITADEL 应用 7"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/20a257b5-d086-46f3-b5c2-f76394b11f55"
+/>
+
+切换到「URLs」选项卡，记录下「issuer」URL。
+
+<Image
+  alt="创建 ZITADEL 应用 8"
+  inStep
+  src="https://github.com/lobehub/lobe-chat/assets/8692892/79c55d44-8dcb-429c-a072-d3eb014bbceb"
+/>
+
+### 配置环境变量
+
+部署 LobeChat 时，您需要配置以下环境变量：
+
+| 环境变量 | 类型 | 描述 |
+| --- | --- | --- |
+| `ENABLE_OAUTH_SSO` | 必选 | 为 LobeChat 启用单点登录（SSO）。设置为 `1` 以启用单点登录。 |
+| `NEXTAUTH_SECRET` | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成密钥：`openssl rand -base64 32` |
+| `SSO_PROVIDERS` | 可选 | 为 LobeChat 选择单点登录提供程序。对于 ZITADEL，请填写 `zitadel`。 |
+| `ZITADEL_CLIENT_ID` | 必选 | ZITADEL 应用的 Client ID（`ClientId`）。 |
+| `ZITADEL_CLIENT_SECRET` | 必选 | ZITADEL 应用的 Client Secret（`ClientSecret`）。 |
+| `ZITADEL_ISSUER` | 必选 | ZITADEL 应用的 OpenID Connect 颁发者（issuer）URL。 |
+| `ACCESS_CODE` | 必选 | 添加访问此服务的代码。您可以设置一个足够长的随机密码以「禁用」访问码授权。 |
+| `NEXTAUTH_URL` | 可选 | 该 URL 用于指定 Auth.js 中执行 OAuth 认证的回调地址。仅当默认地址不正确时才需要设置。`https://example.com/api/auth` |
+
+  <Callout type={'tip'}>
+    您可以在 [📘 环境变量](/docs/self-hosting/environment-variables/auth#zitadel) 中查看相关变量的详细信息。
+
+</Callout>
+</Steps>
+
+<Callout>部署成功后，用户将能够通过 ZITADEL 中配置的用户进行身份验证并使用 LobeChat。</Callout>