Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit 973acb3
Author: zhayujie <yjzha1996@163.com>
Date:   Tue Jun 27 22:28:51 2023 +0800

    docs: update README.md

commit 1c9020a
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 23:52:32 2023 +0800

    docs: update README.md

commit c5f1d00
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 20:11:35 2023 +0800

    docs: update README.md

commit fa706e8
Merge: db27dfe 12c170f
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 14:16:18 2023 +0800

    Merge pull request zhayujie#1275 from zhayujie/feat-docker

    chore: remove useless docker files

commit 12c170f
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 14:05:08 2023 +0800

    chore: remove useless docker files

commit db27dfe
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 13:10:51 2023 +0800

    docs: modify docker deploy steps

commit 2db4673
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 12:29:09 2023 +0800

    chore: fixed openai version

commit 38619db
Merge: 98b8ff2 930fd43
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 12:00:57 2023 +0800

    Merge pull request zhayujie#1274 from zhayujie/feat-dockerhub

    feat: modify docker-compose file to pull image from dockerhub

commit 930fd43
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 11:58:55 2023 +0800

    feat: modify docker-compose file to pull image from dockerhub

commit 98b8ff2
Merge: 957f257 d066268
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 01:24:24 2023 +0800

    Merge pull request zhayujie#1271 from zhayujie/feat-dockerhub

    feat: publish to dockerhub in github CI simultaneously

commit d066268
Author: zhayujie <yjzha1996@163.com>
Date:   Mon Jun 26 01:20:04 2023 +0800

    feat: publish to dockerhub in github CI simultaneously
  • Loading branch information
congxuma committed Jun 28, 2023
1 parent f4bb107 commit 549b7c6
Show file tree
Hide file tree
Showing 16 changed files with 48 additions and 381 deletions.
43 changes: 39 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Demo made by [Visionn](https://www.wangpc.cc/)

# 交流群

添加小助手微信进群:
添加小助手微信进群,请备注 "wechat"

<img width="240" src="./docs/images/contact.jpg">

Expand Down Expand Up @@ -63,6 +63,8 @@ Demo made by [Visionn](https://www.wangpc.cc/)
支持 Linux、MacOS、Windows 系统(可在Linux服务器上长期运行),同时需安装 `Python`
> 建议Python版本在 3.7.1~3.9.X 之间,推荐3.8版本,3.10及以上版本在 MacOS 可用,其他系统上不确定能否正常运行。
> 注意:Docker 或 Railway 部署无需安装python环境和下载源码,可直接快进到下一节。
**(1) 克隆项目代码:**

```bash
Expand Down Expand Up @@ -196,11 +198,44 @@ nohup python3 app.py & tail -f nohup.out # 在后台运行程序并通

### 3.Docker部署

参考文档 [Docker部署](https://github.com/limccn/chatgpt-on-wechat/wiki/Docker%E9%83%A8%E7%BD%B2) (Contributed by [limccn](https://github.com/limccn))。
> 使用docker部署无需下载源码和安装依赖,只需要获取 docker-compose.yml 配置文件并启动容器即可。
> 前提是需要安装好 `docker``docker-compose`,安装成功的表现是执行 `docker -v``docker-compose version` (或 docker compose version) 可以查看到版本号,可前往 [docker官网](https://docs.docker.com/engine/install/) 进行下载。
#### (1) 下载 docker-compose.yml 文件

```bash
wget https://open-1317903499.cos.ap-guangzhou.myqcloud.com/docker-compose.yml
```

下载完成后打开 `docker-compose.yml` 修改所需配置,如 `OPEN_AI_API_KEY``GROUP_NAME_WHITE_LIST` 等。

#### (2) 启动容器

`docker-compose.yml` 所在目录下执行以下命令启动容器:

```bash
sudo docker compose up -d
```

运行 `sudo docker ps` 能查看到 NAMES 为 chatgpt-on-wechat 的容器即表示运行成功。

注意:

- 如果 `docker-compose` 是 1.X 版本 则需要执行 `sudo docker-compose up -d` 来启动容器
- 该命令会自动去 [docker hub](https://hub.docker.com/r/zhayujie/chatgpt-on-wechat) 拉取 latest 版本的镜像,latest 镜像会在每次项目 release 新的版本时生成

最后运行以下命令可查看容器运行日志,扫描日志中的二维码即可完成登录:

```bash
sudo docker logs -f chatgpt-on-wechat
```

### 4. Railway部署

### 4. Railway部署 (✅推荐)
> Railway每月提供5刀和最多500小时的免费额度。
1. 进入 [Railway](https://railway.app/template/qApznZ?referralCode=RC3znh)
1. 进入 [Railway](https://railway.app/template/qApznZ?referralCode=RC3znh)
2. 点击 `Deploy Now` 按钮。
3. 设置环境变量来重载程序运行的参数,例如`open_ai_api_key`, `character_desc`

Expand Down
1 change: 1 addition & 0 deletions config-template.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"open_ai_api_key": "YOUR API KEY",
"model": "gpt-3.5-turbo",
"proxy": "",
"hot_reload": false,
"single_chat_prefix": [
"bot",
"@bot"
Expand Down
39 changes: 0 additions & 39 deletions docker/Dockerfile.alpine

This file was deleted.

29 changes: 0 additions & 29 deletions docker/Dockerfile.alpine.latest

This file was deleted.

41 changes: 0 additions & 41 deletions docker/Dockerfile.debian

This file was deleted.

15 changes: 0 additions & 15 deletions docker/build.alpine.sh

This file was deleted.

15 changes: 0 additions & 15 deletions docker/build.debian.sh

This file was deleted.

23 changes: 0 additions & 23 deletions docker/chatgpt-on-wechat-voice-reply/Dockerfile.alpine

This file was deleted.

24 changes: 0 additions & 24 deletions docker/chatgpt-on-wechat-voice-reply/Dockerfile.debian

This file was deleted.

24 changes: 0 additions & 24 deletions docker/chatgpt-on-wechat-voice-reply/docker-compose.yaml

This file was deleted.

Loading

0 comments on commit 549b7c6

Please sign in to comment.