chatgpt-on-wechat 项目多种部署方式

chatgpt-on-wechat 项目提供了多种部署方式，以下是详细的部署步骤：

本地部署

1. 准备工作

系统要求：支持 Linux、MacOS、Windows 系统（可在Linux服务器上长期运行），同时需安装 Python。建议Python版本在 3.7.1 - 3.9.X 之间，推荐3.8版本，3.10及以上版本在 MacOS 可用，其他系统上不确定能否正常运行。
克隆项目代码：

git clone https://github.com/zhayujie/chatgpt-on-wechat
cd chatgpt-on-wechat/

注：如遇到网络问题可选择国内镜像 https://gitee.com/zhayujie/chatgpt-on-wechat。
安装依赖：
核心依赖（必选）：能够使用itchat创建机器人，并具有文字交流功能所需的最小依赖集合。

pip3 install -r requirements.txt

拓展依赖（可选，建议安装）：

pip3 install -r requirements-optional.txt

注意：如果某项依赖安装失败可注释掉对应的行再继续。
配置文件：
配置文件的模板在根目录的config-template.json中，需复制该模板创建最终生效的 config.json 文件：

cp config-template.json config.json

然后在config.json中填入配置，以下是对默认配置的说明，可根据需要进行自定义修改（注意实际使用时请去掉注释，保证JSON格式的完整）：

{
  "model": "gpt-3.5-turbo",                                   // 模型名称, 支持 gpt-3.5-turbo, gpt-4, gpt-4-turbo, wenxin, xunfei, glm-4, claude-3-haiku, moonshot
  "open_ai_api_key": "YOUR API KEY",                          // 如果使用openAI模型则填入上面创建的 OpenAI API KEY
  "open_ai_api_base": "https://api.openai.com/v1",            // OpenAI接口代理地址
  "proxy": "",                                                // 代理客户端的ip和端口，国内环境开启代理的需要填写该项，如 "127.0.0.1:7890"
  "single_chat_prefix": ["bot", "@bot"],                      // 私聊时文本需要包含该前缀才能触发机器人回复
  "single_chat_reply_prefix": "[bot] ",                       // 私聊时自动回复的前缀，用于区分真人
  "group_chat_prefix": ["@bot"],                              // 群聊时包含该前缀则会触发机器人回复
  "group_name_white_list": ["ChatGPT测试群", "ChatGPT测试群2"]  // 开启自动回复的群名称列表
}

2. 运行项目

使用nohup命令在后台运行程序：

nohup python3 app.py & tail -f nohup.out          # 在后台运行程序并通过日志输出二维码

扫码登录后程序即可运行于服务器后台，此时可通过 ctrl+c 关闭日志，不会影响后台程序的运行。使用 ps -ef | grep app.py | grep -v grep 命令可查看运行于后台的进程，如果想要重新启动程序可以先 kill 掉对应的进程。日志关闭后如果想要再次打开只需输入 tail -f nohup.out。此外，scripts 目录下有一键运行、关闭程序的脚本供使用。
多账号支持：将项目复制多份，分别启动程序，用不同账号扫码登录即可实现同时运行。
特殊指令：用户向机器人发送 #reset 即可清空该用户的上下文记忆。

Docker部署

前提条件：需要安装好 docker 及 docker-compose，安装成功的表现是执行 docker -v 和 docker-compose version (或 docker compose version) 可以查看到版本号，可前往 docker官网 进行下载。
步骤：
1.下载 docker-compose.yml 文件：

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 所在目录下执行以下命令启动容器：

sudo docker compose up -d

注意：如果 docker-compose 是 1.X 版本 则需要执行 sudo docker-compose up -d 来启动容器。
运行 sudo docker ps 能查看到 NAMES 为 chatgpt-on-wechat 的容器即表示运行成功。
3.查看容器运行日志：

sudo docker logs -f chatgpt-on-wechat

扫描日志中的二维码即可完成登录。
4.插件使用：
如果需要在docker容器中修改插件配置，可通过挂载的方式完成，将 插件配置文件 重命名为 config.json，放置于 docker-compose.yml 相同目录下，并在 docker-compose.yml 中的 chatgpt-on-wechat 部分下添加 volumes 映射：

volumes:
- ./config.json:/app/plugins/config.json

Railway部署

Railway 每月提供5刀和最多500小时的免费额度。 (07.11更新: 目前大部分账号已无法免费部署)
步骤：

1. 进入 Railway。
2. 点击 Deploy Now 按钮。
3. 设置环境变量来重载程序运行的参数，例如open_ai_api_key, character_desc。

一键部署：
https://railway.com/template/qApznZ?referralCode=RC3znh