Skip to content

Commit

Permalink
📝 docs: improve vercel and sync (lobehub#3581)
Browse files Browse the repository at this point in the history
* 📝 docs: improve docs of vercel deployment

* 📝 docs: improve docs

* Update `upstream-sync.mdx` to include detailed instructions for handling sync failures and manual updates

* Add instructions for manually clicking "Update Branch" in case of sync failures
* Include images to illustrate the process of handling sync failures and manually updating branches
  • Loading branch information
arvinxx authored Aug 23, 2024
1 parent f10f3b3 commit 0e3bf0c
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/self-hosting/advanced/upstream-sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,18 @@ After forking the project, due to Github's limitations, you need to manually ena
src="https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png"
/>

If you encounter a sync failure, you need to manually click "Update Branch" once.

<Image
alt="GitHub Action Sync Failure"
src="https://github.com/user-attachments/assets/9baacac6-5af4-460b-862d-682b76c18459"
/>

<Image
alt="Manually Sync 'Update Branch'"
src="https://github.com/user-attachments/assets/d524c20d-306a-45bc-971b-96920b87fab4"
/>

## `B` Docker Deployment

Upgrading the Docker deployment version is very simple, you just need to redeploy the latest LobeChat image. Here are the commands required to perform these steps:
Expand Down
12 changes: 12 additions & 0 deletions docs/self-hosting/advanced/upstream-sync.zh-CN.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,18 @@ tags:
src="https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/266985177-7677b4ce-c348-4145-9f60-829d448d5be6.png"
/>

如果你遇到了同步失败的情况,你需要手动重新点一次 「Update Branch」。

<Image
alt="GitHub Action 同步失败"
src="https://github.com/user-attachments/assets/9baacac6-5af4-460b-862d-682b76c18459"
/>

<Image
alt="手动同步 「Update Branch」"
src="https://github.com/user-attachments/assets/d524c20d-306a-45bc-971b-96920b87fab4"
/>

## `B` Docker 部署

Docker 部署版本的升级非常简单,只需要重新部署 LobeChat 的最新镜像即可。 以下是执行这些步骤所需的指令:
Expand Down
6 changes: 6 additions & 0 deletions docs/self-hosting/server-database/vercel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ KEY_VAULTS_SECRET=jgwsK28dspyVQoIf8/M3IIHl1h6LYYceSYNXeLpy6uk=

Make sure to add this to the Vercel environment variables as well.

### Add the `APP_URL` Environment Variable

Finally, you need to add the `APP_URL` environment variable, which specifies the URL address of the LobeChat application.

</Steps>

## 2. Configure Authentication Service
Expand Down Expand Up @@ -394,6 +398,8 @@ src={'https://github.com/lobehub/lobe-chat/assets/28616219/9cb5150d-6e1e-4c59-9a
For easy copying, here is a summary of the environment variables required to configure the server-side database:

```shell
APP_URL=https://your-project.com

# Specify the service mode as server
NEXT_PUBLIC_SERVICE_MODE=server

Expand Down
6 changes: 6 additions & 0 deletions docs/self-hosting/server-database/vercel.zh-CN.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ KEY_VAULTS_SECRET=jgwsK28dspyVQoIf8/M3IIHl1h6LYYceSYNXeLpy6uk=

同样需要将其添加到 Vercel 环境变量中。

### 添加 `APP_URL` 环境变量

该部分最后需要添加 APP_URL 环境变量,用于指定LobeChat 应用的 URL 地址。

</Steps>

## 二、 配置身份验证服务
Expand Down Expand Up @@ -375,6 +379,8 @@ S3_PUBLIC_DOMAIN=https://s3-dev.your-domain.com
为方便一键复制,在此汇总配置服务端数据库所需要的环境变量:

```shell
APP_URL=https://your-project.com

# 指定服务模式为 server
NEXT_PUBLIC_SERVICE_MODE=server

Expand Down

0 comments on commit 0e3bf0c

Please sign in to comment.