Skip to content
This repository has been archived by the owner on Sep 17, 2024. It is now read-only.

Commit

Permalink
docs(readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
indes committed Jul 6, 2019
1 parent 7fc9169 commit 48b7163
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ DEMO: https://t.me/rssflowbot

## Features

- 常见的 RSS Bot 该有的功能
- 支持 Telegram 应用内 instant view
- 默认 10 分钟抓取一次
- 支持为 Group 和 Channel 订阅 RSS 消息

## 安装

### Docker 部署

```shell
docker run -d indes/flowerss-bot -k <bot token> -tk <telegraph token 可省略>
docker run -d -v ~/data/flowerss:/var/flowerss indes/flowerss-bot -b <bot token> -t <telegraph token 可省略>
```

### 下载二进制
Expand All @@ -49,11 +49,13 @@ telegraph_toke: xxxx
socks5: 127.0.0.1:1080
update_interval: 10
mysql:
host: 123.123.132.132
host: 127.0.0.1
port: 3306
user: user
password: pwd
database: flowerss
sqlite:
path: ./data.db
```
配置说明:
Expand All @@ -64,7 +66,8 @@ mysql:
| telegraph_token | Telegraph Token, 用于转存原文到 Telegraph | 可忽略(不转存原文到 Telegraph ) |
| update_interval | RSS 源扫描间隔(分钟) | 可忽略(默认 10) |
| socks5 | 用于无法正常 Telegram API 的环境 | 可忽略(能正常连接上 Telegram API 服务器) |
| mysql | 数据库配置 | 可忽略(使用 SQLite ) |
| mysql | MySQL 数据库配置 | 可忽略(使用 SQLite ) |
|sqlite| SQLite 配置 | 可忽略(已配置mysql时,该项失效)|
### Telegraph Token 申请
Expand Down
17 changes: 9 additions & 8 deletions config.yml.sample
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
bot_token: XXX
telegraph_toke: xxxx
socks5: 127.0.0.1:1080
bot_token:
telegraph_toke:
socks5:
update_interval: 10

mysql:
host: 123.123.132.132
port: 3306
user: user
password: pwd
database: flowerss
host:
port:
user:
password:
database:

sqlite:
path: ./data.db

0 comments on commit 48b7163

Please sign in to comment.