PyBot/README.md
2024-12-25 22:57:42 +08:00

52 lines
2.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 持续更新中 <br>
RSS订阅链接来源https://github.com/zhengjim/Chinese-Security-RSS <br>
使用python-json进行格式化然后使用飞书webhook机器人进行发送 <br>
config.yaml可指定大部分可能需要的参数 <br>
### 项目特色 <br>
- 模块化爬虫获取信息部分、分析对获取的json信息进行筛选分析存储、推送推送至各渠道、网页等各模块均可单独运行。 <br>
- 轻量化默认使用sqlite以及其他常见的各系统自带的库用户仅需配置python环境不会占用过多内存。 <br>
- 简单化配置好config后即可一步运行效率极高。 <br>
### 日志相关
请查看./log文件夹下内容 <br>
### 使用建议: <br>
Linux系统建议下载screen于后台持续运行本脚本。 <br>
debian/ubuntu/kali: `apt install screen` <br>
centos: `yum install screen` <br>
创建新会话:`screen -S 会话名称` <br>
保存并退回到界面:`ctrl+a+d` <br>
重新进入会话:`screen -r 会话名称` <br>
结束对话:进入会话后输入`exit` <br>
### 使用方法: <br>
先下载支持库:`pip install -r requirements.txt` <br>
随后便可直接运行:`python Core.py` <br>
web运行`python ./web/app.py` <br>
随后web网页将会在本地5000端口启动访问即可使用反向代理即可以域名映射到外网 <br>
直接访问web域名即可查看历史推送访问路径/log即可查看程序运行日志/weblog查看flask日志 <br>
### 配置 <br>
首先先在飞书中创建群组然后再创建WebHook机器人 <br>
<center><img src="./imgs/group.jpg" width="50%" alt="群组"/></center><br>
<center><img src="./imgs/add_bot.jpg" width="50%" alt="添加机器人"/></center><br>
随后在配置机器人时可打开签名验证您也可自行选择IP白名单 <br>
<center><img src="./imgs/bot_config.jpg" width="50%" alt="机器人配置"/></center><br>
再之后将配置信息填入config.yaml文件当中 <br>
<center><img src="./imgs/config.jpg" width="50%" alt="配置"/></center><br>
那么现在,您就可以开始运行使用了。 <br>
### Github访问限制配置 <br>
若短时间内请求次数过多可能会被github限制可参考以下配置 <br>
- 对于未经身份验证的请求github 速率限制允许每小时最多 60 个请求 <br>
- 而通过使用基本身份验证的 API 请求,每小时最多可以发出 5,000 个请求 <br>
- https://github.com/settings/tokens/new 创建token时间建议选择无限制。[github-token](./imgs/github-token.png) <br>
`./config/config.yaml`中可配置github_token <br>
### 运行结果 <br>
<center><img src="./imgs/start.jpg" width="50%" alt="飞书运行提示"/></center><br>
<center><img src="./imgs/result.jpg" width="50%" alt="飞书运行展示"/></center><br>
<center><img src="./imgs/run.jpg" width="50%" alt="后端"/></center><br>