add Dockerfile

Dockerfile

@@ -0,0 +1,12 @@
+FROM golang:1.12-alpine as builder
+#ENV CGO_ENABLED=0
+COPY . /rss
+RUN apk add git make gcc libc-dev && \
+    cd /rss && make build
+# Image starts here
+FROM alpine
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
+COPY --from=builder /rss/flowerss-bot /bin/
+VOLUME /root/.flowerss-bot
+WORKDIR /
+ENTRYPOINT ["/bin/flowerss-bot"]

README.md

@@ -5,21 +5,21 @@
 ![GitHub](https://img.shields.io/github/license/indes/flowerss-bot.svg)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Findes%2Fflowerss-bot.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Findes%2Fflowerss-bot?ref=badge_shield)
 
-DEMO: https://t.me/rssflowbot  
-[问题反馈群组](https://t.me/joinchat/FJ-cikd-yN1Bf1SxWbAKjw) 
+DEMO: https://t.me/rssflowbot
+[问题反馈群组](https://t.me/joinchat/FJ-cikd-yN1Bf1SxWbAKjw)
 
 <img src="https://raw.githubusercontent.com/indes/flowerss-bot/master/images/rssflow_demo.gif" width = "300"/>
 
 
-## Features  
+## Features
 
 - 支持 Telegram 应用内 instant view
-- 默认10分钟抓取一次
+- 默认 10 分钟抓取一次
 - 支持为 Group 和 Channel 订阅 RSS 消息
 
 ## 安装
 
-**由于 GoReleaser 不支持 Cgo，如果要使用 SQLite 做为数据库，请下载源码自行编译。**  
+**由于 GoReleaser 不支持 Cgo，如果要使用 SQLite 做为数据库，请下载源码自行编译。**
 
 ### 源码安装
 
@@ -31,9 +31,22 @@ make build
 
 ### 下载二进制
 
-**不支持 SQLite**  
+**不支持 SQLite**
 
-从[Releases](https://github.com/indes/flowerss-bot/releases) 页面下载对应的版本。
+从 [Releases](https://github.com/indes/flowerss-bot/releases) 页面下载对应的版本。
+
+
+### Docker 部署
+
+请首先确保你安装有 docker 和 docker-compose
+```
+git clone https://github.com/indes/flowerss-bot && cd flowerss-bot
+```
+修改 docker-compose.yml 设置为你自己的配置，拷贝`config.yml.sample`到你自己的数据目录并修改对应设置
+```
+docker-compose build
+docker-compose up -d
+```
 
 ## 配置
 
@@ -57,17 +70,17 @@ mysql:
 | 配置项 | 含义 | 必填 |
 | ------ | ------ | ------ |
 | bot_token | Telegram Bot Token | 必填 |
-| telegraph_token | Telegraph Token, 用于转存原文到 Telegraph | 可忽略（不转存原文到Telegraph ） |
-| update_interval | RSS 源扫描间隔（分钟） | 可忽略（默认10） |
+| telegraph_token | Telegraph Token, 用于转存原文到 Telegraph | 可忽略（不转存原文到 Telegraph ） |
+| update_interval | RSS 源扫描间隔（分钟） | 可忽略（默认 10） |
 | socks5 | 用于无法正常 Telegram API 的环境 | 可忽略（能正常连接上 Telegram API 服务器） |
 | mysql | 数据库配置 | 可忽略（使用 SQLite ） |
 
 ## 使用
 
 命令：
 ```shell
-/sub [url] 订阅（url为可选）
-/unsub [url] 取消订阅（url为可选）
+/sub [url] 订阅（url 为可选）
+/unsub [url] 取消订阅（url 为可选）
 /list 查看当前订阅
 /set 设置订阅
 /help 帮助
@@ -77,21 +90,21 @@ mysql:
 1. 将 Bot 添加为 Channel 管理员
 2. 发送相关命令给 Bot
 
-Channel 订阅支持的命令:
+Channel 订阅支持的命令：
 ```
 /sub @ChannelID [url] 订阅
 /unsub @ChannelID [url] 取消订阅
 /list @ChannelID 查看当前订阅
 ```
 
 **ChannelID 只有设置为 Public Channel 才有。如果是 Private Channel，可以暂时设置为 Public，订阅完成后改为 Private，不影响 Bot 推送消息。**
- 
+
 例如要给 t.me/debug 频道订阅 [阮一峰的网络日志](http://www.ruanyifeng.com/blog/atom.xml) RSS 更新：
 1. 将 Bot 添加到 debug 频道管理员列表中
 2. 给 Bot 发送 `/sub @debug http://www.ruanyifeng.com/blog/atom.xml` 命令
 
 ### 问题反馈
-如果你在使用过程中遇到问题，请提交Issue，或者到[问题反馈群组](https://t.me/joinchat/FJ-cikd-yN1Bf1SxWbAKjw) 反馈。
+如果你在使用过程中遇到问题，请提交 Issue，或者到[问题反馈群组](https://t.me/joinchat/FJ-cikd-yN1Bf1SxWbAKjw) 反馈。
 
 ## License
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Findes%2Fflowerss-bot.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Findes%2Fflowerss-bot?ref=badge_large)

config.yml.sample

@@ -0,0 +1,10 @@
+bot_token: XXX
+telegraph_toke: xxxx
+socks5: 127.0.0.1:1080
+update_interval: 10
+mysql:
+  host: 123.123.132.132
+  port: 3306
+  user: user
+  password: pwd
+  database: flowerss

docker-compose.yml

@@ -0,0 +1,20 @@
+version: '3.4'
+
+services:
+  flowerss-bot:
+    build:
+      network: host
+      context: .
+      dockerfile: Dockerfile
+    image: flowerss-bot
+    volumes:
+      - ./conf:/root/.flowerss-bot
+    restart: unless-stopped
+    deploy:
+      replicas: 1
+      resources:
+        limits:
+          cpus: "0.5"
+          memory: 1g
+      restart_policy:
+        condition: on-failure