In category: ← Feed Readers

About FreshRSS

Self-hostable RSS feed aggregator.

Github stats:

Commits: 5,508
56,000
589
Latest commit: Feb 12, 2023

Deploy this app to Linode with a free $100 credit!

Languages/Platforms/Technologies:

Lincenses:

AGPL-3.0

More about FreshRSS

Read this document on github.com/FreshRSS/FreshRSS/ to get the correct links and pictures.
Version française

FreshRSS

FreshRSS is a self-hosted RSS feed aggregator.

It is lightweight, easy to work with, powerful, and customizable.

It is a multi-user application with an anonymous reading mode. It supports custom tags. There is an API for (mobile) clients, and a Command-Line Interface.

Thanks to the WebSub standard (formerly PubSubHubbub), FreshRSS is able to receive instant push notifications from compatible sources, such as Mastodon, Friendica, WordPress, Blogger, FeedBurner, etc.

FreshRSS natively supports basic Web scraping, based on XPath, for Web sites not providing any RSS / Atom feed.

Finally, it supports extensions for further tuning.

Feedback and contributions

Feature requests, bug reports, and other contributions are welcome. The best way is to open an issue on GitHub. We are a friendly community.

To facilitate contributions, the following option is available:

Screenshot

FreshRSS screenshot

Disclaimer

FreshRSS comes with absolutely no warranty.

Documentation

User documentation, where you can discover all the possibilities offered by FreshRSS
Administrator documentation for detailed installation and maintenance related tasks
Developer documentation to guide you in the source code of FreshRSS and to help you if you want to contribute
Contributor guidelines for those who want to help improve FreshRSS

Requirements

A recent browser like Firefox / IceCat, Edge, Chromium / Chrome, Opera, Safari.
- Works on mobile (except a few features)
Light server running Linux or Windows
- It even works on Raspberry Pi 1 with response time under a second (tested with 150 feeds, 22k articles)
A web server: Apache2 (recommended), nginx, lighttpd (not tested on others)
PHP 7.2+
- Required extensions: cURL, DOM, JSON, XML, session, ctype, and PDO_MySQL or PDO_SQLite or PDO_PGSQL
- Recommended extensions: GMP (for API access on 32-bit platforms), IDN (for Internationalized Domain Names), mbstring (for Unicode strings), iconv (for charset conversion), ZIP (for import/export), zlib (for compressed feeds)
MySQL 5.5.3+ or MariaDB equivalent, or SQLite 3.7.4+, or PostgreSQL 9.5+

Installation

The latest stable release can be found here. New versions are released every two to three months.

If you want a rolling release with the newest features, or want to help testing or developing the next stable version, you can use the edge branch.

Automated install

Manual install

Get FreshRSS with git or by downloading the archive
Put the application somewhere on your server (expose only the ./p/ folder to the Web)
Add write access to the ./data/ folder for the webserver user
Access FreshRSS with your browser and follow the installation process
- or use the Command-Line Interface
Everything should be working :) If you encounter any problems, feel free to contact us.
Advanced configuration settings can be found in config.default.php and modified in data/config.php.
When using Apache, enable AllowEncodedSlashes for better compatibility with mobile clients.

More detailed information about installation and server configuration can be found in our documentation.

Advice

For better security, expose only the ./p/ folder to the Web.
- Be aware that the ./data/ folder contains all personal data, so it is a bad idea to expose it.
The ./constants.php file defines access to the application folder. If you want to customize your installation, look here first.
If you encounter any problem, logs are accessible from the interface or manually in ./data/users/*/log*.txt files.
- The special folder ./data/users/_/ contains the part of the logs that are shared by all users.

FAQ

The date and time in the right-hand column is the date declared by the feed, not the time at which the article was received by FreshRSS, and it is not used for sorting.
- In particular, when importing a new feed, all of its articles will appear at the top of the feed list regardless of their declared date.