Skip to content

Commit

Permalink
📝 docs: add deploy to Zeabur guide in README (lobehub#523)
Browse files Browse the repository at this point in the history
* docs: add deploy to Zeabur guide in README

* docs: add deploy to Zeabur in zh-CN Readme

* docs: fix typo in Readme
  • Loading branch information
MichaelYuhe authored Nov 29, 2023
1 parent d78f1aa commit ac13a72
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Supports one-click free deployment of your private ChatGPT/LLM web application.
- [🛳 Self Hosting](#-self-hosting)
- [`A` Deploying with Vercel](#a-deploying-with-vercel)
- [`B` Deploying with Docker](#b-deploying-with-docker)
- [`C` Deploying with Zeabur](#c-deploying-with-zeabur)
- [Environment Variable](#environment-variable)
- [📦 Ecosystem](#-ecosystem)
- [🧩 Plugins](#-plugins)
Expand Down Expand Up @@ -379,6 +380,22 @@ $ docker run -d -p 3210:3210 \
<br/>

### `C` Deploying with Zeabur

If you want to deploy this service yourself on Zeabur, you can follow these steps:

- Prepare your [OpenAI API Key](https://platform.openai.com/account/api-keys).
- Click the button below to start deployment: Deploy with Zeabur.
- You can start using it after the deployment.
- You can bind a custom domain or use the subdomain provided by Zeabur.


<div align="center">

[![][deploy-on-zeabur-button-image]][deploy-on-zeabur-link]

</div>

### Environment Variable

This project provides some additional configuration items set with environment variables:
Expand Down Expand Up @@ -518,6 +535,8 @@ This project is [MIT](./LICENSE) licensed.
[contributors-link]: https://github.com/lobehub/lobe-chat/graphs/contributors
[deploy-button-image]: https://vercel.com/button
[deploy-link]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-chat&env=OPENAI_API_KEY&envDescription=Find%20your%20OpenAI%20API%20Key%20by%20click%20the%20right%20Learn%20More%20button.&envLink=https%3A%2F%2Fplatform.openai.com%2Faccount%2Fapi-keys&project-name=lobe-chat&repository-name=lobe-chat
[deploy-on-zeabur-button-image]: https://zeabur.com/button.svg
[deploy-on-zeabur-link]: https://zeabur.com/templates/VZGGTI
[discord-link]: https://discord.gg/AYFPHvv2jT
[discord-shield]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
[discord-shield-badge]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge
Expand Down
17 changes: 17 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,21 @@ $ docker run -d -p 3210:3210 \
<br/>

### `C` 使用 Zeabur 部署

如果想在 Zeabur 上部署该服务,可以按照以下步骤进行操作:

- 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys)
- 点击下方按钮开始部署: Deploy to Zeabur
- 部署完毕后,即可开始使用;
- 绑定自定义域名(可选):你可以使用 Zeabur 提供的子域名,也可以选择绑定自定义域名。目前 Zeabur 提供的域名还未被污染,大多数地区都可以直连。

<div align="center">

[![][deploy-on-zeabur-button-image]][deploy-on-zeabur-link]

</div>

### 环境变量

本项目提供了一些额外的配置项,使用环境变量进行设置:
Expand Down Expand Up @@ -492,6 +507,8 @@ This project is [MIT](./LICENSE) licensed.
[contributors-link]: https://github.com/lobehub/lobe-chat/graphs/contributors
[deploy-button-image]: https://vercel.com/button
[deploy-link]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-chat&env=OPENAI_API_KEY&envDescription=Find%20your%20OpenAI%20API%20Key%20by%20click%20the%20right%20Learn%20More%20button.&envLink=https%3A%2F%2Fplatform.openai.com%2Faccount%2Fapi-keys&project-name=lobe-chat&repository-name=lobe-chat
[deploy-on-zeabur-button-image]: https://zeabur.com/button.svg
[deploy-on-zeabur-link]: https://zeabur.com/templates/VZGGTI
[discord-link]: https://discord.gg/AYFPHvv2jT
[discord-shield]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
[discord-shield-badge]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge
Expand Down

0 comments on commit ac13a72

Please sign in to comment.