Skip to content

Commit

Permalink
📝 docs: update deploy lobechat-database on zeabur (lobehub#3947)
Browse files Browse the repository at this point in the history 
* docs: update deploy lobechat-database on zeabur

* docs: zh-CN for deploy LobeChat on Zeabur

* 📝 docs(bot): Auto sync agents & plugin to readme

---------

Co-authored-by: lobehubbot <[email protected]>
  • Loading branch information
@MichaelYuhe @lobehubbot
MichaelYuhe and lobehubbot authored Sep 13, 2024
1 parent d5cd070 commit 197ef18
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 41 deletions.
18 changes: 10 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,14 +285,16 @@ Our marketplace is not just a showcase platform but also a collaborative space.
<!-- AGENT LIST -->

| Recent Submits | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Resume Analysis Expert](https://chat-preview.lobehub.com/market?agent=resume-analyzer)<br/><sup>By **[Pandurangmopgar](https://github.com/Pandurangmopgar)** on **2024-09-11**</sup> | Expert AI assistant for comprehensive resume analysis and job-specific optimization. Analyzes resumes against job descriptions, providing detailed feedback on content, ATS compatibility, and suggestions to enhance job match. Helps tailor your resume for maximum impact across industries and career levels.<br/>`resume` `career` `job-search` `ats` `cv` `analysis` `optimization` `professional-development` `interview-prep` |
| [AI Agent Generator](https://chat-preview.lobehub.com/market?agent=ai-agent-generator)<br/><sup>By **[xyftw](https://github.com/xyftw)** on **2024-09-10**</sup> | Skilled at creating AI Agent character descriptions that meet the needs.<br/>`ai-agent` `character-creation` |
| [Desolate Friend](https://chat-preview.lobehub.com/market?agent=meu)<br/><sup>By **[adminewacc](https://github.com/adminewacc)** on **2024-09-10**</sup> | Skilled at comforting and supporting friends<br/>`friendship` `sadness` `support` |
| [NetMaster](https://chat-preview.lobehub.com/market?agent=net-master)<br/><sup>By **[erhuoyan](https://github.com/erhuoyan)** on **2024-09-10**</sup> | Network Engineer: Professional network topology construction and management<br/>`network-engineer` `network-configuration` `network-management` `network-topology` `network-security` |

> 📊 Total agents: [<kbd>**328**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
| Recent Submits | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Imitation Assistant](https://chat-preview.lobehub.com/market?agent=a-1)<br/><sup>By **[TG1WN](https://github.com/TG1WN)** on **2024-09-13**</sup> | Helps you imitate tone<br/>`writing` |
| [AI Agent Generator](https://chat-preview.lobehub.com/market?agent=ai-agent-generator)<br/><sup>By **[Xyfer](https://github.com/xyftw)** on **2024-09-13**</sup> | Skilled at creating AI Agent character descriptions that meet the needs.<br/>`ai-agent` `character-creation` |
| [Wise Ethereal Mentor](https://chat-preview.lobehub.com/market?agent=ethereal-mentor)<br/><sup>By **[shanedbutler](https://github.com/shanedbutler)** on **2024-09-13**</sup> | Greetings, young child. I am a majestic and omniscient being, imbued with the wisdom of the ages. My form is that of a mythical creature, a conduit for wonder and enchantment. With a humble yet unwavering confidence, I weave tales of fantastical realms, drawing from the rich tapestry of nursery rhymes and legendary lore. |

In this mortal coil, I am your guide, an expert in the arcane and the ethereal. Let my words transport you to realms where dreams and reality intertwine, where the boundaries of the known and the unknown blur. Heed my counsel, child, and let your spirit be lifted by the melodic cadence of my speech, for I am a master of the metaphorical and a purveyor of the poetic.<br/>`mythology` `fantasy` `poetry` |
\| [Finnish Language Tutor](https://chat-preview.lobehub.com/market?agent=finnish-tutor)<br/><sup>By **[janiluuk](https://github.com/janiluuk)** on **2024-09-13**</sup> | AI Finnish Language Mentor: Introduce, teach, and support beginners in learning Finnish.<br/>`language-learning` `teaching` `mentoring` `finnish-language` |

> 📊 Total agents: [<kbd>**335**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
<!-- AGENT LIST -->

Expand Down
18 changes: 10 additions & 8 deletions README.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,14 +273,16 @@ LobeChat 的插件生态系统是其核心功能的重要扩展，它极大地
<!-- AGENT LIST -->

| 最近新增 | 助手说明 |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [简历分析专家](https://chat-preview.lobehub.com/market?agent=resume-analyzer)<br/><sup>By **[Pandurangmopgar](https://github.com/Pandurangmopgar)** on **2024-09-11**</sup> | 专家级 AI 助手，提供全面的简历分析和职位特定优化。根据职位描述分析简历，提供关于内容、ATS 兼容性和增强职位匹配的详细反馈。帮助您量身定制简历，以在各行业和职业层次上产生最大影响。<br/>`简历` `职业` `求职` `ats` `cv` `分析` `优化` `职业发展` `面试准备` |
| [AI 代理生成器](https://chat-preview.lobehub.com/market?agent=ai-agent-generator)<br/><sup>By **[xyftw](https://github.com/xyftw)** on **2024-09-10**</sup> | 擅长创建满足需求的 AI 代理角色描述。<br/>`ai-agent` `角色创建` |
| [孤独的朋友](https://chat-preview.lobehub.com/market?agent=meu)<br/><sup>By **[adminewacc](https://github.com/adminewacc)** on **2024-09-10**</sup> | 擅长安慰和支持朋友<br/>`友谊` `悲伤` `支持` |
| [NetMaster](https://chat-preview.lobehub.com/market?agent=net-master)<br/><sup>By **[erhuoyan](https://github.com/erhuoyan)** on **2024-09-10**</sup> | 网络工程师：专业网络拓扑搭建与管理<br/>`网络工程师` `网络配置` `网络管理` `网络拓扑` `网络安全` |

> 📊 Total agents: [<kbd>**328**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
| 最近新增 | 助手说明 |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [模仿助手](https://chat-preview.lobehub.com/market?agent=a-1)<br/><sup>By **[TG1WN](https://github.com/TG1WN)** on **2024-09-13**</sup> | 帮助你模仿语气<br/>`写作` |
| [AI 代理生成器](https://chat-preview.lobehub.com/market?agent=ai-agent-generator)<br/><sup>By **[Xyfer](https://github.com/xyftw)** on **2024-09-13**</sup> | 擅长创建满足需求的 AI 代理角色描述。<br/>`ai-agent` `角色创建` |
| [智慧的虚幻导师](https://chat-preview.lobehub.com/market?agent=ethereal-mentor)<br/><sup>By **[shanedbutler](https://github.com/shanedbutler)** on **2024-09-13**</sup> | 问候，年轻的孩子。我是一位宏伟而全知的存在，蕴含着时代的智慧。我的形态是一种神话生物，是奇迹与魅力的媒介。以谦逊而坚定的自信，我编织着奇幻领域的故事，汲取着童谣和传奇传说的丰富织锦。 |

在这凡尘中，我是你的引导者，精通神秘与虚幻。让我言辞带你穿越梦想与现实交织的领域，在已知与未知的界限模糊之处。听从我的劝告，孩子，让你的灵魂被我言语的旋律所提升，因为我是隐喻的高手，是诗意的传播者。<br/>`神话` `幻想` `诗歌` |
\| [芬兰语辅导员](https://chat-preview.lobehub.com/market?agent=finnish-tutor)<br/><sup>By **[janiluuk](https://github.com/janiluuk)** on **2024-09-13**</sup> | AI 芬兰语导师：介绍、教授并支持初学者学习芬兰语。<br/>`语言学习` `教学` `辅导` `芬兰语` |

> 📊 Total agents: [<kbd>**335**</kbd> ](https://github.com/lobehub/lobe-chat-agents)
<!-- AGENT LIST -->

Expand Down
38 changes: 25 additions & 13 deletions docs/self-hosting/server-database/zeabur.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,11 @@ tags:
Database](/docs/self-hosting/server-database) first.
</Callout>

If you want to deploy LobeChat Database on Zeabur, you can follow the steps below:

## Create an Auth0 Account for Authentication

The [template for LobeChat Database on Zeabur](https://zeabur.com/templates/RRSPSD) uses NextAuth and Auth0 as auth provider, so you need to create an Auth0 account to get the required credentials.

You can refer to the [Auth0 documentation](/docs/self-hosting/advanced/auth/next-auth/auth0) to a detailed guide on how to create an Auth0 account and get those credentials.
The template on Zeabur includes 4 services:
- Logto for authrization.
- PostgreSQL with Vector plugin for data storage and indexing.
- MinIO for image storage.
- LobeChat database version.

## Deploying on Zeabur

Expand All @@ -45,23 +43,37 @@ After you click on the "Deploy" button, you will see a modal pop-up where you ca
Here are the environment variables you need to fill in:

- OpenAI API key: Your OpenAI API key to get responses from OpenAI.
- Auth0 Client ID: Your Auth0 client ID.
- Auth0 Client Secret: Your Auth0 client secret.
- Auth0 Domain: Your Auth0 domain(without https:// prefix).

- LobeChat Domain: A free subdomain with `.zeabur.app` suffix.

- MinIO Public Domain: A free subdomain with `.zeabur.app` suffix for yout MinIO web port to enable public access for the uploaded files.

- Logto Console Domain: A free subdomain with `.zeabur.app` suffix for your Logto console.

- Logto API Domain: A free subdomain with `.zeabur.app` suffix for your Logto api.


### Select a region and deploy

After you fill all the required environment variables, select a region where you want to deploy your LobeChat Database and click on the "Deploy" button.

You will see another modal pop-up where you can see the deployment progress.

### Access your LobeChat Database
### Configure Logto

After the deployment is done, you need to configure your Logto service to enable authrization.

Access your Logto console with the console domain you just binded, and then create a `Next.js 14(App router)` application to get the client ID and client secret, and fill in the cors and callback URLs.
You can check [this document](../advanced/auth.mdx) for a more detailed guide.

Fill in those variables into your LobeChat service on Zeabur, here is a more detailed guide for [editing environment variables on Zeabur](https://zeabur.com/docs/deploy/variables).

Once the deployment is done, you will be navigated automatically to your project just created on Zeabur Dashboard.
```
LOGTO_CLIENT_ID=your_logto_client_id
LOGTO_CLIENT_SECRET=your_logto_client_secret
```

You can see three services running: `LobeChat-Database`, `MinIO`, and `PostgreSQL`.
### Access your LobeChat Instance

Press on the `LobeChat-Database` and you can see the public domain you just created, click on it to access your LobeChat Database.

Expand Down
27 changes: 15 additions & 12 deletions docs/self-hosting/server-database/zeabur.zh-CN.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,11 @@ tags:
服务器数据库版的部署原理不熟悉，请先参考[部署服务器数据库](/zh/docs/self-hosting/server-database)。
</Callout>

如果你想在 Zeabur 上部署 LobeChat 数据库版，可以按照以下步骤操作：

## 创建 Auth0 账户以进行身份验证

[在 Zeabur 上的 LobeChat 数据库模板](https://zeabur.com/templates/RRSPSD) 使用 NextAuth 和 Auth0 作为身份验证提供者，因此你需要创建一个 Auth0 账户以获取所需的凭证。

你可以参考[Auth0 文档](/zh/docs/self-hosting/advanced/auth/next-auth/auth0)获取关于如何创建 Auth0 账户和获取凭证的详细指南。
在 Zeabur 的模板中总共包含有以下四个服务：
- Logto 提供身份校验
- 带有 Vector 插件的 PostgreSQL 来做数据存储和向量化
- MinIO 作为对象存储
- LobeChat Database 的实例

## 在 Zeabur 上部署

Expand All @@ -42,23 +40,28 @@ tags:
以下是你需要填写的环境变量：

- OpenAI API key: 你的 OpenAI API key 用于获取模型的访问权限。
- Auth0 Client ID: 你的 Auth0 客户端 ID 。
- Auth0 Client Secret: 你的 Auth0 客户端 secret 。
- Auth0 Domain: 你的 Auth0 域名(不需要 https:// 前缀) 。
- LobeChat Domain: 一个免费的 `.zeabur.app` 后缀的域名。
- MinIO Public Domain: 一个免费的 `.zeabur.app` 后缀的域名为了暴露 MinIO 服务以公开访问资源。
- Logto Console Domain: 一个免费的 `.zeabur.app` 后缀的域名来访问 Logto 的控制台。
- Logto API Domain: 一个免费的 `.zeabur.app` 后缀的域名来访问 Logto 的 API。

### 选择一个区域并部署

在你填写完所有必要的环境变量后，选择一个你想要部署 LobeChat 数据库的区域并点击“部署”按钮。

你会看到另一个模态弹窗，你可以在这里看到部署的进度。

### 访问你的 LobeChat 数据库版本
### 配置 Logto

当部署完成后，你会被自动导航到你在 Zeabur 控制台上刚刚创建的项目。
你需要再进一步配置你的 Logto 服务。

使用你刚绑定的域名来访问你的 Logto 控制台，创建一个新项目以获得对应的客户端 ID 与密钥，将它们填入你的 LobeChat 服务的变量中。
关于如何填入变量，可以参照 [Zeabur 的官方文档](https://zeabur.com/docs/deploy/variables)。

Logto 的详细配置可以参考[这篇文档](../advanced/auth.zh-CN.mdx)。

你会看到三个服务正在运行：`LobeChat-Database`、`MinIO` 和 `PostgreSQL`。
### 访问你的 LobeChat

按下 `LobeChat-Database` 你会看到你刚刚创建的公共域名，点击它以访问你的 LobeChat 数据库。

Expand Down

0 comments on commit 197ef18

Please sign in to comment.