zhayujie
1 year ago
1 changed files with 9 additions and 27 deletions
+ 9
- 27
README.md
View File
| @@ -117,7 +117,9 @@ cp config-template.json config.json | |||||
| ## 运行 | ## 运行 | ||||
| 1.如果是开发机 **本地运行**，直接在项目根目录下执行： | |||||
| ### 1.本地运行 | |||||
| 如果是开发机 **本地运行**，直接在项目根目录下执行： | |||||
| ```bash | ```bash | ||||
| python3 app.py | python3 app.py | ||||
| @@ -125,7 +127,9 @@ python3 app.py | |||||
| 终端输出二维码后，使用微信进行扫码，当输出 "Start auto replying" 时表示自动回复程序已经成功运行了（注意：用于登录的微信需要在支付处已完成实名认证）。扫码登录后你的账号就成为机器人了，可以在微信手机端通过配置的关键词触发自动回复 (任意好友发送消息给你，或是自己发消息给好友)，参考[#142](https://github.com/zhayujie/chatgpt-on-wechat/issues/142)。 | 终端输出二维码后，使用微信进行扫码，当输出 "Start auto replying" 时表示自动回复程序已经成功运行了（注意：用于登录的微信需要在支付处已完成实名认证）。扫码登录后你的账号就成为机器人了，可以在微信手机端通过配置的关键词触发自动回复 (任意好友发送消息给你，或是自己发消息给好友)，参考[#142](https://github.com/zhayujie/chatgpt-on-wechat/issues/142)。 | ||||
| 2.如果是 **服务器部署**，则使用nohup命令在后台运行： | |||||
| ### 2.服务器部署 | |||||
| 使用nohup命令在后台运行程序： | |||||
| ```bash | ```bash | ||||
| touch nohup.out # 首次运行需要新建日志文件 | touch nohup.out # 首次运行需要新建日志文件 | ||||
| @@ -133,39 +137,17 @@ nohup python3 app.py & tail -f nohup.out # 在后台运行程序并通 | |||||
| ``` | ``` | ||||
| 扫码登录后程序即可运行于服务器后台，此时可通过 `ctrl+c` 关闭日志，不会影响后台程序的运行。使用 `ps -ef | grep app.py | grep -v grep` 命令可查看运行于后台的进程，如果想要重新启动程序可以先 `kill` 掉对应的进程。日志关闭后如果想要再次打开只需输入 `tail -f nohup.out`。 | 扫码登录后程序即可运行于服务器后台，此时可通过 `ctrl+c` 关闭日志，不会影响后台程序的运行。使用 `ps -ef | grep app.py | grep -v grep` 命令可查看运行于后台的进程，如果想要重新启动程序可以先 `kill` 掉对应的进程。日志关闭后如果想要再次打开只需输入 `tail -f nohup.out`。 | ||||
| > 注：如果 扫码后手机提示登录验证需要等待5s，而终端的二维码再次刷新并提示 `Log in time out, reloading QR code`，此时需参考此 [issue](https://github.com/zhayujie/chatgpt-on-wechat/issues/8) 修改一行代码即可解决。 | |||||
| > **注意：**如果 扫码后手机提示登录验证需要等待5s，而终端的二维码再次刷新并提示 `Log in time out, reloading QR code`，此时需参考此 [issue](https://github.com/zhayujie/chatgpt-on-wechat/issues/8) 修改一行代码即可解决。 | |||||
| > **多账号支持：** 将 项目复制多份，分别启动程序，用不同账号扫码登录即可实现同时运行。 | > **多账号支持：** 将 项目复制多份，分别启动程序，用不同账号扫码登录即可实现同时运行。 | ||||
| > **特殊指令：** 用户向机器人发送 **#清除记忆** 即可清空该用户的上下文记忆。 | > **特殊指令：** 用户向机器人发送 **#清除记忆** 即可清空该用户的上下文记忆。 | ||||
| 3.如果是在docker **容器运行**，可以在`根\docker`目录下： | |||||
| ### 3.Docker部署 | |||||
| 首先，修改Dockerfile.alpine文件里第9行，关于openapi key的配置 | |||||
| ```bash | |||||
| BUILD_OPEN_AI_API_KEY='YOUR OPEN AI KEY HERE' | |||||
| ``` | |||||
| 然后，使用docker-compose启动容器运行： | |||||
| ```bash | |||||
| docker-compose up | |||||
| ``` | |||||
| 参考文档 [Docker部署](https://github.com/zhayujie/chatgpt-on-wechat/wiki/Docker%E9%83%A8%E7%BD%B2) (Contributed by [limccn](https://github.com/limccn))。 | |||||
| 如果您的环境里没有安装docker-compose，可以使用docker build方式构建Image，使用以下命令： | |||||
| ```bash | |||||
| chmod +x build.alpine.sh #构建脚本添加执行权限 | |||||
| ./build.alpine.sh #构建容器，基于alpine | |||||
| ``` | |||||
| 然后，通过已构建完成的Image启动容器，使用以下命令： | |||||
| ```bash | |||||
| docker run -it --name sample-chatgpt-on-wechat zhayujie/chatgpt-on-wechat:1.0.0-alpine | |||||
| ``` | |||||
| 同时，我们在`根\docker\sample-chatgpt-on-wechat`下提供了Makefile脚本，方便使用 | |||||
| ```bash | |||||
| cd sample-chatgpt-on-wechat #进入sample-chatgpt-on-wechat目录 | |||||
| make run_i #使用交互式方式启动容器 | |||||
| ``` | |||||
| ## 常见问题 | ## 常见问题 | ||||
Loading…