📝 docs: Update sync doc [skip ci]

2026-04-21 17:47:27 +00:00 · 2023-09-11 10:02:36 +00:00 · 2023-09-11 10:02:36 +00:00 · 60d30ed3e0
commit 60d30ed3e0
parent 4479543a61
7 changed files with 74 additions and 2 deletions
--- a/.github/workflows/contributor-help.yml
+++ b/.github/workflows/contributor-help.yml
@ -13,7 +13,7 @@ jobs:
        with:
          token: ${{ secrets.GH_TOKEN }}
          style: 'simple'
-          update-files: 'README.md, README-zh_CN.md'
+          update-files: 'README.md, README.zh-CN.md'
          update-places: '<!-- CONTRIBUTION GROUP -->/<!-- CONTRIBUTION END -->, <!-- CONTRIBUTION GROUP -->/<!-- CONTRIBUTION END -->'

      - name: Commit and push if changed
--- a/README.md
+++ b/README.md
@ -10,7 +10,7 @@

 LobeChat is a 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.

-**English** · [简体中文](./README-zh_CN.md) · [Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]
+**English** · [简体中文](./README.zh-CN.md) · [Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]

 <!-- SHIELD GROUP -->

@ -35,12 +35,21 @@ LobeChat is a open-source, extensible ([Function Calling][fc-url]), high-perform
 #### TOC

 - [👋🏻 Getting Started & Join Our Community](#-getting-started--join-our-community)
+
 - [✨ Features](#-features)
+
 - [🛳 Self Hosting](#-self-hosting)
+
+  - [Keep Updated](#keep-updated)
+
 - [📦 Ecosystem](#-ecosystem)
+
 - [🧩 Plugins](#-plugins)
+
 - [⌨️ Local Development](#️-local-development)
+
 - [🤝 Contributing](#-contributing)
+
 - [🔗 More Products](#-more-products)

 ####
@ -99,6 +108,10 @@ LobeChat provides a [self-hosted version][deploy-url] with Vercel. This allows y
 | `OPENAI_PROXY_URL`   | No       | If you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URL | `https://api.chatanywhere.cn`<br/>The default value is<br/>`https://api.openai.com` |
 | `ACCESS_CODE`        | No       | Add a password to access this service, the password should be a 6-digit number or letter                                                      | `awCT74` or `e3@09!`                                                                |

+### Keep Updated
+
+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, [Maintaining Updates with LobeChat Self-Deployment](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.en-US).
+
 <div align="right">

 [![][back-to-top]](#readme-top)
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@ -35,12 +35,21 @@ LobeChat 是一个开源的、可扩展的（[Function Calling][fc-url]）高性
 #### TOC

 - [👋🏻 开始使用 & 交流](#-开始使用--交流)
+
 - [✨ 功能特性](#-功能特性)
+
 - [🛳 开箱即用](#-开箱即用)
+
+  - [保持更新](#保持更新)
+
 - [📦 生态系统](#-生态系统)
+
 - [🧩 插件体系](#-插件体系)
+
 - [⌨️ 本地开发](#️-本地开发)
+
 - [🤝 参与贡献](#-参与贡献)
+
 - [🔗 更多工具](#-更多工具)

 ####
@ -99,6 +108,10 @@ LobeChat 提供了 Vercel 的 [自托管版本][deploy-url]。这使你可以在
 | `OPENAI_PROXY_URL` | 可选 | 如果你手动配置了 OpenAI 接口代理，可以使用此配置项来覆盖默认的 OpenAI API 请求基础 URL | `https://api.chatanywhere.cn`<br/>默认值:<br/>`https://api.openai.com` |
 | `ACCESS_CODE`      | 可选 | 添加访问此服务的密码，密码应为 6 位数字或字母                                          | `awCT74` 或 `e3@09!`                                                   |

+### 保持更新
+
+如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示“有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照 [LobeChat 自部署保持更新](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync.zh-CN) 步骤重新部署。
+
 <div align="right">

 [![][back-to-top]](#readme-top)
--- a/docs/Home.md
+++ b/docs/Home.md
@ -14,6 +14,12 @@ LobeChat is a open-source, extensible (Function Calling), high-performance chatb

 <br/>

+### 🤯 LobeChat
+
+- [Upstream Sync](Upstream-Sync.en-US)
+  - [English](Upstream-Sync.en-US)
+  - [简体中文](Upstream-Sync.zh-CN)
+
 ## 🤖 Agents

 - [Agent Index](https://github.com/lobehub/lobe-chat-agents)
--- a/docs/Upstream-Sync.en-US.md
+++ b/docs/Upstream-Sync.en-US.md
@ -0,0 +1,17 @@
+# Maintaining Updates with LobeChat Self-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://gw.alipayobjects.com/zos/kitchen/kYpSH6v%26iC/sync-1.webp)
+
+![](https://gw.alipayobjects.com/zos/kitchen/gUQaz%24mGkS/sync-2.webp)
--- a/docs/Upstream-Sync.zh-CN.md
+++ b/docs/Upstream-Sync.zh-CN.md
@ -0,0 +1,17 @@
+# LobeChat 自部署保持更新
+
+如果你根据 README 中的一键部署步骤部署了自己的项目，你可能会发现总是被提示“有可用更新”。这是因为 Vercel 默认为你创建新项目而非 fork 本项目，这将导致无法准确检测更新。我们建议按照以下步骤重新部署：
+
+- 删除原有的仓库；
+- 使用页面右上角的 <kbd>Fork</kbd> 按钮，Fork 本项目；
+- 在 `Vercel` 上重新选择并部署。
+
+## 启动自动更新
+
+> **👉🏻 提示：** 如果你在执行 `Upstream Sync` 时遇到错误，请手动执再行一次
+
+当你 Fork 了项目后，由于 Github 的限制，你需要手动在你 Fork 的项目的 Actions 页面启用 Workflows，并启动 Upstream Sync Action。启用后，你可以设置每小时进行一次自动更新。
+
+![](https://gw.alipayobjects.com/zos/kitchen/kYpSH6v%26iC/sync-1.webp)
+
+![](https://gw.alipayobjects.com/zos/kitchen/gUQaz%24mGkS/sync-2.webp)
--- a/docs/_Sidebar.md
+++ b/docs/_Sidebar.md
@ -4,6 +4,12 @@

 - [TOC](Home)

+### 🤯 LobeChat
+
+- [Upstream Sync](Upstream-Sync.en-US)
+  - [English](Upstream-Sync.en-US)
+  - [简体中文](Upstream-Sync.zh-CN)
+
 ### 🤖 Agents

 - [Agent Index](https://github.com/lobehub/lobe-chat-agents)