本文章将介绍matrix-chatgpt-bot的docker部署和使用方法
matrix-chatgpt-bot项目github地址:https://github.com/matrixgpt/matrix-chatgpt-bot

项目介绍

通过任何 Matrix 客户端与 ChatGPT 对话!
使用 waylaidwanderer/node-chatgpt-api 访问官方 ChatGPT API 的 Matrix 机器人。

(引用自该项目github页面)

准备工作

  1. 准备好一个chatgpt的API。
  2. 在matrix上创建一个要给机器人使用的账号。

通过docker部署

拉取项目

从该项目的github界面手动下载或使用git clone语句下载

git clone https://github.com/matrixgpt/matrix-chatgpt-bot.git

配置配置文件

首先进入项目文件目录(以下为默认git clone路径,需要时自行更改路径)

cd matrix-chatgpt-bot/

然后复制默认配置文件(.env.example)成一个新文件(.env)

cp .env.example .env

按照提示编辑新创建的配置文件(.env),配置文件中有详细的备注,在此不再赘述。
需要特别说明的是,因为首次登陆账户的时候不知道MATRIX_ACCESS_TOKEN,所以在首次运行时此项留空,
此时与账号登陆有关的内容必须填写的是MATRIX_BOT_USERNAMEMATRIX_BOT_PASSWORD

首次运行获取MATRIX_ACCESS_TOKEN

完成上述的配置文件填写后,我们需要首次运行来获取token
使用最新的稳定版本(已测试)

docker run -it -v storage:/storage --env-file=./.env --name matrix-chatgpt-bot ghcr.io/matrixgpt/matrix-chatgpt-bot:latest

或者从最新的不稳定版本在本地构建(只有在有充分理由的情况下才这样做)

docker build . -t matrix-chatgpt-bot
docker run -it -v storage:/storage --env-file=./.env --name matrix-chatgpt-bot matrix-chatgpt-bot

注意:如果上面的命令中没有 -it 标志,您将无法使用 Ctrl-C 停止容器
注意:为了查看控制台的输出,您需要运行docker logs matrix-chatgpt-bot

完成上述步骤后,应当可以在日志中看见生成的MATRIX_ACCESS_TOKEN,将此信息填入配置文件并清空先前已经填写的MATRIX_BOT_PASSWORD(也可以用#注释掉)

删除之前创建的容器,并使用和先前步骤同样的语句再次根据.env创建容器:

docker run -it -v storage:/storage --env-file=./.env --name matrix-chatgpt-bot ghcr.io/matrixgpt/matrix-chatgpt-bot:latest

到此为止,如果顺利的话,机器人已经可以使用了

使用注意事项

  • 此机器人经测试可以在端到端加密的服务器上使用
  • 邀请机器人账号进频道或直接开始聊天即可使用
  • 根据你的设置,你可能需要提示词来触发回复