Skip to content

Commit fbf9fb1

Browse files
📝 docs:(deploy): update Sealos deployment docs and links (#6399)
Signed-off-by: Carson Yang <[email protected]>
1 parent 3e051dd commit fbf9fb1

File tree

7 files changed

+208
-28
lines changed

7 files changed

+208
-28
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,7 @@ This project is [Apache 2.0](./LICENSE) licensed.
787787
[deploy-on-repocloud-button-image]: https://d16t0pc4846x52.cloudfront.net/deploylobe.svg
788788
[deploy-on-repocloud-link]: https://repocloud.io/details/?app_id=248
789789
[deploy-on-sealos-button-image]: https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg
790-
[deploy-on-sealos-link]: https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dlobe-chat
790+
[deploy-on-sealos-link]: https://template.usw.sealos.io/deploy?templateName=lobe-chat-db
791791
[deploy-on-zeabur-button-image]: https://zeabur.com/button.svg
792792
[deploy-on-zeabur-link]: https://zeabur.com/templates/VZGGTI
793793
[discord-link]: https://discord.gg/AYFPHvv2jT

README.zh-CN.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -807,7 +807,7 @@ This project is [Apache 2.0](./LICENSE) licensed.
807807
[deploy-on-alibaba-cloud-button-image]: https://service-info-public.oss-cn-hangzhou.aliyuncs.com/computenest-en.svg
808808
[deploy-on-alibaba-cloud-link]: https://computenest.console.aliyun.com/service/instance/create/default?type=user&ServiceName=LobeChat%E7%A4%BE%E5%8C%BA%E7%89%88
809809
[deploy-on-sealos-button-image]: https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg
810-
[deploy-on-sealos-link]: https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dlobe-chat
810+
[deploy-on-sealos-link]: https://template.hzh.sealos.run/deploy?templateName=lobe-chat-db
811811
[deploy-on-zeabur-button-image]: https://zeabur.com/button.svg
812812
[deploy-on-zeabur-link]: https://zeabur.com/templates/VZGGTI
813813
[discord-link]: https://discord.gg/AYFPHvv2jT

docs/self-hosting/platform/sealos.mdx

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: Deploy LobeChat on SealOS
2+
title: Deploy LobeChat on Sealos
33
description: >-
4-
Learn how to deploy LobeChat on SealOS with ease. Follow the provided steps to
4+
Learn how to deploy LobeChat on Sealos with ease. Follow the provided steps to
55
set up LobeChat and start using it efficiently.
66
tags:
77
- Deploy LobeChat
8-
- SealOS Deployment
8+
- Sealos Deployment
99
- OpenAI API Key
1010
- Custom Domain Binding
1111
---
1212

13-
# Deploy LobeChat with SealOS
13+
# Deploy LobeChat with Sealos
1414

15-
If you want to deploy LobeChat on SealOS, you can follow the steps below:
15+
If you want to deploy LobeChat on Sealos, you can follow the steps below:
1616

17-
## SealOS Deployment Process
17+
## Sealos Deployment Process
1818

1919
<Steps>
2020
### Prepare your OpenAI API Key
@@ -29,8 +29,8 @@ If you want to deploy LobeChat on SealOS, you can follow the steps below:
2929

3030
### Bind a custom domain (optional)
3131

32-
You can use the subdomain provided by SealOS, or choose to bind a custom domain. Currently, the domains provided by SealOS have not been contaminated, and can be directly accessed in most regions.
32+
You can use the subdomain provided by Sealos, or choose to bind a custom domain. Currently, the domains provided by Sealos have not been contaminated, and can be directly accessed in most regions.
3333
</Steps>
3434

3535
[deploy-button-image]: https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg
36-
[deploy-link]: https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dlobe-chat
36+
[deploy-link]: https://template.usw.sealos.io/deploy?templateName=lobe-chat

docs/self-hosting/platform/sealos.zh-CN.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: SealOS 上部署 LobeChat
3-
description: 学习如何在 SealOS 上部署 LobeChat,包括准备 OpenAI API Key、点击部署按钮、绑定自定义域名等操作。
2+
title: Sealos 上部署 LobeChat
3+
description: 学习如何在 Sealos 上部署 LobeChat,包括准备 OpenAI API Key、点击部署按钮、绑定自定义域名等操作。
44
tags:
5-
- SealOS
5+
- Sealos
66
- LobeChat
77
- OpenAI API Key
88
- 部署流程
99
- 自定义域名
1010
---
1111

12-
# 使用 SealOS 部署
12+
# 使用 Sealos 部署
1313

14-
如果想在 SealOS 上部署 LobeChat,可以按照以下步骤进行操作:
14+
如果想在 Sealos 上部署 LobeChat,可以按照以下步骤进行操作:
1515

16-
## SealOS 部署流程
16+
## Sealos 部署流程
1717

1818
<Steps>
1919
### 准备好你的 OpenAI API Key
@@ -28,7 +28,7 @@ tags:
2828

2929
### 绑定自定义域名(可选)
3030

31-
你可以使用 SealOS 提供的子域名,也可以选择绑定自定义域名。目前 SealOS 提供的域名还未被污染,大多数地区都可以直连。
31+
你可以使用 Sealos 提供的子域名,也可以选择绑定自定义域名。目前 Sealos 提供的域名还未被污染,大多数地区都可以直连。
3232
</Steps>
3333

3434
[deploy-button-image]: https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg

docs/self-hosting/server-database/sealos.mdx

+84-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,94 @@
11
---
2-
title: Deploy LobeChat on SealOS
2+
title: Deploy Lobe Chat Database Version on Sealos
33
description: >-
4-
Learn how to deploy LobeChat on SealOS with ease. Follow the provided steps to
4+
Learn how to deploy LobeChat on Sealos with ease. Follow the provided steps to
55
set up LobeChat and start using it efficiently.
66
tags:
77
- Deploy LobeChat
8-
- SealOS Deployment
8+
- Sealos Deployment
99
- OpenAI API Key
1010
- Custom Domain Binding
1111
---
1212

13-
# Deploy LobeChat on SealOS
13+
# Deploying Lobe Chat Database Version on Sealos
14+
15+
<Callout type="info">
16+
This article assumes that you are familiar with the basic principles and processes of deploying
17+
the LobeChat server database version, so it only includes content related to core environment
18+
variable configuration. If you are not familiar with the deployment principles of the LobeChat
19+
server database version, please refer to [Deploying Server
20+
Database](/docs/self-hosting/server-database) first.
21+
</Callout>
22+
23+
The application on Sealos includes 4 services:
24+
25+
- Logto for authrization(need to deploy separately).
26+
- PostgreSQL with Vector plugin for data storage and indexing.
27+
- One object storage Bucket.
28+
- Lobe Chat database version.
29+
30+
Here is the process for deploying the Lobe Chat server database version on Sealos:
31+
32+
## Pre-Deployment Setup
33+
34+
**Step 1**:Click the button below to deploy a Logto service:
35+
36+
[![](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://template.usw.sealos.io/deploy?templateName=logto)
37+
38+
> Logto is an open-source identity and access management (IAM) platform, an open-source alternative to Auth0, designed to help developers quickly build secure and scalable login and registration systems and user identity systems.
39+
40+
**Step 2**:After the deployment is complete, wait for all the components of the application to be in the "Running" state, click the application's "Details" button to enter the application details page.
41+
42+
![Logto application deployment status on Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-app-deployment-status-sealos-en.png)
43+
44+
Click the public address corresponding to port 3002, you can use the public address to access the Logto service.
45+
46+
![Logto service public address](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-public-address-en.png)
47+
48+
**Step 3**:Register a management account, then click the `Applications` menu on the left, enter the application list page. Click the `Create application` button in the upper right corner to create an application.
49+
50+
![Logto application list page](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-application-list.png)
51+
52+
Select `Next.js (App Router)` as the framework, then click the `Start building` button.
53+
54+
![Logto create application page](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-create-application.png)
55+
56+
**Step 4**:In the pop-up window, fill in the application name as `Lobe Chat`, then click the `Create application` button. Next, do not fill in anything, just click the bottom `Finish and done` button to create it.
57+
58+
![Logto create application done page](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-create-application-done.png)
59+
60+
**Step 5**:In the `Lobe Chat` application, find the following three parameters, which will be used later when deploying the Lobe Chat database version.
61+
62+
![Logto application detail page](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-app-detail.png)
63+
64+
## Deploy Lobe Chat Database Version
65+
66+
**Step 1**:Fill in the following three required parameters:
67+
68+
- `AUTH_LOGTO_ID`:The App ID of the Logto application
69+
- `AUTH_LOGTO_SECRET`:The App Secret of the Logto application
70+
- `AUTH_LOGTO_ISSUER`:The Issuer endpoint of the Logto application
71+
72+
**Step 2**:Click the `Deploy App` button, after the deployment is complete, wait for all the components of the application to be in the "Running" state, click the application's "Details" button to enter the application details page.
73+
74+
![Lobe Chat database version deployment done page](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/lobe-chat-db-deployment-done-en.png)
75+
76+
**Step 3**:Find the public address, copy it, and use it later.
77+
78+
## Post-Deployment Configuration
79+
80+
**Step 1**:Enter the `Applications` page of Logto, find the `Lobe Chat` application, click to enter the application details page.
81+
82+
**Step 2**:In the `Settings` page, find the `Redirect URI` and `Post sign-out redirect URI` parameters, fill in the following values:
83+
84+
- Redirect URI: `https://<lobe-chat-db-public-address>/api/auth/callback/logto`
85+
- Post sign-out redirect URI: `https://<lobe-chat-db-public-address>`
86+
87+
**Step 3**:Click the `Save changes` button to save the configuration.
88+
89+
**Step 4**:Now, access the Lobe Chat database version through `https://<lobe-chat-db-public-address>`, click the avatar in the upper left corner, and then click the [Log in / Sign up] button.
90+
91+
**Step 5**:Next, you will be redirected to the Logto login page, click the [Create account] button to register an account.
92+
93+
**Step 6**:After registration, you can use Logto to login to the Lobe Chat database version.
1494

15-
TODO
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,114 @@
11
---
2-
title: SealOS 上部署 LobeChat
3-
description: 学习如何在 SealOS 上部署 LobeChat,包括准备 OpenAI API Key、点击部署按钮、绑定自定义域名等操作。
2+
title: Sealos 上部署 LobeChat 数据库版
3+
description: 学习如何在 Sealos 上部署 LobeChat,包括准备 OpenAI API Key、点击部署按钮、绑定自定义域名等操作。
44
tags:
5-
- SealOS
5+
- Sealos
66
- LobeChat
77
- OpenAI API Key
88
- 部署流程
99
- 自定义域名
1010
---
1111

12-
# 使用 SealOS 部署 LobeChat 数据库版
12+
# 使用 Sealos 部署 LobeChat 数据库版
1313

14-
TODO
14+
<Callout type="info">
15+
本文假设你已经熟悉 Lobe Chat
16+
服务器数据库版的部署基本原理和流程,因此只包含与核心环境变量配置相关的内容。如果你对 Lobe Chat
17+
服务器数据库版的部署原理不熟悉,请先参考[部署服务器数据库](/zh/docs/self-hosting/server-database)
18+
</Callout>
19+
20+
在 Sealos 的 Lobe Chat 数据库版应用中总共包含有以下四个服务:
21+
22+
- Logto 提供身份校验(需额外部署)
23+
- 带有 Vector 插件的 PostgreSQL 来做数据存储和向量化
24+
- 一个对象存储 Bucket
25+
- LobeChat Database 的实例
26+
27+
这里是在 Sealos 上部署 Lobe Chat 服务器数据库版的流程:
28+
29+
## 预部署配置
30+
31+
在开始部署之前,您需要完成以下配置:
32+
33+
<Steps>
34+
35+
### 部署 Logto 服务
36+
37+
点击下方按钮部署一个 Logto 服务:
38+
39+
[![](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://template.hzh.sealos.run/deploy?templateName=logto)
40+
41+
> Logto 是一个开源的身份与访问管理(IAM)平台,是 Auth0 的开源替代方案,旨在帮助开发者快速构建安全、可扩展的登录注册系统和用户身份体系。
42+
43+
部署完成后,等待应用的所有组件状态都变成“运行中”,点击应用的【详情】按钮,进入应用详情页面。
44+
45+
![Logto 应用详情页面部署完成状态](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-app-deployment-status-sealos.png)
46+
47+
点击 3002 端口对应的公网地址,即可使用公网域名访问 Logto 服务。
48+
49+
![Logto 服务公网地址](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-public-address.png)
50+
51+
### 创建 Application
52+
53+
注册一个管理员账号,然后点击左侧的 `Applications` 菜单,进入应用列表页面。再点击右上角的 `Create application` 按钮创建应用。
54+
55+
![Logto 应用列表页面](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-application-list.png)
56+
57+
选择 `Next.js (App Router)` 作为框架,然后点击 `Start building` 按钮。
58+
59+
![Logto 创建应用页面](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-create-application.png)
60+
61+
在弹窗中填写应用的名称为 `Lobe Chat`,然后点击 `Create application` 按钮。接下来啥也不用填,直接点击底部的 `Finish and done` 按钮就创建完成了。
62+
63+
![Logto 创建应用完成页面](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-create-application-done.png)
64+
65+
`Lobe Chat` 应用中找到以下三个参数,后面部署 Lobe Chat 数据库版时需要用到。
66+
67+
![Logto 应用详情页面](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/logto-app-detail.png)
68+
69+
</Steps>
70+
71+
## 部署 Lobe Chat 数据库版
72+
73+
点击下方按钮访问 Lobe Chat 数据库版应用部署页面:
74+
75+
[![](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://template.hzh.sealos.run/deploy?templateName=lobe-chat-db)
76+
77+
填入三个必填参数:
78+
79+
- `AUTH_LOGTO_ID`:Logto 应用的 App ID
80+
- `AUTH_LOGTO_SECRET`:Logto 应用的 App Secret
81+
- `AUTH_LOGTO_ISSUER`:Logto 应用的 Issuer endpoint
82+
83+
点击【部署】按钮,部署完成后,等待应用的所有组件状态都变成“运行中”,点击应用的【详情】按钮,进入应用详情页面。
84+
85+
![Lobe Chat 数据库版部署完成页面](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/lobe-chat-db-deployment-done.png)
86+
87+
找到公网地址,复制下来,后面需要用到。
88+
89+
![Lobe Chat 数据库版公网地址](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/lobe-chat-db-public-address.png)
90+
91+
## 部署后配置
92+
93+
进入 Logto 的 `Applications` 页面,找到 `Lobe Chat` 应用,点击进入应用详情页面。
94+
95+
`Settings` 页面中找到 “Redirect URI” 和 “Post sign-out redirect URI” 这两个参数,填入以下值:
96+
97+
- Redirect URI:`https://<lobe-chat-db-public-address>/api/auth/callback/logto`
98+
- Post sign-out redirect URI:`https://<lobe-chat-db-public-address>`
99+
100+
其中 `https://<lobe-chat-db-public-address>` 为 Lobe Chat 数据库版的公网地址。
101+
102+
填完之后点击 `Save changes` 按钮保存配置。
103+
104+
现在通过 `https://<lobe-chat-db-public-address>` 访问 Lobe Chat 数据库版,点击左上角的头像,然后点击【登录 / 注册】按钮:
105+
106+
![Lobe Chat 数据库版登录页面](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/lobe-chat-db-login.png)
107+
108+
接下来会跳转到 Logto 的登录页面,点击【注册】注册一个账号。
109+
110+
![Lobe Chat 数据库版注册页面](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/lobe-chat-db-register.png)
111+
112+
注册完成后,即可使用 Logto 登录 Lobe Chat 数据库版。
113+
114+
![Lobe Chat 数据库版登录成功页面](https://raw.githubusercontent.com/labring-actions/templates/main/template/lobe-chat-db/images/lobe-chat-db-login-success.png)

docs/self-hosting/start.zh-CN.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
title: 构建属于自己的 LobeChat - 自选部署平台
33
description: >-
44
选择适合自己的部署平台,构建个性化的 Lobe Chat。支持 Docker、Docker
5-
Compose、Netlify、Railway、Repocloud、SealOS、Vercel 和 Zeabur 部署。
5+
Compose、Netlify、Railway、Repocloud、Sealos、Vercel 和 Zeabur 部署。
66
tags:
77
- Lobe Chat
88
- 部署平台
99
- Docker
1010
- Netlify
1111
- Vercel
12+
- Sealos
1213
- 阿里云计算巢
1314
- 个性化
1415
- 腾讯云

0 commit comments

Comments
 (0)