@lobehub/lobehub 2.0.0-next.332 → 2.0.0-next.333

package/docs/self-hosting/advanced/auth/legacy.mdx

@@ -0,0 +1,106 @@
+---
+title: Legacy Authentication (NextAuth & Clerk)
+description: >-
+  Documentation for legacy authentication methods including NextAuth and Clerk.
+  For new deployments, we recommend using Better Auth.
+tags:
+  - Authentication Service
+  - Next Auth
+  - Clerk
+  - Legacy
+---
+
+# Legacy Authentication
+
+<Callout type={'warning'}>
+  **Legacy Notice**: NextAuth and Clerk are legacy authentication methods. For new deployments, we strongly recommend using [Better Auth](/docs/self-hosting/advanced/auth) for its simplicity and flexibility.
+</Callout>
+
+This page documents the legacy authentication methods (NextAuth and Clerk) for users who are still using these services.
+
+## Clerk
+
+Clerk is a comprehensive identity verification solution that provides a simple yet powerful API and services to handle user authentication and session management.
+
+LobeChat has deeply integrated with Clerk to provide users with a secure and convenient login and registration experience.
+
+By setting the environment variables `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` and `CLERK_SECRET_KEY` in LobeChat's environment, you can enable and use Clerk.
+
+<Callout type={'info'}>
+  For detailed Clerk configuration, see [Clerk Configuration Guide](/docs/self-hosting/advanced/auth/clerk).
+</Callout>
+
+## Next Auth
+
+Before using NextAuth, please set the following variables in LobeChat's environment variables:
+
+| Environment Variable             | Type     | Description                                                                                                                                                                                                                                |
+| -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `NEXT_PUBLIC_ENABLE_NEXT_AUTH`   | Required | This is used to enable the NextAuth service. Set it to `1` to enable it; changing this setting requires recompiling the application. Users deploying with the `lobehub/lobe-chat-database` image have this configuration added by default. |
+| `AUTH_SECRET`                    | Required | The key used to encrypt Auth.js session tokens. You can use the following command: `openssl rand -base64 32`, or visit `https://generate-secret.vercel.app/32` to generate the key.                                                        |
+| `AUTH_URL`                       | Required | This URL specifies the callback address for Auth.js when performing OAuth verification. Set this only if the default generated redirect address is incorrect. `https://example.com/api/auth`                                               |
+| `NEXT_AUTH_SSO_PROVIDERS`        | Optional | This environment variable is used to enable multiple identity verification sources simultaneously, separated by commas, for example, `auth0,microsoft-entra-id,authentik`.                                                                 |
+| `NEXT_AUTH_SSO_SESSION_STRATEGY` | Optional | The session strategy for Auth.js. Options are `jwt` or `database`. Default is `jwt`.                                                                                                                                                       |
+
+Currently supported identity verification services include:
+
+<Cards>
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/auth0'} title={'Auth0'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/microsoft-entra-id'} title={'Microsoft Entra ID'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/authentik'} title={'Authentik'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/github'} title={'Github'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/zitadel'} title={'ZITADEL'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/cloudflare-zero-trust'} title={'Cloudflare Zero Trust'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/authelia'} title={'Authelia'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/logto'} title={'Logto'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/keycloak'} title={'Keycloak'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/google'} title={'Google'} />
+
+  <Card href={'/docs/self-hosting/advanced/auth/next-auth/okta'} title={'Okta'} />
+</Cards>
+
+Click on the links to view the corresponding platform's configuration documentation.
+
+## Advanced Configuration
+
+To simultaneously enable multiple identity verification sources, please set the `NEXT_AUTH_SSO_PROVIDERS` environment variable, separating them with commas, for example, `auth0,microsoft-entra-id,authentik`.
+
+The order corresponds to the display order of the SSO providers.
+
+| SSO Provider          | Value                   | Additional Features |
+| --------------------- | ----------------------- | ------------------- |
+| Auth0                 | `auth0`                 |                     |
+| Authenlia             | `authenlia`             |                     |
+| Authentik             | `authentik`             |                     |
+| Casdoor               | `casdoor`               | `Webhook`           |
+| Cloudflare Zero Trust | `cloudflare-zero-trust` |                     |
+| Github                | `github`                |                     |
+| Logto                 | `logto`                 | `Webhook`           |
+| Microsoft Entra ID    | `microsoft-entra-id`    |                     |
+| ZITADEL               | `zitadel`               |                     |
+| Keycloak              | `keycloak`              |                     |
+| Google                | `google`                |                     |
+| Okta                  | `okta`                  |                     |
+
+## Additional Features
+
+### Webhook Support
+
+Allow LobeChat to receive notifications when user information is updated in the identity provider. Supported providers include Casdoor and Logto. Please refer to the specific provider documentation for configuration details.
+
+### Database Session
+
+Allow the session store in database, see also the [Auth.js Session Documentation](https://authjs.dev/concepts/session-strategies#database-session).
+
+## Other SSO Providers
+
+Please refer to the [Auth.js](https://authjs.dev/getting-started/authentication/oauth) documentation and feel free to submit a Pull Request.

package/docs/self-hosting/advanced/auth/legacy.zh-CN.mdx

@@ -0,0 +1,101 @@
+---
+title: 旧版身份验证（NextAuth 和 Clerk）
+description: 关于 NextAuth 和 Clerk 等旧版身份验证方法的文档。对于新部署，我们建议使用 Better Auth。
+tags:
+  - 身份验证服务
+  - Next Auth
+  - Clerk
+  - 旧版
+---
+
+# 旧版身份验证
+
+<Callout type={'warning'}>
+  **旧版提示**：NextAuth 和 Clerk 是旧版身份验证方案。对于新部署，我们强烈建议使用 [Better Auth](/zh/docs/self-hosting/advanced/auth)，它更简洁、更灵活。
+</Callout>
+
+本页面为仍在使用这些服务的用户提供旧版身份验证方案（NextAuth 和 Clerk）的文档。
+
+## Clerk
+
+Clerk 是一个全面的身份验证解决方案，它提供了简单而强大的 API 和服务来处理用户认证和会话管理。
+
+LobeChat 与 Clerk 做了深度集成，能够为用户提供安全、便捷的登录和注册体验。
+
+在 LobeChat 的环境变量中设置 `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` 和 `CLERK_SECRET_KEY`，即可开启和使用 Clerk。
+
+<Callout type={'info'}>
+  详细的 Clerk 配置请参阅 [Clerk 配置指南](/zh/docs/self-hosting/advanced/auth/clerk)。
+</Callout>
+
+## Next Auth
+
+在使用 NextAuth 之前，请先在 LobeChat 的环境变量中设置以下变量：
+
+| 环境变量                             | 类型 | 描述                                                                                                           |
+| -------------------------------- | -- | ------------------------------------------------------------------------------------------------------------ |
+| `NEXT_PUBLIC_ENABLE_NEXT_AUTH`   | 必选 | 用于启用 NextAuth 服务，设置为 `1` 以启用，更改此项需要重新编译应用。使用 `lobehub/lobe-chat-database` 镜像部署的用户已经默认添加了该项配置。                |
+| `NEXT_AUTH_SECRET`               | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令： `openssl rand -base64 32`，或者访问 `https://generate-secret.vercel.app/32` 生成秘钥。 |
+| `AUTH_URL`                       | 必选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址，当默认生成的重定向地址发生不正确时才需要设置。`https://example.com/api/auth`                  |
+| `NEXT_AUTH_SSO_PROVIDERS`        | 可选 | 该环境变量用于同时启用多个身份验证源，以逗号 `,` 分割，例如 `auth0,microsoft-entra-id,authentik`。                                       |
+| `NEXT_AUTH_SSO_SESSION_STRATEGY` | 可选 | Auth.js 的会话策略。选项为 `jwt` 或 `database`。默认值为 `jwt`。                                                             |
+
+目前支持的身份验证服务有：
+
+<Cards>
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/auth0'} title={'Auth0'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/microsoft-entra-id'} title={'Microsoft Entra ID'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/authentik'} title={'Authentik'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/github'} title={'Github'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/zitadel'} title={'ZITADEL'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/cloudflare-zero-trust'} title={'Cloudflare Zero Trust'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/authelia'} title={'Authelia'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/logto'} title={'Logto'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/keycloak'} title={'Keycloak'} />
+
+  <Card href={'/zh/docs/self-hosting/advanced/auth/next-auth/okta'} title={'Okta'} />
+</Cards>
+
+点击即可查看对应平台的配置文档。
+
+## 进阶配置
+
+同时启用多个身份验证源请设置 `NEXT_AUTH_SSO_PROVIDERS` 环境变量，以逗号 `,` 分割，例如 `auth0,microsoft-entra-id,authentik`。
+
+顺序为 SSO 提供商的显示顺序。
+
+| SSO 提供商               | 值                       | 额外功能      |
+| --------------------- | ----------------------- | --------- |
+| Auth0                 | `auth0`                 |           |
+| Authenlia             | `authenlia`             |           |
+| Authentik             | `authentik`             |           |
+| Casdoor               | `casdoor`               | `Webhook` |
+| Cloudflare Zero Trust | `cloudflare-zero-trust` |           |
+| Github                | `github`                |           |
+| Logto                 | `logto`                 | `Webhook` |
+| Microsoft Entra ID    | `microsoft-entra-id`    |           |
+| ZITADEL               | `zitadel`               |           |
+| Keycloak              | `keycloak`              |           |
+| Okta                  | `okta`                  |           |
+
+## 额外功能
+
+### Webhook 支持
+
+允许 LobeChat 在身份提供商中用户信息更新时接收通知。支持的提供商包括 Casdoor 和 Logto。请参考具体提供商文档进行配置。
+
+### 数据库会话
+
+允许会话存储在数据库中，详情请参阅 [Auth.js 会话文档](https://authjs.dev/concepts/session-strategies#database-session)。
+
+## 其他 SSO 提供商
+
+请参考 [NextAuth.js](https://next-auth.js.org/providers) 文档，欢迎提交 Pull Request。

package/docs/self-hosting/advanced/auth/next-auth/auth0.mdx

@@ -1,8 +1,9 @@
 ---
 title: Configure Auth0 Identity Verification Service for LobeChat
 description: >-
-  Learn how to configure Auth0 Identity Verification Service for LobeChat for your organization, including creating applications, adding users, and configuring environment variables.
-
+  Learn how to configure Auth0 Identity Verification Service for LobeChat for
+  your organization, including creating applications, adding users, and
+  configuring environment variables.
 tags:
   - Auth0
   - Identity Verification

package/docs/self-hosting/advanced/auth/next-auth/authelia.mdx

@@ -1,8 +1,9 @@
 ---
 title: Configuring Authelia Authentication Service for LobeChat
 description: >-
-  Learn how to configure Authelia authentication service in LobeChat, including creating a provider, configuring environment variables, and deploying LobeChat. Detailed steps and necessary environment variable settings.
-
+  Learn how to configure Authelia authentication service in LobeChat, including
+  creating a provider, configuring environment variables, and deploying
+  LobeChat. Detailed steps and necessary environment variable settings.
 tags:
   - Authelia Configuration
   - Single Sign-On (SSO)

package/docs/self-hosting/advanced/auth/next-auth/authentik.mdx

@@ -1,8 +1,9 @@
 ---
 title: Configuring Authentik Authentication Service for LobeChat
 description: >-
-  Learn how to configure Authentik for Single Sign-On (SSO) for LobeChat, including creating an application provider, setting environment variables, and deployment instructions.
-
+  Learn how to configure Authentik for Single Sign-On (SSO) for LobeChat,
+  including creating an application provider, setting environment variables, and
+  deployment instructions.
 tags:
   - Authentik Configuration
   - Single Sign-On (SSO)

package/docs/self-hosting/advanced/auth/next-auth/casdoor.mdx

@@ -1,8 +1,9 @@
 ---
 title: Configuring Casdoor Authentication Service in LobeChat
 description: >-
-  Learn how to configure the Casdoor authentication service in LobeChat, including deployment, creation, permission settings, and environment variables.
-
+  Learn how to configure the Casdoor authentication service in LobeChat,
+  including deployment, creation, permission settings, and environment
+  variables.
 tags:
   - Casdoor Authentication
   - Environment Variable Configuration
@@ -87,6 +88,8 @@ If you are deploying using a public network, the following assumptions apply:
         box-shadow: none;
       }
     }
+
+
   </style>
   ```
 

package/docs/self-hosting/advanced/auth/next-auth/casdoor.zh-CN.mdx

@@ -85,6 +85,8 @@ tags:
         box-shadow: none;
       }
     }
+
+
   </style>
   ```
 

package/docs/self-hosting/advanced/auth/next-auth/cloudflare-zero-trust.mdx

@@ -1,8 +1,9 @@
 ---
 title: Configuring Cloudflare Zero Trust Authentication Service for LobeChat
 description: >-
-  Learn how to configure Cloudflare Zero Trust for Single Sign-On (SSO) for LobeChat, including creating an application provider, setting environment variables, and deployment instructions.
-
+  Learn how to configure Cloudflare Zero Trust for Single Sign-On (SSO) for
+  LobeChat, including creating an application provider, setting environment
+  variables, and deployment instructions.
 tags:
   - Cloudflare Zero Trust
   - Single Sign-On (SSO)

package/docs/self-hosting/advanced/auth/next-auth/cloudflare-zero-trust.zh-CN.mdx

@@ -1,8 +1,8 @@
 ---
 title: 在 LobeChat 中配置 Cloudflare Zero Trust 身份验证服务
 description: >-
-  学习如何在 LobeChat 中配置 Cloudflare Zero Trust 身份验证服务，包括创建提供程序、配置环境变量和部署 LobeChat。详细步骤和必要环境变量设置。
-
+  学习如何在 LobeChat 中配置 Cloudflare Zero Trust 身份验证服务，包括创建提供程序、配置环境变量和部署
+  LobeChat。详细步骤和必要环境变量设置。
 tags:
   - Cloudflare Zero Trust
   - 身份验证

package/docs/self-hosting/advanced/auth/next-auth/github.mdx

@@ -1,8 +1,9 @@
 ---
 title: Configuring Github Authentication Service for LobeChat
 description: >-
-  Learn how to configure Github authentication service for LobeChat, including creating a Github provider, setting up environment variables, and deploying LobeChat.
-
+  Learn how to configure Github authentication service for LobeChat, including
+  creating a Github provider, setting up environment variables, and deploying
+  LobeChat.
 tags:
   - Github authentication
   - LobeChat

package/docs/self-hosting/advanced/auth/next-auth/google.mdx

@@ -1,19 +1,17 @@
 ---
-
 title: Configuration of Google SSO Authentication Service for LobeChat
 description: >-
-Learn how to configure Google SSO Authentication Service for LobeChat,
-create OAuth applications, add users, and set up environment variables for seamless integration.
+  Learn how to configure Google SSO Authentication Service for LobeChat, create
+  OAuth applications, add users, and set up environment variables for seamless
+  integration.
 tags:
-
-* Google SSO
-* Authentication Service
-* Google Cloud
-* OAuth
-* SSO
-* Environment Variables
-* LobeChat
-
+  - Google SSO
+  - Authentication Service
+  - Google Cloud
+  - OAuth
+  - SSO
+  - Environment Variables
+  - LobeChat
 ---
 
 # Configuration of Google SSO Authentication Service

package/docs/self-hosting/advanced/auth/next-auth/keycloak.mdx

@@ -1,8 +1,9 @@
 ---
 title: Configuring Keycloak Authentication Service in LobeChat
 description: >-
-  Learn how to configure the Keycloak authentication service in LobeChat, including deployment, creation, permission settings, and environment variables.
-
+  Learn how to configure the Keycloak authentication service in LobeChat,
+  including deployment, creation, permission settings, and environment
+  variables.
 tags:
   - Keycloak Authentication
   - Environment Variable Configuration

package/docs/self-hosting/advanced/auth/next-auth/logto.mdx

@@ -1,8 +1,8 @@
 ---
 title: Configuring Logto Authentication Service in LobeChat
 description: >-
-  Learn how to configure Logto authentication service in LobeChat, including deployment, creation, setting permissions, and environment variables.
-
+  Learn how to configure Logto authentication service in LobeChat, including
+  deployment, creation, setting permissions, and environment variables.
 tags:
   - Logto Authentication
   - Environment Variable Configuration

package/docs/self-hosting/advanced/auth/next-auth/microsoft-entra-id.mdx

@@ -1,8 +1,9 @@
 ---
 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.
-
+  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

package/docs/self-hosting/advanced/auth/next-auth/okta.mdx

@@ -1,8 +1,9 @@
 ---
 title: Configure Okta Identity Verification Service for LobeChat
 description: >-
-  Learn how to configure Okta Identity Verification Service for LobeChat for your organization, including creating applications, adding users, and configuring environment variables.
-
+  Learn how to configure Okta Identity Verification Service for LobeChat for
+  your organization, including creating applications, adding users, and
+  configuring environment variables.
 tags:
   - Okta
   - Identity Verification

package/docs/self-hosting/advanced/auth/next-auth/okta.zh-CN.mdx

@@ -1,8 +1,6 @@
 ---
 title: 在 LobeChat 中配置 Okta 身份验证服务 - 详细步骤和环境变量设置
-description: >-
-  学习如何在 LobeChat 中为您的组织配置 Okta 身份验证服务，包括创建应用程序、添加用户和配置环境变量等。
-
+description: 学习如何在 LobeChat 中为您的组织配置 Okta 身份验证服务，包括创建应用程序、添加用户和配置环境变量等。
 tags:
   - Okta
   - 身份验证

package/docs/self-hosting/advanced/auth/next-auth/wechat.mdx

@@ -1,8 +1,8 @@
 ---
 title: Configure Wechat Authentication Service in LobeChat
 description: >-
-  Learn how to configure Wechat authentication service in LobeChat, including creating a new Wechat App, setting permissions, and environment variables.
-
+  Learn how to configure Wechat authentication service in LobeChat, including
+  creating a new Wechat App, setting permissions, and environment variables.
 tags:
   - Wechat Authentication
   - Wechat App

package/docs/self-hosting/advanced/auth/next-auth/zitadel.mdx

@@ -1,8 +1,9 @@
 ---
 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).
-
+  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