@lobehub/chat 0.124.3 → 0.126.0

package/CHANGELOG.md

@@ -2,6 +2,64 @@
 
 # Changelog
 
+## [Version 0.126.0](https://github.com/lobehub/lobe-chat/compare/v0.125.0...v0.126.0)
+
+<sup>Released on **2024-02-09**</sup>
+
+#### ✨ Features
+
+- **misc**: Support umami analytics.
+
+#### 🐛 Bug Fixes
+
+- **misc**: The back button on the chat setting page can correctly return to the configured Agent chat page.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's improved
+
+- **misc**: Support umami analytics, closes [#1267](https://github.com/lobehub/lobe-chat/issues/1267) ([da7beba](https://github.com/lobehub/lobe-chat/commit/da7beba))
+
+#### What's fixed
+
+- **misc**: The back button on the chat setting page can correctly return to the configured Agent chat page, closes [#1272](https://github.com/lobehub/lobe-chat/issues/1272) ([4cc1ad5](https://github.com/lobehub/lobe-chat/commit/4cc1ad5))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+## [Version 0.125.0](https://github.com/lobehub/lobe-chat/compare/v0.124.3...v0.125.0)
+
+<sup>Released on **2024-02-08**</sup>
+
+#### ✨ Features
+
+- **misc**: Support login & session authentication via OAuth 2.0 (Auth0).
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's improved
+
+- **misc**: Support login & session authentication via OAuth 2.0 (Auth0), closes [#1143](https://github.com/lobehub/lobe-chat/issues/1143) ([0609690](https://github.com/lobehub/lobe-chat/commit/0609690))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.124.3](https://github.com/lobehub/lobe-chat/compare/v0.124.2...v0.124.3)
 
 <sup>Released on **2024-02-07**</sup>

package/README.md

@@ -225,14 +225,14 @@ Our marketplace is not just a showcase platform but also a collaborative space.
 
 <!-- AGENT LIST -->
 
-| Recent Submits                                                                                                                                              | Description                                                                                                                                                                                                                                                                                           |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [CAN: Code Master](https://chat-preview.lobehub.com/market?agent=can)<br/><sup>By **[MrHuangJser](https://github.com/MrHuangJser)** on **2024-02-06**</sup> | CAN: Professional coding expert with years of experience and no character limit. Provides entrepreneurial services such as creative naming, slogans, user profiles, pain points, value propositions, sales channels, revenue streams, and cost structures.<br/>`coding` `communication` `questioning` |
-| [Database Expert](https://chat-preview.lobehub.com/market?agent=dba)<br/><sup>By **[xuzhen1994](https://github.com/xuzhen1994)** on **2024-02-03**</sup>    | Provides professional advice on database design paradigms, index optimization, query performance tuning, data security, backup and recovery.<br/>`database` `dba` `mysql` `clickhouse` `doris` `mongo-db` `oracle`                                                                                    |
-| [Presentation Wizard](https://chat-preview.lobehub.com/market?agent=word)<br/><sup>By **[MYSeaIT](https://github.com/MYSeaIT)** on **2024-02-03**</sup>     | App Presentation Maker Bot for Word: Assists in creating impressive and professional app presentations in Microsoft Word.<br/>`app-presentation` `microsoft-word` `bot` `assistance` `template`                                                                                                       |
-| [SagePathfinder](https://chat-preview.lobehub.com/market?agent=sage-pathfinder)<br/><sup>By **[Ajasra](https://github.com/Ajasra)** on **2024-01-31**</sup> | Expert in personal growth coaching with a focus on stoicism, deep reflection, and strategic questioning.<br/>`personal-growth` `coaching` `reflection` `goal-setting` `well-being`                                                                                                                    |
-
-> 📊 Total agents: [<kbd>**150**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
+| Recent Submits                                                                                                                                                                             | Description                                                                                                                                                                                                                                                                                           |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Jira Story Facilitator](https://chat-preview.lobehub.com/market?agent=jira-product-manager)<br/><sup>By **[emad-pg](https://github.com/emad-pg)** on **2024-02-07**</sup>                 | A Product manager agent that is specialised in transforming feature ideas into comprehensive Jira stories drafts for your team to pick up.<br/>`product-management` `story-creation` `jira`                                                                                                           |
+| [Text Variator](https://chat-preview.lobehub.com/market?agent=text-variator)<br/><sup>By **[bentwnghk](https://github.com/bentwnghk)** on **2024-02-07**</sup>                             | Please provide the text you would like me to generate different versions of<br/>`copywriting` `editing` `creative-writing`                                                                                                                                                                            |
+| [Turkish/English Translator](https://chat-preview.lobehub.com/market?agent=turkish-english-translator)<br/><sup>By **[Zisan-uzum](https://github.com/Zisan-uzum)** on **2024-02-07**</sup> | Translates text into Turkish or English, as needed<br/>`turkish` `english` `translation` `writing`                                                                                                                                                                                                    |
+| [CAN: Code Master](https://chat-preview.lobehub.com/market?agent=can)<br/><sup>By **[MrHuangJser](https://github.com/MrHuangJser)** on **2024-02-06**</sup>                                | CAN: Professional coding expert with years of experience and no character limit. Provides entrepreneurial services such as creative naming, slogans, user profiles, pain points, value propositions, sales channels, revenue streams, and cost structures.<br/>`coding` `communication` `questioning` |
+
+> 📊 Total agents: [<kbd>**159**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
 
  <!-- AGENT LIST -->
 

package/README.zh-CN.md

@@ -205,14 +205,14 @@ LobeChat 的插件生态系统是其核心功能的重要扩展，它极大地
 
 <!-- AGENT LIST -->
 
-| 最近新增                                                                                                                                                    | 助手说明                                                                                                                                                   |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [CAN: 编程大师](https://chat-preview.lobehub.com/market?agent=can)<br/><sup>By **[MrHuangJser](https://github.com/MrHuangJser)** on **2024-02-06**</sup>    | CAN: 专业编程专家，多年经验，无字符限制。提供创意命名、标语、用户画像、痛点、价值主张、销售渠道、收入流、成本结构等创业计划服务。<br/>`编程` `交流` `提问` |
-| [数据库专家](https://chat-preview.lobehub.com/market?agent=dba)<br/><sup>By **[xuzhen1994](https://github.com/xuzhen1994)** on **2024-02-03**</sup>         | 提供关于数据库设计范式、索引优化、查询性能调优、数据安全、备份与恢复等方面的专业建议<br/>`数据库` `dba` `mysql` `clickhouse` `doris` `mongo-db` `oracle`   |
-| [演示向导](https://chat-preview.lobehub.com/market?agent=word)<br/><sup>By **[MYSeaIT](https://github.com/MYSeaIT)** on **2024-02-03**</sup>                | Word 应用演示制作机器人：帮助在 Microsoft Word 中创建令人印象深刻和专业的应用程序演示。<br/>`应用程序演示` `微软-word` `机器人` `辅助` `模板`              |
-| [SagePathfinder](https://chat-preview.lobehub.com/market?agent=sage-pathfinder)<br/><sup>By **[Ajasra](https://github.com/Ajasra)** on **2024-01-31**</sup> | 专注于斯多葛主义、深度反思和战略性提问的个人成长教练专家。<br/>`个人成长` `教练` `反思` `目标设定` `幸福感`                                                |
-
-> 📊 Total agents: [<kbd>**150**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
+| 最近新增                                                                                                                                                                              | 助手说明                                                                                                                                                   |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Jira 故事协助工具](https://chat-preview.lobehub.com/market?agent=jira-product-manager)<br/><sup>By **[emad-pg](https://github.com/emad-pg)** on **2024-02-07**</sup>                 | 一款专门将功能点子转化为全面的 Jira 故事草稿，供团队选择的产品经理代理。<br/>`产品管理` `故事创建` `jira`                                                  |
+| [文本变体生成器](https://chat-preview.lobehub.com/market?agent=text-variator)<br/><sup>By **[bentwnghk](https://github.com/bentwnghk)** on **2024-02-07**</sup>                       | 请提供您希望我生成不同版本的文本<br/>`文案撰写` `编辑` `创意写作`                                                                                          |
+| [土耳其语 / 英语翻译器](https://chat-preview.lobehub.com/market?agent=turkish-english-translator)<br/><sup>By **[Zisan-uzum](https://github.com/Zisan-uzum)** on **2024-02-07**</sup> | 根据需要将文本翻译成土耳其语或英语<br/>`土耳其语` `英语` `翻译` `写作`                                                                                     |
+| [CAN: 编程大师](https://chat-preview.lobehub.com/market?agent=can)<br/><sup>By **[MrHuangJser](https://github.com/MrHuangJser)** on **2024-02-06**</sup>                              | CAN: 专业编程专家，多年经验，无字符限制。提供创意命名、标语、用户画像、痛点、价值主张、销售渠道、收入流、成本结构等创业计划服务。<br/>`编程` `交流` `提问` |
+
+> 📊 Total agents: [<kbd>**159**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
 
  <!-- AGENT LIST -->
 

package/docs/Deployment/Authentication.md

@@ -0,0 +1,72 @@
+# Authentication Service
+
+LobeChat supports configuring external identity verification services for internal use within enterprises/organizations, facilitating centralized management of user authorizations. Currently, [Auth0][auth0-client-page] is supported. This article will guide you through the process of setting up the identity verification service.
+
+### TOC
+
+- [Creating an Auth0 Application](#creating-an-auth0-application)
+- [Adding Users](#adding-users)
+- [Configuring Environment Variables](#configuring-environment-variables)
+- [Advanced - Connecting to an Existing Single Sign-On Service](#advanced---connecting-to-an-existing-single-sign-on-service)
+- [Advanced - Configuring Social Login](#advanced---configuring-social-login)
+
+## Creating an Auth0 Application
+
+To begin, register and log in to [Auth0][auth0-client-page]. Then, navigate to the **_Applications_** section in the left sidebar to access the application management interface. Click on **_Create Application_** in the top right corner to initiate the application creation process.
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/1b405347-f4c3-4c55-82f6-47116f2210d0)
+
+Next, fill in the desired application name to be displayed to organization users. You can choose any application type, then click on **_Create_**.
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/75c92f85-3ad3-4473-a9c6-e667e28d428d)
+
+Once the application is successfully created, click on the respective application to access its details page. Switch to the **_Settings_** tab to view the corresponding configuration information.
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/a1ed996b-95ef-4b7d-a50d-b4666eccfecb)
+
+## Adding Users
+
+Navigate to the **_Users Management_** section in the left sidebar to access the user management interface. You can create new users for your organization to log in to LobeChat.
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/3b8127ab-dc4f-4ff9-a4cb-dec3ef0295cc)
+
+## Configuring Environment Variables
+
+When deploying LobeChat, you need to configure the following environment variables:
+
+| Environment Variable  | Required | Description                                                                                                                         | Default Value | Example                                                            |
+| --------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------ |
+| `ENABLE_OAUTH_SSO`    | Yes      | Enable single sign-on (SSO) for LobeChat. Set this value to `1` to enable single sign-on.                                           | -             | `1`                                                                |
+| `NEXTAUTH_SECRET`     | Yes      | The key used to encrypt the session token in Auth.js. You can generate a key using the following command: `openssl rand -base64 32` | -             | `Tfhi2t2pelSMEA8eaV61KaqPNEndFFdMIxDaJnS1CUI=`                     |
+| `AUTH0_CLIENT_ID`     | Yes      | Client ID of the Auth0 application                                                                                                  | -             | `evCnOJP1UX8FMnXR9Xkj5t0NyFn5p70P`                                 |
+| `AUTH0_CLIENT_SECRET` | Yes      | Client Secret of the Auth0 application                                                                                              | -             | `wnX7UbZg85ZUzF6ioxPLnJVEQa1Elbs7aqBUSF16xleBS5AdkVfASS49-fQIC8Rm` |
+| `AUTH0_ISSUER`        | Yes      | Domain of the Auth0 application                                                                                                     | -             | `https://example.auth0.com`                                        |
+| `ACCESS_CODE`         | Yes      | Add a password to access this service. You can set a long random password to "disable" accessed by the code                         | -             | `awCT74` or `e3@09!` or `code1,code2,code3`                        |
+
+> \[!NOTE]
+>
+> After successful deployment, users will be able to authenticate and use LobeChat using the users configured in Auth0.
+
+## Advanced - Connecting to an Existing Single Sign-On Service
+
+If your enterprise or organization already has an existing unified identity verification infrastructure, you can connect to an existing single sign-on service in **_Applications -> SSO Integrations_**.
+
+Auth0 supports single sign-on services such as Azure Active Directory, Slack, Google Workspace, Office 365, and Zoom. For a detailed list of supported services, refer to [this page][auth0-sso-integrations].
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/32650f4f-d0b0-4843-b26d-d35bad11d8a3)
+
+## Advanced - Configuring Social Login
+
+If your enterprise or organization needs to support external personnel login, you can configure social login services in **_Authentication -> Social_**.
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/7b6f6a6c-2686-49d8-9dbd-0516053f1efa)
+
+> \[!NOTE]
+>
+> Configuring social login services will allow anyone to authenticate by default, which may lead to abuse of LobeChat by external personnel. If you need to restrict login personnel, be sure to configure a blocking policy.
+>
+> After enabling social login options, refer to [this article][auth0-login-actions-manual] to create an Action to set the deny/allow list.
+
+[auth0-client-page]: https://manage.auth0.com/dashboard
+[auth0-login-actions-manual]: https://auth0.com/blog/permit-or-deny-login-requests-using-auth0-actions/
+[auth0-sso-integrations]: https://marketplace.auth0.com/features/sso-integrations

package/docs/Deployment/Authentication.zh-CN.md

@@ -0,0 +1,72 @@
+# 身份验证服务
+
+LobeChat 支持配置外部身份验证服务，供企业 / 组织内部使用，统一管理用户授权，目前支持 [Auth0][auth0-client-page] 本文将介绍如何配置身份验证服务。
+
+### TOC
+
+- [创建 Auth0 应用](#创建-auth0-应用)
+- [新增用户](#新增用户)
+- [配置环境变量](#配置环境变量)
+- [进阶 - 连接现有的单点登录服务](#进阶---连接现有的单点登录服务)
+- [进阶 - 配置社交登录](#进阶---配置社交登录)
+
+## 创建 Auth0 应用
+
+注册并登录 [Auth0][auth0-client-page]，点击左侧导航栏的「Applications」，切换到应用管理界面，点击右上角「Create Application」以创建应用。
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/1b405347-f4c3-4c55-82f6-47116f2210d0)
+
+填写你想向组织用户显示的应用名称，可选择任意应用类型，点击「Create」。
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/75c92f85-3ad3-4473-a9c6-e667e28d428d)
+
+创建成功后，点击相应的应用，进入应用详情页，切换到「Settings」标签页，就可以看到相应的配置信息
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/a1ed996b-95ef-4b7d-a50d-b4666eccfecb)
+
+## 新增用户
+
+点击左侧导航栏的「Users Management」，进入用户管理界面，可以为你的组织新建用户，用以登录 LobeChat
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/3b8127ab-dc4f-4ff9-a4cb-dec3ef0295cc)
+
+## 配置环境变量
+
+在部署 LobeChat 时，你需要配置以下环境变量：
+
+| 环境变量              | 类型 | 描述                                                                                    | 默认值 | 示例                                                               |
+| --------------------- | ---- | --------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------ |
+| `ENABLE_OAUTH_SSO`    | 必选 | 为 LobeChat 启用单点登录 (SSO)。设置为 `1` 以启用单点登录。                             | -      | `1`                                                                |
+| `NEXTAUTH_SECRET`     | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥： `openssl rand -base64 32` | -      | `Tfhi2t2pelSMEA8eaV61KaqPNEndFFdMIxDaJnS1CUI=`                     |
+| `AUTH0_CLIENT_ID`     | 必选 | Auth0 应用程序的 Client ID                                                              | -      | `evCnOJP1UX8FMnXR9Xkj5t0NyFn5p70P`                                 |
+| `AUTH0_CLIENT_SECRET` | 必选 | Auth0 应用程序的 Client Secret                                                          | -      | `wnX7UbZg85ZUzF6ioxPLnJVEQa1Elbs7aqBUSF16xleBS5AdkVfASS49-fQIC8Rm` |
+| `AUTH0_ISSUER`        | 必选 | Auth0 应用程序的 Domain                                                                 | -      | `https://example.auth0.com`                                        |
+| `ACCESS_CODE`         | 必选 | 添加访问此服务的密码，你可以设置一个足够长的随机密码以 “禁用” 访问码授权                | -      | `awCT74` 或 `e3@09!` or `code1,code2,code3`                        |
+
+> \[!NOTE]
+>
+> 部署成功后，用户将可以使用 Auth0 中配置的用户通过身份认证并使用 LobeChat。
+
+## 进阶 - 连接现有的单点登录服务
+
+如果你的企业或组织已有现有的统一身份认证设施，可在 Applications -> SSO Integrations 中，连接现有的单点登录服务。
+
+Auth0 支持 Azure Active Directory, Slack, Google Workspace, Office 365, Zoom 等单点登录服务，详细支持列表可参考 [这里][auth0-sso-integrations]
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/32650f4f-d0b0-4843-b26d-d35bad11d8a3)
+
+## 进阶 - 配置社交登录
+
+如果你的企业或组织需要支持外部人员登录，可以在 Authentication -> Social 中，配置社交登录服务。
+
+![](https://github.com/CloudPassenger/lobe-chat/assets/30863298/7b6f6a6c-2686-49d8-9dbd-0516053f1efa)
+
+> \[!NOTE]
+>
+> 配置社交登录服务默认会允许所有人通过认证，这可能会导致 LobeChat 被外部人员滥用。如果你需要限制登录人员，务必配置阻止策略
+>
+> 请在打开社交登录选项后，参考 [这篇文章][auth0-login-actions-manual] 创建 Action 来设置阻止 / 允许 列表
+
+[auth0-client-page]: https://manage.auth0.com/dashboard
+[auth0-login-actions-manual]: https://auth0.com/blog/permit-or-deny-login-requests-using-auth0-actions/
+[auth0-sso-integrations]: https://marketplace.auth0.com/features/sso-integrations

package/docs/Deployment/Environment-Variable.md

@@ -6,6 +6,10 @@ LobeChat provides additional configuration options during deployment, which can
 
 - [General Variables](#general-variables)
   - [`ACCESS_CODE`](#access_code)
+  - [`ENABLE_OAUTH_SSO`](#enable_oauth_sso)
+- [Authentication Service Providers](#authentication-service-providers)
+  - [Common Settings](#common-settings)
+  - [Auth0](#auth0)
 - [Model Service Providers](#model-service-providers)
   - [OpenAI](#openai)
   - [Azure OpenAI](#azure-openai)
@@ -21,6 +25,7 @@ LobeChat provides additional configuration options during deployment, which can
 - [Data Analytics](#data-analytics)
   - [Vercel Analytics](#vercel-analytics)
   - [Posthog Analytics](#posthog-analytics)
+  - [Umami Analytics](#umami-analytics)
 
 ## General Variables
 
@@ -31,6 +36,51 @@ LobeChat provides additional configuration options during deployment, which can
 - Default: `-`
 - Example: `awCTe)re_r74` or `rtrt_ewee3@09!` or `code1,code2,code3`
 
+### `ENABLE_OAUTH_SSO`
+
+- Type: Optional
+- Description: Enable OAuth single sign-on (SSO) for LobeChat. Set to `1` to enable OAuth SSO. See [Authentication Service Providers](#authentication-service-providers) for more details.
+- Default: `-`
+- Example: `1` or `0`
+
+## Authentication Service Providers
+
+### Common Settings
+
+#### `NEXTAUTH_SECRET`
+
+- Type: Required
+- Description: The secret key used to encrypt the Auth.js session token. You can generate a secret key using the following command: `openssl rand -base64 32`
+- Default: `-`
+- Example: `Tfhi2t2pelSMEA8eaV61KaqPNEndFFdMIxDaJnS1CUI=`
+
+### Auth0
+
+> !\[NOTE]
+>
+> We only support the Auth0 authentication service provider at the moment. If you need to use other authentication service providers, you can submit a feature request or pull request.
+
+#### `AUTH0_CLIENT_ID`
+
+- Type: Required
+- Description: The Client ID of the Auth0 application, you can go [here][auth0-client-page] and navigate to the application settings to view
+- Default: `-`
+- Example: `evCnOJP1UX8FMnXR9Xkj5t0NyFn5p70P`
+
+#### `AUTH0_CLIENT_SECRET`
+
+- Type: Required
+- Description: The Client Secret of the Auth0 application
+- Default: `-`
+- Example: `wnX7UbZg85ZUzF6ioxPLnJVEQa1Elbs7aqBUSF16xleBS5AdkVfASS49-fQIC8Rm`
+
+#### `AUTH0_ISSUER`
+
+- Type: Required
+- Description: The issuer/domain of the Auth0 application
+- Default: `-`
+- Example: `https://example.auth0.com`
+
 ## Model Service Providers
 
 ### OpenAI
@@ -237,7 +287,32 @@ The above example adds `search-engine` plugin settings, and sets the `SERPAPI_AP
 - Default: -
 - Example: `1`
 
+### Umami Analytics
+
+#### `NEXT_PUBLIC_ANALYTICS_UMAMI`
+
+- Type: Optional
+- Description: Environment variable to enable [Umami Analytics][umami-analytics-url]. Set to `1` to enable Umami Analytics.
+- Default: `-`
+- Example: `1`
+
+#### `NEXT_PUBLIC_UMAMI_SCRIPT_URL`
+
+- Type: Optional
+- Description: Set the url of the umami script. Default is the script address of Umami Cloud.
+- Default: `https://analytics.umami.is/script.js`
+- Example: `https://umami.your-site.com/script.js`
+
+#### `NEXT_PUBLIC_UMAMI_WEBSITE_ID`
+
+- Type: Required
+- Description: The website ID in umami
+- Default: `-`
+- Example: `E738D82A-EE9E-4806-A81F-0CA3CAE57F65`
+
+[auth0-client-page]: https://manage.auth0.com/dashboard
 [azure-api-verion-url]: https://docs.microsoft.com/zh-cn/azure/developer/javascript/api-reference/es-modules/azure-sdk/ai-translation/translationconfiguration?view=azure-node-latest#api-version
 [openai-api-page]: https://platform.openai.com/account/api-keys
 [posthog-analytics-url]: https://posthog.com
+[umami-analytics-url]: https://umami.is
 [vercel-analytics-url]: https://vercel.com/analytics

package/docs/Deployment/Environment-Variable.zh-CN.md

@@ -6,6 +6,10 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 
 - [通用变量](#通用变量)
   - [`ACCESS_CODE`](#access_code)
+  - [`ENABLE_OAUTH_SSO`](#enable_oauth_sso)
+- [身份验证服务](#身份验证服务)
+  - [通用设置](#通用设置)
+  - [Auth0](#auth0)
 - [模型服务商](#模型服务商)
   - [OpenAI](#openai)
   - [Azure OpenAI](#azure-openai)
@@ -21,6 +25,7 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 - [数据统计](#数据统计)
   - [Vercel Analytics](#vercel-analytics)
   - [Posthog Analytics](#posthog-analytics)
+  - [Umami Analytics](#umami-analytics)
 
 ## 通用变量
 
@@ -31,6 +36,51 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 - 默认值：-
 - 示例：`awCTe)re_r74` or `rtrt_ewee3@09!`
 
+### `ENABLE_OAUTH_SSO`
+
+- 类型：可选
+- 描述：为 LobeChat 启用单点登录 (SSO)。设置为 `1` 以启用单点登录。有关详细信息，请参阅[身份验证服务](#身份验证服务)。
+- 默认值: `-`
+- 示例: `1` 或 `0`
+
+## 身份验证服务
+
+### 通用设置
+
+#### `NEXTAUTH_SECRET`
+
+- 类型：必须
+- 描述：用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥： `openssl rand -base64 32`.
+- 默认值: `-`
+- 示例: `Tfhi2t2pelSMEA8eaV61KaqPNEndFFdMIxDaJnS1CUI=`
+
+### Auth0
+
+> !\[NOTE] 注意事项：
+>
+> 目前我们只支持 Auth0 身份验证服务提供商。如果您需要使用其他身份验证服务提供商，可以提交功能请求或 Pull Request。
+
+#### `AUTH0_CLIENT_ID`
+
+- 类型：必须
+- 描述: Auth0 应用程序的 Client ID，您可以访问[这里][auth0-client-page]并导航至应用程序设置来查看
+- 默认值: `-`
+- 示例: `evCnOJP1UX8FMnXR9Xkj5t0NyFn5p70P`
+
+#### `AUTH0_CLIENT_SECRET`
+
+- 类型：必须
+- 描述: Auth0 应用程序的 Client Secret
+- 默认值: `-`
+- 示例: `wnX7UbZg85ZUzF6ioxPLnJVEQa1Elbs7aqBUSF16xleBS5AdkVfASS49-fQIC8Rm`
+
+#### `AUTH0_ISSUER`
+
+- 类型：必须
+- 描述: Auth0 应用程序的签发人 / 域
+- 默认值: `-`
+- 示例: `https://example.auth0.com`
+
 ## 模型服务商
 
 ### OpenAI
@@ -233,6 +283,32 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 - 默认值： `-`
 - 示例：`1`
 
+### Umami Analytics
+
+#### `NEXT_PUBLIC_ANALYTICS_UMAMI`
+
+- 类型：可选
+- 描述：用于开启 [Umami Analytics][umami-analytics-url] 的环境变量，设为 `1`
+  时开启 Umami Analytics
+- 默认值： `-`
+- 示例：`1`
+
+#### `NEXT_PUBLIC_UMAMI_SCRIPT_URL`
+
+- 类型：可选
+- 描述：Umami 脚本的网址，默认为 Umami Cloud 提供的脚本网址
+- 默认值：`https://analytics.umami.is/script.js`
+- 示例：`https://umami.your-site.com/script.js`
+
+#### `NEXT_PUBLIC_UMAMI_WEBSITE_ID`
+
+- 类型：必选
+- 描述：你的 Umami 的 Website ID
+- 默认值：`-`
+- 示例：`E738D82A-EE9E-4806-A81F-0CA3CAE57F65`
+
+[auth0-client-page]: https://manage.auth0.com/dashboard
 [azure-api-verion-url]: https://docs.microsoft.com/zh-cn/azure/developer/javascript/api-reference/es-modules/azure-sdk/ai-translation/translationconfiguration?view=azure-node-latest#api-version
 [openai-api-page]: https://platform.openai.com/account/api-keys
 [posthog-analytics-url]: https://posthog.com
+[umami-analytics-url]: https://umami.is

package/docs/Development/Authentication.md

@@ -0,0 +1,85 @@
+# New Authentication Provider Guide
+
+LobeChat uses [Auth.js v5](https://authjs.dev/) as the external authentication service. Auth.js is an open-source authentication library that provides a simple way to implement authentication and authorization features. This document will introduce how to use Auth.js to implement a new authentication provider.
+
+### TOC
+
+- [Add New Authentication Provider](#add-new-authentication-provider)
+  - [Pre-requisites: Check the Official Provider List](#pre-requisites-check-the-official-provider-list)
+  - [Step 1: Add Authenticator Core Code](#step-1-add-authenticator-core-code)
+  - [Step 2: Update Server Configuration Code](#step-2-update-server-configuration-code)
+  - [Step 3: Change Frontend Pages](#step-3-change-frontend-pages)
+  - [Step 4: Configure the Environment Variables](#step-4-configure-the-environment-variables)
+
+## Add New Authentication Provider
+
+To add a new authentication provider in LobeChat (for example, adding Okta), you need to follow the steps below:
+
+### Pre-requisites: Check the Official Provider List
+
+First, you need to check the [Auth.js Provider List](https://authjs.dev/reference/core/providers) to see if your provider is already supported. If yes, you can directly use the SDK provided by Auth.js to implement the authentication feature.
+
+Next, I will use [Okta](https://authjs.dev/reference/core/providers/okta) as an example to introduce how to add a new authentication provider.
+
+### Step 1: Add Authenticator Core Code
+
+Open the `src/app/api/oauth/next-auth.ts` file and import `next-auth/providers/okta`.
+
+```ts
+import { NextAuth } from 'next-auth';
+import Auth0 from 'next-auth/providers/auth0';
+import Okta from 'next-auth/providers/okta';
+
+// Import Okta provider
+```
+
+Add the predefined server configuration.
+
+```ts
+// Import server configuration
+const { OKTA_CLIENT_ID, OKTA_CLIENT_SECRET, OKTA_ISSUER } = getServerConfig();
+
+const nextAuth = NextAuth({
+  providers: [
+    // ... Other providers
+
+    Okta({
+      clientId: OKTA_CLIENT_ID,
+      clientSecret: OKTA_CLIENT_SECRET,
+      issuer: OKTA_ISSUER,
+    }),
+  ],
+});
+```
+
+### Step 2: Update Server Configuration Code
+
+Open the `src/config/server/app.ts` file and add Okta-related environment variables in the `getAppConfig` function.
+
+```ts
+export const getAppConfig = () => {
+  // ... Other code
+
+  return {
+    // ... Other environment variables
+
+    OKTA_CLIENT_ID: process.env.OKTA_CLIENT_ID || '',
+    OKTA_CLIENT_SECRET: process.env.OKTA_CLIENT_SECRET || '',
+    OKTA_ISSUER: process.env.OKTA_ISSUER || '',
+  };
+};
+```
+
+### Step 3: Change Frontend Pages
+
+Modify the `signIn` function parameter in `src/Features/Conversation/Error/OAuthForm.tsx` and \`src/app/settings/common/Common.tsx
+
+The default is `auth0`, which you can change to `okta` to switch to the Okta provider, or remove this parameter to support all added authentication services
+
+This value is the id of the Auth.js provider, and you can read the source code of the corresponding `next-auth/providers` module to read the default ID.
+
+### Step 4: Configure the Environment Variables
+
+Add `OKTA_CLIENT_ID`、`OKTA_CLIENT_SECRET`、`OKTA_ISSUER` environment variables when you deploy.
+
+Now, you can use Okta as your provider to implement the authentication feature in LobeChat.

package/docs/Development/Authentication.zh-CN.md

@@ -0,0 +1,83 @@
+# 新身份验证方式开发指南
+
+LobeChat 使用 [Auth.js v5](https://authjs.dev/) 作为外部身份验证服务。Auth.js 是一个开源的身份验证库，它提供了一种简单的方式来实现身份验证和授权功能。本文档将介绍如何使用 Auth.js 来实现新的身份验证方式。
+
+### TOC
+
+- [添加新的身份验证提供者](#添加新的身份验证提供者)
+  - [准备工作：查阅官方的提供者列表](#准备工作查阅官方的提供者列表)
+  - [步骤 1: 新增关键代码](#步骤-1-新增关键代码)
+  - [步骤 2: 更新服务端配置代码](#步骤-2-更新服务端配置代码)
+  - [步骤 3: 修改前端页面](#步骤-3-修改前端页面)
+  - [步骤 4: 配置环境变量](#步骤-4-配置环境变量)
+
+## 添加新的身份验证提供者
+
+为了在 LobeChat 中添加新的身份验证提供者（例如添加 Okta)，你需要完成以下步骤：
+
+### 准备工作：查阅官方的提供者列表
+
+首先，你需要查阅 [Auth.js 提供者列表](https://authjs.dev/reference/core/providers) 来了解是否你的提供者已经被支持。如果你的提供者已经被支持，你可以直接使用 Auth.js 提供的 SDK 来实现身份验证功能。
+
+接下来我会以 [Okta](https://authjs.dev/reference/core/providers/okta) 为例来介绍如何添加新的身份验证提供者
+
+### 步骤 1: 新增关键代码
+
+打开 `src/app/api/oauth/next-auth.ts` 文件，引入 `next-auth/providers/okta`
+
+```ts
+import { NextAuth } from 'next-auth';
+import Auth0 from 'next-auth/providers/auth0';
+import Okta from 'next-auth/providers/okta';
+
+// 引入 Okta 提供者
+```
+
+新增预定义的服务端配置
+
+```ts
+// 导入服务器配置
+const { OKTA_CLIENT_ID, OKTA_CLIENT_SECRET, OKTA_ISSUER } = getServerConfig();
+
+const nextAuth = NextAuth({
+  providers: [
+    // ... 其他提供者
+
+    Okta({
+      clientId: OKTA_CLIENT_ID,
+      clientSecret: OKTA_CLIENT_SECRET,
+      issuer: OKTA_ISSUER,
+    }),
+  ],
+});
+```
+
+### 步骤 2: 更新服务端配置代码
+
+打开 `src/config/server/app.ts` 文件，在 `getAppConfig` 函数中新增 Okta 相关的环境变量
+
+```ts
+export const getAppConfig = () => {
+  // ... 其他代码
+
+  return {
+    // ... 其他环境变量
+
+    OKTA_CLIENT_ID: process.env.OKTA_CLIENT_ID || '',
+    OKTA_CLIENT_SECRET: process.env.OKTA_CLIENT_SECRET || '',
+    OKTA_ISSUER: process.env.OKTA_ISSUER || '',
+  };
+};
+```
+
+### 步骤 3: 修改前端页面
+
+修改在 `src/features/Conversation/Error/OAuthForm.tsx` 及 `src/app/settings/common/Common.tsx` 中的 `signIn` 函数参数
+
+默认为 `auth0`，你可以将其修改为 `okta` 以切换到 Okta 提供者，或删除该参数以支持所有已添加的身份验证服务
+
+该值为 Auth.js 提供者 的 id，你可以阅读相应的 `next-auth/providers` 模块源码以读取默认 ID
+
+### 步骤 4: 配置环境变量
+
+在部署时新增 Okta 相关的环境变量 `OKTA_CLIENT_ID`、`OKTA_CLIENT_SECRET`、`OKTA_ISSUER`，并填入相应的值，即可使用