leehui007/docker-ttrss-plugins

🐋 A Dockerized powerful all-in-one Tiny Tiny RSS solution

简体中文说明在这里

Tiny Tiny RSS feed reader as a docker image.

Plugins:

1. Mercury_fulltext: fetches fulltext of articles via self-hosted Mercury Parser API, see HenryQW/mercury-parser-api.
2. Fever plugin: simulates Fever API (please read the configuration here).
3. Feediron: enables modification of article's DOM.
4. ttrss_opencc: Conversion between Traditional and Simplified Chinese via OpenCC for ttrss. Set the OpenCC API Server address in plugin setting page. Demo instances (availability is not guaranteed): https://opencc.henry.wang (Google Cloud) or http://opencc2.henry.wang (Heroku)

Theme: Feedly

Support postgres only for better user experience. mysql support is dropped since tag 3.5_mysql_php5.

Deployment example:

A more detailed guide is available here

Deployment via docker

docker run -it --name ttrss --restart=always \
-e SELF_URL_PATH = [ your URL ]  \
-e DB_HOST = [ your DB address ]  \
-e DB_PORT= [ your DB port ]  \
-e DB_NAME = [ your DB name ]  \
-e DB_USER = [ your DB user ]  \
-e DB_PASS = [ your DB password ]  \
-p [ your port ]:80  \
-d wangqiru/ttrss

List of Docker ENV variables

• ENV SELF_URL_PATH
• ENV DB_HOST
• ENV DB_PORT
• ENV DB_NAME
• ENV DB_USER
• ENV DB_PASS

Deployment via docker-compose

docker-compose.yml contains ttrss and postgres images.

1. Download docker-compose.yml to any directory.
2. Read docker-compose.yml and change the settings (please ensure you change user and password for postgres).
3. Run docker-compose up -d and wait for the deployment to finish.
4. Access ttrss via port 181，with default credentials admin and password, please change them asap.
5. wangqiru/mercury-parser-api and wangqiru/opencc-api-server are optional service containers to support additional features, removing them will not affect TTRSS's basic functionalities.

Recommendation

• For web interface, recommend to use freestyler plugin to customise your own CSS style, especially for non-western languages. Some sample code, please replace it with your own ttrss domain.

• For iOS user, Fever plugin supplies Reeder iOS (THE RSS READER) backend support.

• For Android user, strongly recommend an iPhone.

Author's GitHub

简体中文说明

Tiny Tiny RSS 容器镜像

插件:

1. Mercury: 全文内容提取插件, 需要配合自建 Mercury Parser API, 参见HenryQW/mercury-parser-api.
2. Fever: Fever API 模拟插件（请参照这里进行设置）.
3. Feediron: 提供文章 DOM 操控能力的插件.
4. ttrss_opencc: 使用 OpenCC 为 ttrss 提供中文繁转简的插件. 插件设置中填写 OpenCC API 服务器地址. Demo 服务器(可用性不做任何保证): https://opencc.henry.wang (Google Cloud) or http://opencc2.henry.wang (Heroku)

主题: Feedly

为了更好的用户体验，此镜像仅支持 postgres 数据库. 自 tag 3.5_mysql_php5 起停止支持 mysql.

部署样例:

一份更详细的设置说明（只有英文，中文版有空再写= =）请参见这里

通过 docker 部署

docker run -it --name ttrss --restart=always \
-e SELF_URL_PATH = [ 你的URL地址 ]  \
-e DB_HOST = [ 你的数据库地址 ]  \
-e DB_PORT= [ 你的数据库端口 ]  \
-e DB_NAME = [ 你的数据库名称 ]  \
-e DB_USER = [ 你的数据库用户名 ]  \
-e DB_PASS = [ 你的数据库密码 ]  \
-p [ 容器对外映射端口 ]:80  \
-d wangqiru/ttrss

Docker ENV 环境变量列表

• ENV SELF_URL_PATH
• ENV DB_HOST
• ENV DB_PORT
• ENV DB_NAME
• ENV DB_USER
• ENV DB_PASS

通过 docker-compose 部署

docker-compose.yml 包含了 ttrss 与 postgres 镜像.

1. 下载 docker-compose.yml 至任意目录.
2. 更改 docker-compose.yml 中的设置（务必更改 postgres 用户密码）.
3. 运行 docker-compose up -d 后等待部署完成.
4. 默认通过 181 端口访问 ttrss，默认账户: admin 密码: password，请第一时间更改.
5. wangqiru/mercury-parser-api 及 wangqiru/opencc-api-server 为支持高级功能而加入的可选服务类容器, 删除不会影响 TTRSS 基础功能.

使用建议

• Web 端推荐使用 freestyler 插件 来定制自己的 CSS 风格, 尤其是中文字体. 一些样式代码, 请替换自己的ttrss域名.

• 对于 iOS 用户, Fever 模拟插件提供 Reeder iOS (最强 RSS 阅读器, 没有之一) 后端支持.

• 对于安卓用户, 强烈推荐一部 iPhone.

作者的 GitHub

License