更新文档

This commit is contained in:
johlanse 2022-08-13 22:28:41 +08:00
parent 02138eeaf9
commit 40a192f18b
4 changed files with 34 additions and 4 deletions

View File

@ -8,4 +8,4 @@
* [跳板搭建](./scheme.md) * [跳板搭建](./scheme.md)
* [常见问题](./problem.md) * [常见问题](./problem.md)
* [做出贡献](./contribute.md) * [做出贡献](./contribute.md)
* [加群交流](https://t.me/+VWI88z6d1k45NGJl) * [加群交流](./joinGroup.md)

3
docs/joinGroup.md Normal file
View File

@ -0,0 +1,3 @@
加群链接: https://t.me/+VWI88z6d1k45NGJl
> 加群之前请完整阅读文档提出问题之前请先在github的issue查找并仔细阅读文档后再提出同时建议附上config.yml的配置信息和运行日志。

View File

@ -10,9 +10,27 @@
> 其中pushPlus和钉钉推送相互冲突因为两种推送模式都只能单方面配合定时运行功能使用只能接收消息不能发送消息 > 其中pushPlus和钉钉推送相互冲突因为两种推送模式都只能单方面配合定时运行功能使用只能接收消息不能发送消息
> 在公众号测试号和tg推送以及定时三种只要配置了任意一种程序将自动卡住等待用户指令。 > 在公众号测试号和tg推送以及定时三种只要配置了任意一种程序将自动卡住等待用户指令。
>
> 若您想打开程序就运行请关闭这三项配置当前程序默认开启cron定时,所以新版若不想程序一直等待则关闭cron即可。 > 若您想打开程序就运行请关闭这三项配置当前程序默认开启cron定时,所以新版若不想程序一直等待则关闭cron即可。
> 微信公众号和网页需要公网ip,若没有建议更换其他推送方式或者自行配置内网穿透tg推送需要配置代理或者自己反代tg的api钉钉和pushPlus仅支持单向推送一般配合定时使用
### 定时配置
定时任务和一下所有推送均可配合一起使用cron的语法遵循linux标准cron语法详情可百度自行查询
因为一些不知名的bug,观看视频时可能卡住不加分,所以建议一天运行三次左右定时,同时多次定时之间间隔不要太短
为防止定时任务每天在同一时间触发,可以配置**cron_random_wait**,等待随机时间再运行任务
除此之外,还支持以下语法
+ @yearly:也可以写作@annually表示每年第一天的 0 点。等价于0 0 1 1 *
+ @monthly:表示每月第一天的 0 点。等价于0 0 1 * *
+ @weekly:表示每周第一天的 0 点,注意第一天为周日,即周六结束,周日开始的那个 0 点。等价于0 0 * * 0
+ @daily:也可以写作@midnight表示每天 0 点。等价于0 0 * * *
+ @hourly表示每小时的开始。等价于0 * * * *
+ @every duration: duration为任意时间端例如 1h,1s,1s1h30m2s代表间隔时间段就指向一次
### 微信公众号推送 ### 微信公众号推送
配置config.yml的如下部分 配置config.yml的如下部分
```yaml ```yaml
@ -47,6 +65,7 @@ wechat:
+ 运行程序后在浏览器中访问配置的url,页面会返回``No Signature!``,然后提交配置,若成功则关注公众号尝试运行 + 运行程序后在浏览器中访问配置的url,页面会返回``No Signature!``,然后提交配置,若成功则关注公众号尝试运行
+ docker运行方式参考[linux运行](./linux/index.md) + docker运行方式参考[linux运行](./linux/index.md)
### web推送 ### web推送
> 适用于部署在服务器上或者家里有公网IP的设备上 > 适用于部署在服务器上或者家里有公网IP的设备上
@ -69,6 +88,8 @@ web:
+ 若无法访问首先检查程序运行日志查看有无报错其次查看docker的运行情况端口是否映射正常然后可以通过curl命令检测在宿主机中能否访问然后检查防火墙之类的 + 若无法访问首先检查程序运行日志查看有无报错其次查看docker的运行情况端口是否映射正常然后可以通过curl命令检测在宿主机中能否访问然后检查防火墙之类的
+ 若点击登录之后出现一个小框然后无反应,则说明账户密码错误,请重新配置程序账户密码并重启程序 + 若点击登录之后出现一个小框然后无反应,则说明账户密码错误,请重新配置程序账户密码并重启程序
> 登录的账号密码是在配置文件中配置,不是学习强国的登录账号
### 钉钉推送 ### 钉钉推送
配置config.yml的如下部分,具体使用教程详情参考[钉钉](https://developers.dingtalk.com/document/robots/custom-robot-access?spm=ding_open_doc.document.0.0.7f875e5903iVpC#topic-2026027) 配置config.yml的如下部分,具体使用教程详情参考[钉钉](https://developers.dingtalk.com/document/robots/custom-robot-access?spm=ding_open_doc.document.0.0.7f875e5903iVpC#topic-2026027)
```yaml ```yaml
@ -98,7 +119,13 @@ tg:
enable: false enable: false
chat_id: 0 chat_id: 0
token: "" token: ""
# telegram的代理不配置默认走系统代理
proxy: "" proxy: ""
# 自定义tg的api,可通过cloudflare搭建需自备域名
custom_api: "https://api.telegram.org"
# 白名单id,包括群id或者用户id,若为空则允许所有群所有用户使用若仅用于单人直接配置上面的chat_id就可以
white_list:
- 123
``` ```
### 配置 ### 配置
@ -108,7 +135,8 @@ tg:
3. 在 Tg 中搜索[`@userinfobot`](https://t.me/userinfobot) ,点击`START`,它就会给你发送你的信息,记住 Id 即可,是一串数字。 3. 在 Tg 中搜索[`@userinfobot`](https://t.me/userinfobot) ,点击`START`,它就会给你发送你的信息,记住 Id 即可,是一串数字。
4. 跟你创建的 bot 会话,点击`START`,或者发送`/start` 4. 跟你创建的 bot 会话,点击`START`,或者发送`/start`
5. 将第 2 步获取的 token 放在`tokenn`中,第 3 步获取的 Id 放到`chat_id`中,`enable`设置为 true。 5. 将第 2 步获取的 token 放在`tokenn`中,第 3 步获取的 Id 放到`chat_id`中,`enable`设置为 true。
6. 因为众所周知的原因telegram推送需要进行配置代理例如clash的代理配置为```http://127.0.0.1:7890```即可 6. 因为众所周知的原因telegram推送需要进行配置代理例如clash的代理配置为```http://127.0.0.1:7890```即可若通过cf反代的api,,则填写到**custom_api**配置项
7. 若不配置代理的情况下会默认走系统代理white_list建议填写自己的chat_id,为可以使用机器人的白名单,若需要在群组中使用,请相应进行配置
增加 telegram bot 指令支持 增加 telegram bot 指令支持

View File

@ -295,7 +295,6 @@ func sign() gin.HandlerFunc {
if err != nil { if err != nil {
return return
} }
ctx.Writer.WriteHeader(200) ctx.Writer.WriteHeader(200)
data, _ := io.ReadAll(response.Body) data, _ := io.ReadAll(response.Body)
ctx.Writer.Write(data) ctx.Writer.Write(data)