🐋 Awesome TTRSS

About

Tiny Tiny RSS is an open source RSS feed reader and aggregator written in PHP. 🐋 Awesome TTRSS aims to provide a powerful [Dockerised] all-in-one solution, with enhanced user experience via simplified deployment and a list of curated plugins.

Deployment

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

Deployment via docker

docker run -it --name ttrss --restart=always \
-e SELF_URL_PATH = [ your public 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 [ public port ]:80  \
-d wangqiru/ttrss

Deployment via docker-compose

docker-compose.yml include 4 docker images:

1. TTRSS
2. PostgreSQL
3. Mercury Parser API
4. OpenCC API

Steps

1. Download docker-compose.yml to any directory.
2. Read docker-compose.yml and change the settings (please ensure you have changed the 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.

Supported Environment Variables

• SELF_URL_PATH: the url to your TTRSS instance
• DB_HOST: the address of your database
• DB_PORT: the port of your database
• DB_NAME: the name of your database
• DB_USER: the user of your database
• DB_PASS: the password of your database
• ENABLE_PLUGINS: the plugins you'd like to enable at system level
• SESSION_COOKIE_LIFETIME: the expiry time for your login session cookie in hours, default to 24 hours

Plugins

Mercury Fulltext Extraction

Fetch fulltext of articles via a self-hosted Mercury Parser API. A separate Mercury Parser API is required, the example docker-compose has already included such a server.

Steps

1. Enable mercury-fulltext plugin in preference
2. Enter Mercury Parser API endpoint

Fever API

Provide Fever API simulate.

Plugin is enabled as a system plugin by default.

Steps

1. Enable API in preference
2. Enter a password for Fever in preference
3. In supported RSS readers, use https://[your url]/plugins/fever as the target server address, with your account and the password set in Step 2.
4. The plugin communicates with TTRSS using an unsalted MD5 hash, using https is strongly recommended. Let's Encrypt provides SSL certificates for free.

OpenCC Simp-Trad Chinese Conversion

Conversion between Traditional and Simplified Chinese via OpenCC , a separate OpenCC API Server is required. the example docker-compose has already included such a server.

Steps

1. Enable opencc plugin in preference
2. Enter OpenCC API endpoint

Demo instances, availability is not guaranteed: https://opencc.henry.wang or http://opencc2.henry.wang.

FeedReader API

Provide FeedReader API support.

System plugin, enabled by adding api_feedreader to the environment variable ENABLE_PLUGINS.

Refer to FeedReader API for more details.

News+ API

Provide a faster two-way synchronization for Android App News+ and iOS App Fiery Feeds with TTRSS.

System plugin, enabled by adding api_newsplus to the environment variable ENABLE_PLUGINS.

Refer to News+ API for more details.

Feediron

Provide the ability to manipulate article DOMs.

Refer to Feediron for more details.

Themes

Feedly

RSSHub

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 Android user, the integrated Fever plugin supplies News+ backend support.
• For Linux user, the integrated FeedReader API supplies FeedReader backend support.

Support and Help

Open an issue via GitHub issue, I will try to respond ASAP.

License

MIT