mirror of https://github.com/Xtao-Labs/QQ-GitHub-Bot.git synced 2025-01-29 14:39:13 +00:00

Go to file

Ju4tCode e94f1fa601 ✨ rewrite status plugin with template support		2022-05-23 06:01:19 +00:00
.devcontainer	✨ add devcontainer support	2022-05-22 07:23:32 +00:00
.github/workflows	👷 update ci	2022-02-08 14:19:10 +08:00
scripts	🙈 remove useless code	2021-08-25 17:17:20 +08:00
src	✨ rewrite status plugin with template support	2022-05-23 06:01:19 +00:00
tests	✨ rewrite status plugin with template support	2022-05-23 06:01:19 +00:00
.editorconfig	⚗️ add label event and event debug notify	2021-05-21 15:07:04 +08:00
.env	✨ rewrite status plugin with template support	2022-05-23 06:01:19 +00:00
.gitignore	🚸 add default settings	2021-03-11 00:36:55 +08:00
.prettierrc	🚧 add html template	2021-05-14 18:27:09 +08:00
bot.py	⬆️ upgrade dependencies	2022-01-13 16:10:47 +08:00
docker-compose.full.yml	⬆️ upgrade dependencies	2022-01-13 16:10:47 +08:00
docker-compose.yml	🚀 update deploy step and guide (resolve #8 )	2021-09-11 17:47:58 +08:00
Dockerfile	🐳 update dependencies and dockerfile	2021-11-01 14:06:13 +08:00
LICENSE	🎉 Initial commit	2020-09-10 17:07:37 +08:00
poetry.lock	✨ rewrite status plugin with template support	2022-05-23 06:01:19 +00:00
pyproject.toml	✨ rewrite status plugin with template support	2022-05-23 06:01:19 +00:00
README.md	⬆️ upgrade dependencies	2022-01-13 16:10:47 +08:00

README.md

QQ-GitHub-Bot

GitHub Bot for QQ

简介

在 QQ 内订阅, 查看, 处理 GitHub Issue and Pull Request 。

配置

配置项参考 .env 文件，部分选项为可选。

在项目目录下创建 .env.prod 文件以覆盖默认 .env 配置，配置项留空将会从环境变量寻找。

独立部署

独立部署 QQ-GitHub-Bot 前，需要先行部署 go-cqhttp 或其他 OneBot V11 协议实现并配置连接。

配置连接的方法参考 nonebot2 文档: 配置协议端

下载 docker-compose.yml 以及 .env 配置文件至任意空目录，修改 .env 中的如下配置项：

HOST=0.0.0.0
PORT=8080
SUPERUSERS=["机器人管理号"]

# Sentry DSN 网址，如果不使用可以留空
SENTRY_DSN=

# Github OAuth App 配置，留空将功能受限
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_SELF_HOST=

docker-compose.yml 中的配置视情况修改，如无必要请勿修改！

启动

安装 docker-compose 并在目录下执行 docker-compose up -d 即可。