Skip to content

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

License

Notifications You must be signed in to change notification settings

yefoenix/docker-ttrss-plugins

 
 

Repository files navigation

Docker Pulls Docker Stars

Docker Automated build Docker Build Status

FOSSA Status

简体中文说明在这里

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 API: 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)
  5. FeedReader API: FeedReader API support. Enable by adding 'api_feedreader' to ENABLE_PLUGINS env.

Theme

  1. Feedly
  2. RSSHub

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 forthebadge

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
  • ENV ENABLE_PLUGINS

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

  • RSSHub is an interesting place for discovering RSS feeds.
  • For iOS and macOS user, the integrated Fever plugin supplies Reeder 4 backend support.
  • For Linux user,the integrated FeedReader API supplies FeedReader backend support.
  • For Android user, strongly recommend an iPhone.

Tiny Tiny RSS 容器镜像

插件

  1. Mercury:全文内容提取插件,需要配合自建 Mercury Parser API,参见HenryQW/mercury-parser-api
  2. Fever API: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)
  5. FeedReader API:提供 FeedReader API 支持。将 'api_feedreader' 添加到 ENABLE_PLUGINS 环境变量。

主题

  1. Feedly
  2. RSSHub

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

部署样例

一份更详细的设置说明(只有英文,中文版有空再写= =)请参见这里 forthebadge

通过 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
  • ENV ENABLE_PLUGINS

通过 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-apiwangqiru/opencc-api-server 为支持高级功能而加入的可选服务类容器,删除不会影响 TTRSS 基础功能。

使用建议

License

FOSSA Status

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 40.6%
  • Dockerfile 40.0%
  • Shell 19.4%