@lobehub/chat 1.77.18 → 1.79.0

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

@@ -0,0 +1,116 @@
+---
+title: 在 LobeChat 中配置 Keycloak 身份验证服务
+description: 学习如何在 LobeChat 中配置 Keycloak 身份验证服务，包括部署、创建、设置权限和环境变量。
+tags:
+  - Keycloak 身份验证
+  - 环境变量配置
+  - 单点登录
+  - LobeChat
+---
+
+# 配置 Keycloak 身份验证服务
+
+[Keycloak](https://www.keycloak.org/) 是一个开源的身份和访问管理解决方案，提供单点登录、身份代理和社交登录等功能，适用于现代应用和服务。
+
+<Callout type={'tip'}>
+  若你想要私有部署 Keycloak，我们建议你将之与 LobeChat 一同使用 Docker Compose 部署，这样可以更方便地管理服务。
+</Callout>
+
+## Keycloak 配置流程
+
+若你使用局域网 IP 部署，下文假设：
+
+- 你的 LobeChat 数据库版本 IP / 端口为 `http://LOBECHAT_IP:3210`。
+- 你私有部署 Keycloak，其域名为 `http://KEYCLOAK_IP:8080`。
+
+若你使用公网部署，下文假设：
+
+- 你的 LobeChat 数据库版本域名为 `https://lobe.example.com`。
+- 你私有部署 Keycloak，其域名为 `https://lobe-auth-api.example.com`。
+
+<Steps>
+  ### 创建 Keycloak 领域和客户端
+
+  访问你私有部署的 Keycloak 管理控制台（默认为 `http://localhost:8080/admin`），使用管理员账号登录。
+
+  1. 创建新领域（Realm）
+     - 点击左上角的下拉菜单，选择 "Create Realm"
+     - 输入名称，例如 "LobeChat"，然后点击 "Create"
+
+  2. 创建客户端（Client）
+     - 在左侧菜单中选择 "Clients"，然后点击 "Create client"
+     - 填写以下信息：
+       - Client ID: `lobechat`
+       - Client type: `OpenID Connect`
+       - 点击 "Next"
+     - 在 "Capability config" 页面：
+       - 启用 "Client authentication"
+       - 启用 "Standard flow"
+       - 点击 "Next"
+     - 在 "Login settings" 页面：
+       - Valid redirect URIs:
+         - 本地开发环境：`http://localhost:3210/api/auth/callback/keycloak`
+         - 局域网 IP 部署：`http://LOBECHAT_IP:3210/api/auth/callback/keycloak`
+         - 公网环境：`https://lobe.example.com/api/auth/callback/keycloak`
+       - Web origins: 添加你的 LobeChat 域名或 IP
+       - 点击 "Save"
+
+  3. 获取客户端密钥
+     - 在客户端详情页，切换到 "Credentials" 选项卡
+     - 复制 "Client secret" 的值，后续需要用到
+
+  ### 配置用户和角色（可选）
+
+  1. 创建用户
+     - 在左侧菜单中选择 "Users"，然后点击 "Add user"
+     - 填写用户信息，点击 "Create"
+     - 在用户详情页，切换到 "Credentials" 选项卡
+     - 设置密码，并根据需要禁用 "Temporary" 选项
+     - 点击 "Set Password" 保存
+
+  2. 创建角色和权限
+     - 在左侧菜单中选择 "Realm roles"
+     - 点击 "Create role"
+     - 创建所需角色，如 "admin"、"user" 等
+     - 为用户分配角色：在用户详情页，切换到 "Role mapping" 选项卡，分配相应角色
+
+  ### 关闭注册（可选）
+
+  为了保证你的应用安全，建议控制 Keycloak 的注册功能。
+
+  1. 在左侧菜单中选择 "Realm settings"
+  2. 切换到 "Login" 选项卡
+  3. 在 "User registration" 部分，禁用 "User registration" 选项
+  4. 点击 "Save" 保存设置
+
+  <Callout type={'warning'}>
+    如果不关闭注册功能，任何人都可能注册并登录你的应用，请根据你的安全需求进行配置。
+  </Callout>
+
+  ### 配置环境变量
+
+  将获取到的客户端 ID 和客户端密钥，设为 LobeChat 环境变量中的 `AUTH_KEYCLOAK_ID` 和 `AUTH_KEYCLOAK_SECRET`。
+
+  配置 LobeChat 环境变量中 `AUTH_KEYCLOAK_ISSUER` 为：
+
+  - `http://localhost:8080/realms/LobeChat`，若你是本地开发环境
+  - `http://KEYCLOAK_IP:8080/realms/LobeChat`，若你是局域网私有部署的 Keycloak
+  - `https://lobe-auth-api.example.com/realms/LobeChat`，若你是公网环境部署的 Keycloak
+
+  在部署 LobeChat 时，你需要配置以下环境变量：
+
+  | 环境变量                      | 类型 | 描述                                                                                               |
+  | ------------------------- | -- | ------------------------------------------------------------------------------------------------ |
+  | `NEXT_AUTH_SECRET`        | 必选 | 用于加密 Auth.js 会话令牌的密钥。您可以使用以下命令生成秘钥： `openssl rand -base64 32`                                    |
+  | `NEXT_AUTH_SSO_PROVIDERS` | 必选 | 选择 LoboChat 的单点登录提供商。使用 Keycloak 请填写 `keycloak`。                                                 |
+  | `AUTH_KEYCLOAK_ID`        | 必选 | Keycloak 客户端 ID                                                                                  |
+  | `AUTH_KEYCLOAK_SECRET`    | 必选 | Keycloak 客户端密钥                                                                                   |
+  | `AUTH_KEYCLOAK_ISSUER`    | 必选 | Keycloak 提供程序的 OpenID Connect 颁发者 URL，格式为 `{keycloak_url}/realms/{realm_name}`                   |
+  | `NEXTAUTH_URL`            | 必选 | 该 URL 用于指定 Auth.js 在执行 OAuth 验证时的回调地址，当默认生成的重定向地址发生不正确时才需要设置。`https://lobe.example.com/api/auth` |
+
+  <Callout type={'tip'}>
+    前往 [📘 环境变量](/zh/docs/self-hosting/environment-variables/auth#keycloak) 可查阅相关变量详情。
+  </Callout>
+</Steps>
+
+<Callout type={'info'}>部署成功后，用户将可以通过 Keycloak 身份认证并使用 LobeChat。</Callout>

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

@@ -52,6 +52,8 @@ Currently supported identity verification services include:
   <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'} />
 </Cards>
 
 Click on the links to view the corresponding platform's configuration documentation.
@@ -73,6 +75,7 @@ The order corresponds to the display order of the SSO providers.
 | Logto                 | `logto`                 |
 | Microsoft Entra ID    | `microsoft-entra-id`    |
 | ZITADEL               | `zitadel`               |
+| Keycloak              | `keycloak`              |
 
 ## Other SSO Providers
 

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

@@ -49,6 +49,8 @@ LobeChat 与 Clerk 做了深度集成，能够为用户提供一个更加安全
   <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'} />
 </Cards>
 
 点击即可查看对应平台的配置文档。
@@ -70,6 +72,7 @@ LobeChat 与 Clerk 做了深度集成，能够为用户提供一个更加安全
 | Logto                 | `logto`                 |
 | Microsoft Entra ID    | `microsoft-entra-id`    |
 | ZITADEL               | `zitadel`               |
+| Keycloak              | `keycloak`              |
 
 ## 其他 SSO 提供商
 

package/docs/wiki/HOME.md

@@ -0,0 +1,11 @@
+<div align="center">
+
+<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-logo/1.0.0/files/assets/logo-3d.webp">
+<img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
+<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/robot.webp">
+
+</div>
+
+![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
+
+We've moved the contributing wiki to [this page](https://lobehub.com/zh/docs/development/start).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "1.77.18",
+  "version": "1.79.0",
   "description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",
   "keywords": [
     "framework",
@@ -42,7 +42,7 @@
     "db:push": "drizzle-kit push",
     "db:push-test": "NODE_ENV=test drizzle-kit push",
     "db:studio": "drizzle-kit studio",
-    "db:visualize": "dbdocs build docs/developer/database-schema.dbml --project lobe-chat",
+    "db:visualize": "dbdocs build docs/development/database-schema.dbml --project lobe-chat",
     "db:z-pull": "drizzle-kit introspect",
     "dev": "next dev --turbopack -p 3010",
     "docs:i18n": "lobe-i18n md && npm run lint:md && npm run lint:mdx",

package/scripts/dbmlWorkflow/index.ts

@@ -3,7 +3,7 @@ import { join } from 'node:path';
 
 import * as schema from '../../src/database/schemas';
 
-const out = join(__dirname,'../../docs/developer/database-schema.dbml');
+const out = join(__dirname, '../../docs/development/database-schema.dbml');
 const relational = true;
 
 pgGenerate({ out, relational, schema });

package/src/libs/next-auth/sso-providers/index.ts

@@ -6,6 +6,7 @@ import Casdoor from './casdoor';
 import CloudflareZeroTrust from './cloudflare-zero-trust';
 import GenericOIDC from './generic-oidc';
 import Github from './github';
+import Keycloak from './keycloak';
 import Logto from './logto';
 import MicrosoftEntraID from './microsoft-entra-id';
 import WeChat from './wechat';
@@ -24,4 +25,5 @@ export const ssoProviders = [
   Casdoor,
   MicrosoftEntraID,
   WeChat,
+  Keycloak,
 ];

package/src/libs/next-auth/sso-providers/keycloak.ts

@@ -0,0 +1,25 @@
+import Keycloak from 'next-auth/providers/keycloak';
+
+import { CommonProviderConfig } from './sso.config';
+
+const provider = {
+  id: 'keycloak',
+  provider: Keycloak({
+    ...CommonProviderConfig,
+    // Specify auth scope, at least include 'openid email'
+    authorization: { params: { scope: 'openid email profile' } },
+    clientId: process.env.AUTH_KEYCLOAK_ID,
+    clientSecret: process.env.AUTH_KEYCLOAK_SECRET,
+    issuer: process.env.AUTH_KEYCLOAK_ISSUER,
+    profile(profile) {
+      return {
+        email: profile.email,
+        id: profile.sub,
+        name: profile.name,
+        providerAccountId: profile.sub,
+      };
+    },
+  }),
+};
+
+export default provider;

package/src/locales/default/tool.ts

@@ -23,16 +23,16 @@ export default {
       placeholder: '搜索类别',
       title: '搜索类别：',
       value: {
-        'files': '文件',
-        'general': '通用',
-        'images': '图片',
-        'it': '信息技术',
-        'map': '地图',
-        'music': '音乐',
-        'news': '新闻',
-        'science': '科学',
-        'social_media': '社交媒体',
-        'videos': '视频',
+        files: '文件',
+        general: '通用',
+        images: '图片',
+        it: '信息技术',
+        map: '地图',
+        music: '音乐',
+        news: '新闻',
+        science: '科学',
+        social_media: '社交媒体',
+        videos: '视频',
       },
     },
     searchEngine: {

package/src/server/modules/SearXNG.ts

@@ -14,10 +14,13 @@ export class SearXNGClient {
     try {
       const { time_range, ...otherParams } = optionalParams;
 
-      const processedParams = Object.entries(otherParams).reduce<Record<string, any>>((acc, [key, value]) => {
-        acc[key] = Array.isArray(value) ? value.join(',') : value;
-        return acc;
-      }, {});
+      const processedParams = Object.entries(otherParams).reduce<Record<string, any>>(
+        (acc, [key, value]) => {
+          acc[key] = Array.isArray(value) ? value.join(',') : value;
+          return acc;
+        },
+        {},
+      );
 
       const searchParams = qs.stringify({
         ...processedParams,

package/src/server/routers/tools/search.ts

@@ -43,11 +43,13 @@ export const searchRouter = router({
   query: searchProcedure
     .input(
       z.object({
-        optionalParams: z.object({
-          searchCategories: z.array(z.string()).optional(),
-          searchEngines: z.array(z.string()).optional(),
-          searchTimeRange: z.string().optional(),
-        }).optional(),
+        optionalParams: z
+          .object({
+            searchCategories: z.array(z.string()).optional(),
+            searchEngines: z.array(z.string()).optional(),
+            searchTimeRange: z.string().optional(),
+          })
+          .optional(),
         query: z.string(),
       }),
     )

package/src/services/search.ts

@@ -2,7 +2,7 @@ import { toolsClient } from '@/libs/trpc/client';
 
 class SearchService {
   search(query: string, optionalParams?: object) {
-    return toolsClient.search.query.query({ optionalParams, query});
+    return toolsClient.search.query.query({ optionalParams, query });
   }
 
   crawlPage(url: string) {

package/src/store/chat/slices/builtinTool/actions/searXNG.test.ts

@@ -90,8 +90,8 @@ describe('searXNG actions', () => {
         },
       ];
 
-      expect( searchService.search ).toHaveBeenCalledWith('test query', {
-        searchEngines: [ 'google' ]
+      expect(searchService.search).toHaveBeenCalledWith('test query', {
+        searchEngines: ['google'],
       });
       expect(result.current.searchLoading[messageId]).toBe(false);
       expect(result.current.internal_updateMessageContent).toHaveBeenCalledWith(
@@ -158,20 +158,20 @@ describe('searXNG actions', () => {
       });
 
       expect(searchService.search).toHaveBeenCalledTimes(3);
-      expect(searchService.search).toHaveBeenNthCalledWith(1, "test query", {
-          "searchEngines": [ "custom-engine" ],
-          "searchTimeRange": "year",
+      expect(searchService.search).toHaveBeenNthCalledWith(1, 'test query', {
+        searchEngines: ['custom-engine'],
+        searchTimeRange: 'year',
       });
-      expect(searchService.search).toHaveBeenNthCalledWith(2, "test query", {
-          "searchTimeRange": "year",
+      expect(searchService.search).toHaveBeenNthCalledWith(2, 'test query', {
+        searchTimeRange: 'year',
       });
       expect(result.current.updatePluginArguments).toHaveBeenCalledWith(messageId, {
         optionalParams: {
-          "searchTimeRange": "year",
+          searchTimeRange: 'year',
         },
         query: 'test query',
       });
-      expect(searchService.search).toHaveBeenNthCalledWith(3, "test query");
+      expect(searchService.search).toHaveBeenNthCalledWith(3, 'test query');
       expect(result.current.updatePluginArguments).toHaveBeenCalledWith(messageId, {
         optionalParams: undefined,
         query: 'test query',

package/src/store/chat/slices/builtinTool/actions/searXNG.ts

@@ -146,13 +146,17 @@ export const searchSlice: StateCreator<
       data = await searchService.search(params.query, params.optionalParams);
 
       // 如果没有搜索到结果，则执行第一次重试（移除搜索引擎限制）
-      if (data?.results.length === 0 && params.optionalParams?.searchEngines && params.optionalParams?.searchEngines?.length > 0) {
+      if (
+        data?.results.length === 0 &&
+        params.optionalParams?.searchEngines &&
+        params.optionalParams?.searchEngines?.length > 0
+      ) {
         const paramsExcludeSearchEngines = {
           ...params,
           optionalParams: {
             ...params.optionalParams,
-            searchEngines: undefined
-          }
+            searchEngines: undefined,
+          },
         };
         data = await searchService.search(params.query, paramsExcludeSearchEngines.optionalParams);
         get().updatePluginArguments(id, paramsExcludeSearchEngines);

package/src/tools/web-browsing/components/CategoryAvatar.tsx

@@ -20,7 +20,7 @@ export const CategoryAvatar = memo<CategoryAvatarProps>(({ category }) => {
         backgroundColor: 'transparent',
         color: theme.colorTextSecondary,
         height: 16,
-        width: 16
+        width: 16,
       }}
     />
   );

package/src/tools/web-browsing/components/SearchBar.tsx

@@ -191,9 +191,7 @@ const SearchBar = memo<SearchBarProps>(
         )}
 
         <Flexbox align={'center'} gap={16} horizontal wrap={'wrap'}>
-          <Typography.Text type={'secondary'}>
-            {t('search.searchTimeRange.title')}
-          </Typography.Text>
+          <Typography.Text type={'secondary'}>{t('search.searchTimeRange.title')}</Typography.Text>
           <Radio.Group
             onChange={(e) => setTimeRange(e.target.value)}
             optionType="button"

package/src/tools/web-browsing/const.ts

@@ -1,4 +1,4 @@
-import { 
+import {
   CodeIcon,
   FileIcon,
   FlaskConicalIcon,
@@ -12,16 +12,16 @@ import {
 } from 'lucide-react';
 
 export const CATEGORY_ICON_MAP: Record<string, any> = {
-   'files': FileIcon,
-   'general': SearchIcon,
-   'images': ImageIcon,
-   'it': CodeIcon,
-   'map': MapIcon,
-   'music': MusicIcon,
-   'news': NewspaperIcon,
-   'science': FlaskConicalIcon,
-   'social_media': Share2Icon,
-   'videos': VideoIcon,
+  files: FileIcon,
+  general: SearchIcon,
+  images: ImageIcon,
+  it: CodeIcon,
+  map: MapIcon,
+  music: MusicIcon,
+  news: NewspaperIcon,
+  science: FlaskConicalIcon,
+  social_media: Share2Icon,
+  videos: VideoIcon,
 };
 
 export const ENGINE_ICON_MAP: Record<string, string> = {

package/src/tools/web-browsing/index.ts

@@ -19,7 +19,7 @@ export const WebBrowsingManifest: BuiltinToolManifest = {
       parameters: {
         properties: {
           optionalParams: {
-            description: "The optional parameters for search query",
+            description: 'The optional parameters for search query',
             properties: {
               searchCategories: {
                 description: 'The search categories you can set:',
@@ -68,7 +68,7 @@ export const WebBrowsingManifest: BuiltinToolManifest = {
                 type: 'array',
               },
               searchTimeRange: {
-                description: "The time range you can set:",
+                description: 'The time range you can set:',
                 enum: ['anytime', 'day', 'week', 'month', 'year'],
                 type: 'string',
               },

package/src/types/tool/search.ts

@@ -3,7 +3,7 @@ export interface SearchQuery {
     searchCategories?: string[];
     searchEngines?: string[];
     searchTimeRange?: string;
-  }
+  };
   query: string;
 }
 

package/contributing/Home.md

@@ -1,87 +0,0 @@
-<div align="center">
-
-<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-logo/1.0.0/files/assets/logo-3d.webp">
-<img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
-<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/robot.webp">
-
-<h1>Lobe Chat Contributing Wiki</h1>
-
-LobeChat is an open-source, extensible ([Function Calling][fc-url]), high-performance chatbot framework. <br/> It supports one-click free deployment of your private ChatGPT/LLM web application.
-
-[Usage Documents](https://lobehub.com/docs) | [使用指南](https://lobehub.com/docs)
-
-</div>
-
-![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
-
-<!-- DOCS LIST -->
-
-### 🤯 Basic
-
-- [Architecture Design](https://github.com/lobehub/lobe-chat/wiki/Architecture) | [架构设计](https://github.com/lobehub/lobe-chat/wiki/Architecture.zh-CN)
-- [Development Environment Setup Guide](https://github.com/lobehub/lobe-chat/wiki/Setup-Development) | [配置开发环境指南](https://github.com/lobehub/lobe-chat/wiki/Setup-Development.zh-CN)
-- [Project Directory Structure](https://github.com/lobehub/lobe-chat/wiki/Folder-Structure) | [项目目录架构](https://github.com/lobehub/lobe-chat/wiki/Folder-Structure.zh-CN)
-- [Technical Development Getting Started Guide](https://github.com/lobehub/lobe-chat/wiki/Intro) | [技术开发上手指南](https://github.com/lobehub/lobe-chat/wiki/Intro.zh-CN)
-- [Code Style and Contribution Guidelines](https://github.com/lobehub/lobe-chat/wiki/Contributing-Guidelines) | [代码风格与贡献指南](https://github.com/lobehub/lobe-chat/wiki/Contributing-Guidelines.zh-CN)
-- [How to Develop a New Feature](https://github.com/lobehub/lobe-chat/wiki/Feature-Development-Frontend) | [如何开发一个新功能：前端实现](https://github.com/lobehub/lobe-chat/wiki/Feature-Development-Frontend.zh-CN)
-- [Complete Guide to LobeChat Feature Development](https://github.com/lobehub/lobe-chat/wiki/Feature-Development) | [LobeChat 功能开发完全指南](https://github.com/lobehub/lobe-chat/wiki/Feature-Development.zh-CN)
-- [Conversation API Implementation Logic](https://github.com/lobehub/lobe-chat/wiki/Chat-API) | [会话 API 实现逻辑](https://github.com/lobehub/lobe-chat/wiki/Chat-API.zh-CN)
-- [New Authentication Provider Guide](https://github.com/lobehub/lobe-chat/wiki/Add-New-Authentication-Providers) | [新身份验证方式开发指南](https://github.com/lobehub/lobe-chat/wiki/Add-New-Authentication-Providers.zh-CN)
-- [Testing Guide](https://github.com/lobehub/lobe-chat/wiki/Test) | [测试指南](https://github.com/lobehub/lobe-chat/wiki/Test.zh-CN)
-- [Resources and References](https://github.com/lobehub/lobe-chat/wiki/Resources) | [资源与参考](https://github.com/lobehub/lobe-chat/wiki/Resources.zh-CN)
-
-<br/>
-
-### 🌎 Internationalization
-
-- [Internationalization Implementation Guide](https://github.com/lobehub/lobe-chat/wiki/Internationalization-Implementation) | [国际化实现指南](https://github.com/lobehub/lobe-chat/wiki/Internationalization-Implementation.zh-CN)
-- [New Locale Guide](https://github.com/lobehub/lobe-chat/wiki/Add-New-Locale) | [新语种添加指南](https://github.com/lobehub/lobe-chat/wiki/Add-New-Locale.zh-CN)
-
-<br/>
-
-### ⌨️ State Management
-
-- [Best Practices for State Management](https://github.com/lobehub/lobe-chat/wiki/State-Management-Intro) | [状态管理最佳实践](https://github.com/lobehub/lobe-chat/wiki/State-Management-Intro.zh-CN)
-- [Data Store Selector](https://github.com/lobehub/lobe-chat/wiki/State-Management-Selectors) | [数据存储取数模块](https://github.com/lobehub/lobe-chat/wiki/State-Management-Selectors.zh-CN)
-
-<br/>
-
-### 🤖 Agents
-
-- [Agent Index and Submit](https://github.com/lobehub/lobe-chat-agents) | [助手索引与提交](https://github.com/lobehub/lobe-chat-agents/blob/main/README.zh-CN.md)
-
-<br/>
-
-### 🧩 Plugins
-
-- [Plugin Index and Submit](https://github.com/lobehub/lobe-chat-plugins) | [插件索引与提交](https://github.com/lobehub/lobe-chat-plugins/blob/main/README.zh-CN.md)
-- [Plugin SDK Docs](https://chat-plugin-sdk.lobehub.com) | [插件 SDK 文档](https://chat-plugin-sdk.lobehub.com)
-
-<br/>
-
-### 📊 Others
-
-- [Lighthouse Reports](https://github.com/lobehub/lobe-chat/wiki/Lighthouse) | [Lighthouse 测试报告](https://github.com/lobehub/lobe-chat/wiki/Lighthouse.zh-CN)
-
-<br/>
-
- <!-- DOCS LIST -->
-
----
-
-<details><summary><h4>📝 License</h4></summary>
-
-[![][fossa-license-shield]][fossa-license-url]
-
-</details>
-
-Copyright © 2023 [LobeHub][profile-url]. <br />
-This project is [MIT][license-url] licensed.
-
-<!-- LINK GROUP -->
-
-[fc-url]: https://sspai.com/post/81986
-[fossa-license-shield]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat.svg?type=large
-[fossa-license-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat
-[license-url]: https://github.com/lobehub/lobe-chat/blob/main/LICENSE
-[profile-url]: https://github.com/lobehub

package/contributing/Upstream-Sync.md

@@ -1,58 +0,0 @@
-# Upstream Sync
-
-English | [简体中文](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.zh-CN)
-
-## `A` Vercel / Zeabur Deployment
-
-If you have deployed your own project following the one-click deployment steps in the README, you might encounter constant prompts indicating "updates available". This is because Vercel defaults to creating a new project instead of forking this one, resulting in an inability to accurately detect updates. We suggest you redeploy using the following steps:
-
-- Remove the original repository;
-- Use the <kbd>Fork</kbd> button at the top right corner of the page to fork this project;
-- Re-select and deploy on `Vercel`.
-
-## Enabling Automatic Updates
-
-> \[!NOTE]
->
-> If you encounter an error executing Upstream Sync, manually Sync Fork once
-
-Once you have forked the project, due to Github restrictions, you will need to manually enable Workflows on the Actions page of your forked project and activate the Upstream Sync Action. Once enabled, you can set up hourly automatic updates.
-
-![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985117-4d48fe7b-0412-4667-8129-b25ebcf2c9de.png)
-![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png)
-
-## `B` Docker Deployment
-
-Upgrading the Docker deployment version is very simple, just redeploy the latest image of LobeChat. Here are the instructions to perform these steps:
-
-1. Stop and delete the currently running LobeChat container (assuming the name of the LobeChat container is `lobe-chat`):
-
-```fish
-docker stop lobe-chat
-docker rm lobe-chat
-```
-
-2. Pull the latest Docker image of LobeChat:
-
-```fish
-docker pull lobehub/lobe-chat
-```
-
-3. Redeploy the LobeChat container using the newly pulled image:
-
-```fish
-docker run -d -p 3210:3210 \
-  -e OPENAI_API_KEY=sk-xxxx \
-  -e OPENAI_PROXY_URL=https://api-proxy.com/v1 \
-  -e ACCESS_CODE=lobe66 \
-  --name lobe-chat \
-  lobehub/lobe-chat
-```
-
-Make sure you have sufficient permissions to stop and delete the container before executing these commands, and Docker has sufficient permissions to pull the new image.
-
-> \[!NOTE]
->
-> If I redeploy, will my local chat history be lost?
->
-> Don't worry, all of LobeChat's chat history is stored in your local browser. Therefore, when you redeploy LobeChat using Docker, your chat history will not be lost.