Skip to content

Commit

Permalink
📝 docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
canisminor1990 committed Dec 3, 2023
1 parent 79f82c8 commit 0421a07
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 50 deletions.
37 changes: 12 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<a name="readme-top"></a><div align="center">
<a name="readme-top"></a>

<div align="center">

<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-logo/1.0.0/files/assets/logo-3d.webp">
<img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
Expand All @@ -24,7 +26,8 @@ Supports one-click free deployment of your private ChatGPT/LLM web application.
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
[![][github-license-shield]][github-license-link]<br>
[![](https://img.shields.io/badge/-Sponsor%20LobeHub-f04f88?logo=opencollective&logoColor=white&style=flat-square)](https://opencollective.com/lobehub 'Sponsor LobeHub on open-collective')

**Share LobeChat Repository**

Expand All @@ -49,9 +52,8 @@ Supports one-click free deployment of your private ChatGPT/LLM web application.
- [✨ Features](#-features)
- [⚡️ Performance](#️-performance)
- [🛳 Self Hosting](#-self-hosting)
- [`A` Deploying with Vercel](#a-deploying-with-vercel)
- [`A` Deploying with Vercel or Zeabur](#a-deploying-with-vercel-or-zeabur)
- [`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 @@ -322,18 +324,20 @@ Beside these features, LobeChat also have much better basic technique undergroun

LobeChat provides Self-Hosted Version with Vercel and [Docker Image][docker-release-link]. This allows you to deploy your own chatbot within a few minutes without any prior knowledge.

### `A` Deploying with Vercel
### `A` Deploying with Vercel or Zeabur

If you want to deploy this service yourself on Vercel, you can follow these steps:
If you want to deploy this service yourself on either Vercel or 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 Vercel. Log in directly with your GitHub account, and remember to fill in the `OPENAI_API_KEY`(required) and `ACCESS_CODE` (recommended) on the environment variable section.
- Click the button below to start deployment: Log in directly with your GitHub account, and remember to fill in the `OPENAI_API_KEY`(required) and `ACCESS_CODE` (recommended) on the environment variable section.
- After deployment, you can start using it.
- Bind a custom domain (optional): The DNS of the domain assigned by Vercel is polluted in some areas; binding a custom domain can connect directly.

<div align="center">

[![][deploy-button-image]][deploy-link]
| Deploy with Vercel | Deploy with Zeabur |
| :-------------------------------------: | :---------------------------------------------------------: |
| [![][deploy-button-image]][deploy-link] | [![][deploy-on-zeabur-button-image]][deploy-on-zeabur-link] |

</div>

Expand Down Expand Up @@ -380,23 +384,6 @@ $ 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>

<br/>

### Environment Variable

This project provides some additional configuration items set with environment variables:
Expand Down
35 changes: 10 additions & 25 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ LobeChat 是开源的高性能聊天机器人框架,支持语音合成、多
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
[![][github-license-shield]][github-license-link]<br>
[![](https://img.shields.io/badge/-Sponsor%20LobeHub-f04f88?logo=opencollective&logoColor=white&style=flat-square)](https://opencollective.com/lobehub 'Sponsor LobeHub on open-collective')

**分享 LobeChat 给你的好友**

Expand All @@ -48,9 +49,8 @@ LobeChat 是开源的高性能聊天机器人框架,支持语音合成、多
- [✨ 特性一览](#-特性一览)
- [⚡️ 性能测试](#️-性能测试)
- [🛳 开箱即用](#-开箱即用)
- [`A` 使用 Vercel 部署](#a-使用-vercel-部署)
- [`A` 使用 Vercel 或 Zeabur 部署](#a-使用-vercel-或-zeabur-部署)
- [`B` 使用 Docker 部署](#b-使用-docker-部署)
- [`C` 使用 Zeabur 部署](#c-使用-zeabur-部署)
- [环境变量](#环境变量)
- [📦 生态系统](#-生态系统)
- [🧩 插件体系](#-插件体系)
Expand Down Expand Up @@ -296,18 +296,20 @@ LobeChat 提供了 Vercel 的 自托管版本 和 [Docker 镜像][docker-release

<br/>

### `A` 使用 Vercel 部署
### `A` 使用 Vercel 或 Zeabur 部署

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

- 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys)
- 点击下方按钮开始部署: Deploy with Vercel,直接使用 GitHub 账号登录即可,记得在环境变量页填入 `OPENAI_API_KEY` (必填) and `ACCESS_CODE`(推荐);
- 点击下方按钮开始部署: 直接使用 GitHub 账号登录即可,记得在环境变量页填入 `OPENAI_API_KEY` (必填) and `ACCESS_CODE`(推荐);
- 部署完毕后,即可开始使用;
- 绑定自定义域名(可选):Vercel 分配的域名 DNS 在某些区域被污染了,绑定自定义域名即可直连。
- 绑定自定义域名(可选):Vercel 分配的域名 DNS 在某些区域被污染了,绑定自定义域名即可直连。目前 Zeabur 提供的域名还未被污染,大多数地区都可以直连。

<div align="center">

[![][deploy-button-image]][deploy-link]
| 使用 Vercel 部署 | 使用 Zeabur 部署 |
| :-------------------------------------: | :---------------------------------------------------------: |
| [![][deploy-button-image]][deploy-link] | [![][deploy-on-zeabur-button-image]][deploy-on-zeabur-link] |

</div>

Expand Down Expand Up @@ -354,23 +356,6 @@ $ 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>

<br/>

### 环境变量

本项目提供了一些额外的配置项,使用环境变量进行设置:
Expand Down

0 comments on commit 0421a07

Please sign in to comment.