Skip to content

Repository files navigation

FeedReader

FeedReader: A Self-hosted RSS Feed Aggregator Service

FeedReader offers a sleek solution for aggregating RSS and ATOM feeds. Designed for those who prefer self-hosted services, it features a minimalistic web UI and supports the Fever API, making it compatible with mainstream RSS clients.

Screenshots

Web UI

The server comes with a built-in, minimal web UI for easy feed management.

Web UI

Fever API Support

FeedReader supports the Fever API, enabling integration with various RSS client apps.

Fever API

Features

  • Minimalist Implementation: Supports both RSS and ATOM feeds, with OPML import/export functionality.
  • Fever API Integration: Compatible with popular RSS client apps through built-in Fever API support.

Installation

To install FeedReader, run the following commands in your terminal:

curl -L https://github.com/lsongdev/feedreader/releases/download/<tag>/reader-linux-$(uname -m) -o /usr/local/bin/feedreader
chmod +x /usr/local/bin/feedreader

Create ~/.feedreader/config.yaml before managing subscriptions. FeedReader has no default credentials; without configured users the public reading endpoints remain available, while management actions are disabled.

title: Reader
listen: 127.0.0.1:8080
users:
  - username: admin
    password: replace-with-a-long-random-password

Use listen: 0.0.0.0:8080 only when the service is protected by a trusted network or reverse proxy. The same username and password are used for HTTP Basic authentication and Fever clients.

Then, create a systemd service file for FeedReader:

[Unit]
Description=FeedReader - A Self-hosted RSS Feed Aggregator Service
Documentation=https://github.com/lsongdev/feedreader
After=network-online.target
Wants=network-online.target systemd-networkd-wait-online.service

[Service]
ExecStart=/usr/local/bin/feedreader

[Install]
WantedBy=multi-user.target

License

FeedReader is released under the MIT License. For more details, see the LICENSE file in the repository.

About

📖 FeedReader - Self-hosted RSS Feed Aggregator Service

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages