/wechatbot

A chatbot for wechat.

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

WeChat Bot

一款基于Wechaty的聊天机器人!

Github stars Docker build latest Docker Pulls License

点击加入qq交流群

配置说明

可以通过config.yaml或者环境变量进行配置:

config.yaml env 说明 必须 默认
chatbotProxy CHATBOT_PROXY chatbot请求地址,参考lss233/chatgpt-mirai-qq-bot YES
autoAcceptFriendShip AUTO_ACCEPT_FRIEND_SHIP 自动通过好友请求 NO false
autoAcceptRoomInvite AUTO_ACCEPT_ROOM_INVITE 自动通过群聊邀请 NO false
privateChatTrigger PRIVATE_CHAT_TRIGGER 机器人私聊触发器,空则都触发 NO ""
groupChatTrigger GROUP_CHAT_TRIGGER 机器人群聊触发器,空则@触发,否则:trigger 或 @bot trigger 触发 NO ""
responseQuote RESPONSE_QUOTE 群聊中回复时是否引用触发的消息 NO false

lss233/chatgpt-mirai-qq-bot 项目配置说明

本项目与lss233项目部署在同一服务器时:

  • 为config.cfg增加以下配置:
    [http]
    host = "0.0.0.0"
    port = 8080
    debug = false
  • cd至docker-compose.yaml目录,重启服务:
    docker-compose restart
  • 查看日志,出现以下日志则表示http服务配置成功:
    docker-compose logs -f
    ......
    ... Running on http://0.0.0.0:8080 (CTRL + C to quit)
    ......
    

本项目与lss233项目部署在不同服务器时:

关键需要开放lss233服务的端口访问,以运行在云服务器为例:
  • 为config.cfg增加以下配置:
    [http]
    host = "0.0.0.0"
    port = 8080
    debug = false
  • cd至docker-compose.yaml目录,为docker-compose.yaml增加以下配置:
    version: '3.4'
    services:
      ...
      chatgpt:
        image: lss233/chatgpt-mirai-qq-bot:browser-version
        ports:
          - "8080:8080"  # 关键是增加这个
        ...
  • 重启服务docker-compose服务。
  • 进入云服务商控制台,编辑安全组规则,入站规则增加8080端口。然后可以通过以下命令确认是否配置成功:
    # <server-ip>需要替换为部署机器人bot的服务器IP
    curl -i http://<server-ip>:8080/v1/chat -H 'Content-Type: application/json' -d '{"message":"ping"}'

运行说明

服务器部署

快速启动:

docker run -e CHATBOT_PROXY="<your-proxy>" lcjqyml/wechatbot:latest
# PS: linux服务器可执行此命令直接安装docker:
# sh <(curl -sL https://get.docker.com)
  • <your-proxy> 需要替换为你自己搭建的http服务,例如:
    docker run -e CHATBOT_PROXY="http://127.0.0.1:8080" lcjqyml/wechatbot:latest

或者:

# <path-to-config> 需要替换为配置所在的实际路径
docker run -v /<path-to-config>/config.yaml:/app/config.yaml lcjqyml/wechatbot:latest
  • 配置文件参考config.yaml.example

本项目与lss233项目部署在同一服务器时,执行以下命令:

docker run -e CHATBOT_PROXY="http://chatgpt-qq-chatgpt-1:8080" --network chatgpt-qq_default lcjqyml/wechatbot:latest

PS: 以上chatgpt-qq-chatgpt-1, chatgpt-qq_default由docker-compose启动lss233项目时默认创建。

启动后扫码登陆即可:

  • 扫码的微信号需要进过实名认证,否则会异常。
  • 尽量避免国外登陆或者异地登陆,防止封号。
  • 若二维码不清晰,可将二维码上方的链接copy至浏览器打开扫码。

Railway或者Zeabur托管部署

参考issue lcjqyml#20

关联项目

贡献者名单

欢迎提出新的点子、 Pull Request。

Made with [contrib.rocks](https://contrib.rocks).

支持我们

如果这个项目对你有所帮助,请给我们一颗星。

Stargazers repo roster for @lcjqyml/wechatbot Star history chart for @lcjqyml/wechatbot