Sign inSign up

zydou/flowerss

By zydou

•Updated almost 4 years ago

A telegram bot for rss reader.

Image
0

7.0K

zydou/flowerss repository overview

⁠部署

⁠二进制部署

从 Releases⁠ 页面下载对应的版本解压运行即可。

⁠Docker 部署

1.下载配置文件 在项目目录下新建 config.yml 文件

mkdir ~/flowerss &&\
wget -O ~/flowerss/config.yml \
    https://raw.githubusercontent.com/indes/flowerss-bot/master/config.yml.sample

2.修改配置文件

vim ~/flowerss/config.yml

修改配置文件中sqlite路径（如果使用sqlite作为数据库）：

sqlite:
  path: /root/.flowerss/data.db

3.运行

docker run -d -v ~/flowerss:/root/.flowerss indes/flowerss-bot

⁠源码编译部署

git clone https://github.com/indes/flowerss-bot && cd flowerss-bot
make build
./flowerss-bot

⁠配置

根据以下模板，新建 config.yml 文件。

bot_token: XXX
#多个telegraph_token可采用数组格式：
# telegraph_token:
#  - token_1
#  - token_2
telegraph_token: xxxx
user_agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
preview_text: 0
disable_web_page_preview: false
socks5: 127.0.0.1:1080
update_interval: 10
error_threshold: 100
telegram:
  endpoint: https://xxx.com/
mysql:
  host: 127.0.0.1
  port: 3306
  user: user
  password: pwd
  database: flowerss
sqlite:
  path: ./data.db
allowed_users:
  - 123
  - 234

配置说明：

配置项含义是否必填
bot_tokenTelegram Bot Token必填
telegraph_tokenTelegraph Token, 用于转存原文到 Telegraph可忽略（不转存原文到 Telegraph ）
preview_text纯文字预览字数（不借助Telegraph）可忽略（默认0, 0为禁用）
user_agentUser Agent可忽略
disable_web_page_preview是否禁用 web 页面预览可忽略（默认 false, true 为禁用）
update_intervalRSS 源扫描间隔（分钟）可忽略（默认 10）
error_threshold源最大出错次数可忽略（默认 100）
socks5用于无法正常 Telegram API 的环境可忽略（能正常连接上 Telegram API 服务器）
mysqlMySQL 数据库配置可忽略（使用 SQLite ）
sqliteSQLite 配置可忽略（已配置mysql时，该项失效）
telegram.endpoint自定义telegram bot api url可忽略（使用默认api url）
allowed_users允许使用bot的用户telegram id，可忽略，为空时所有用户都能使用bot

命令：

/sub [url] 订阅（url 为可选）
/unsub [url] 取消订阅（url 为可选）
/list 查看当前订阅
/set 设置订阅
/check 检查当前订阅
/setfeedtag [sub id] [tag1] [tag2] 设置订阅标签（最多设置三个Tag，以空格分隔）
/setinterval [interval] [sub id] 设置订阅刷新频率（可设置多个sub id，以空格分隔）
/activeall 开启所有订阅
/pauseall 暂停所有订阅
/import 导入 OPML 文件
/export 导出 OPML 文件
/unsuball 取消所有订阅
/help 帮助
⁠Channel 订阅使用方法
  1. 将 Bot 添加为 Channel 管理员
  2. 发送相关命令给 Bot

Channel 订阅支持的命令：

/sub @ChannelID [url] 订阅
/unsub @ChannelID [url] 取消订阅
/list @ChannelID 查看当前订阅
/check @ChannelID 检查当前订阅
/unsuball @ChannelID 取消所有订阅
/activeall @ChannelID 开启所有订阅
/setfeedtag @ChannelID [sub id] [tag1] [tag2]  设置订阅标签（最多设置三个Tag，以空格分隔）
/import 导入 OPML 文件
/export @ChannelID 导出 OPML 文件
/pauseall @ChannelID 暂停所有订阅

ChannelID 只有设置为 Public Channel 才有。如果是 Private Channel，可以暂时设置为 Public，订阅完成后改为 Private，不影响 Bot 推送消息。

例如要给 t.me/debug 频道订阅 阮一峰的网络日志⁠ RSS 更新：

  1. 将 Bot 添加到 debug 频道管理员列表中
  2. 给 Bot 发送 /sub @debug http://www.ruanyifeng.com/blog/atom.xml 命令
⁠日志中大量类似于 Create telegraph page error: FLOOD_WAIT_7 的提示。

原因是创建 Telegraph 页面请求过快触发了接口限制，可尝试在配置文件中添加多个 Telegraph token。

⁠如何申请 Telegraph Token？

如果要使用应用内即时预览，必须在配置文件中填写 telegraph_token 配置项，Telegraph Token 申请命令如下：

curl https://api.telegra.ph/createAccount?short_name=flowerss&author_name=flowerss&author_url=https://github.com/indes/flowerss-bot

返回的 JSON 中 access_token 字段值即为 Telegraph Token。

⁠如何获取我的telegram id？

可以参考这个网页获取：https://botostore.com/c/getmyid_bot/⁠

Tag summary

Content type

Image

Digest

sha256:d6cb3060c…

Size

8.6 MB

Last updated

almost 4 years ago

docker pull zydou/flowerss