diff --git a/README.md b/README.md index 6cad6a8..7761734 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,25 @@ - [x] Deploy using [docker compose](#use-with-docker-compose---recommended-) - [x] Add Railway deploy -## Use with Railway (✅Recommended) - +## 🚀 Usage +- [Use with Railway](#use-with-railway)(PaaS, Free, Stable, ✅Recommended) +- [Use with Fly.io](#use-with-flyio)(Paas, Free, ✅Recommended) +- [Use with docker](#use-with-docker)(Self-hosted, Stable, ✅Recommended) +- [Use with docker compose](#use-with-docker-compose)(Self-hosted, Stable, ✅Recommended) +- [Use with nodejs](#use-with-nodejs)(Self-hosted) + +## Use with Railway +> Railway offers $5 or 500 hours of runtime per month 1. Click the [Railway](https://railway.app/template/dMLG70?referralCode=bIYugQ) button to go to the Railway deployment page 2. Click the `Deploy Now` button to enter the Railway deployment page 3. Fill in the repository name and `OPENAI_API_KEY` (need to link GitHub account) 4. Click the `Deploy` button 5. Click the `View Logs` button and wait for the deployment to complete -## Use with Fly.io(✅ Recommended) +## Use with Fly.io +> Please allocate 512MB memory for the application to meet the application requirements +> fly.io offers free bills up to $5(Free Allowances 3 256MB are not included in the bill) 1. Install [flyctl](https://fly.io/docs/getting-started/installing-flyctl/) ```shell # macOS @@ -70,7 +79,7 @@ ``` -## Use with docker(✅ Recommended) +## Use with docker ```sh # pull image @@ -87,7 +96,7 @@ docker logs -f wechat-chatgpt ``` > How to get OPENAI API KEY? [Click here](https://platform.openai.com/account/api-keys) -## Use with docker compose(✅ Recommended) +## Use with docker compose ```sh # Copy the configuration file according to the template diff --git a/README_ZH.md b/README_ZH.md index b1e2336..ac7f088 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -26,15 +26,25 @@ - [x] 使用[docker compose](#通过docker-compose使用-推荐)进行部署 - [x] 通过 Railway 进行部署 -## 使用Railway进行部署(✅ 推荐) - +## 🚀 使用 +- [在 Railway 部署](#使用railway进行部署)(PaaS, 免费, 稳定, ✅推荐) +- [在 Fly.io 部署](#通过flyio进行部署)(PaaS, 免费, ✅推荐) +- [使用 Docker 部署](#通过docker使用)(自托管, 稳定, ✅推荐) +- [使用 Docker Compose 部署](#通过docker-compose使用)(自托管, 稳定, ✅推荐) +- [使用 NodeJS 部署](#使用nodejs运行) + +## 使用Railway进行部署 +> Railway 是一个免费的 PaaS 平台,5刀以内的账单免费或者每个月500小时的运行时间 1. 点击 [Railway](https://railway.app/template/dMLG70?referralCode=bIYugQ) 按钮,进入 Railway 部署页面 2. 点击 `Deploy Now` 按钮,进入 Railway 部署页面 3. 填写 仓库名称和 `OPENAI_API_KEY`(需要连接 GitHub 账号) 4. 点击 `Deploy` 按钮 5. 点击 `View Logs` 按钮,等待部署完成 -## 通过Fly.io进行部署(✅ 推荐) +## 通过Fly.io进行部署 +> 请为应用程序分配 512 MB 内存,否则可能会出现内存溢出 + +> Fly.io 5刀以内的账单免费(免费计划的3个256MB的应用不在账单内)也就是可以同时可以部署 `1*512MB + 3*256MB` 1. 安装 [flyctl](https://fly.io/docs/getting-started/installing-flyctl/) ```shell # macOS @@ -66,7 +76,7 @@ flyctl deploy ``` -## 通过Docker使用(✅ 推荐) +## 通过Docker使用 ```sh # 拉取镜像 @@ -83,7 +93,7 @@ docker logs -f wechat-chatgpt ``` > 如何获取 OPENAI API KEY?请参考 [OpenAI API](https://platform.openai.com/account/api-keys)。 -## 通过docker compose使用(✅ 推荐) +## 通过docker compose使用 ```sh # 根据模板拷贝配置文件