A free, self-hostable aggregator…
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Alexandre Alapetite d785ddde2a
New option to automatically mark as read gone articles (#4426)
2 days ago
.github Update all test dependencies (#4419) 1 week ago
Docker Docker Alpine updates (#4420) 1 week ago
app New option to automatically mark as read gone articles (#4426) 2 days ago
cli Custom logo HTML (#4369) 1 month ago
data Custom logo HTML (#4369) 1 month ago
docs Update all test dependencies (#4419) 1 week ago
extensions New core-extensions to allow Docker volumes for third-party extensions (#2837) 2 years ago
lib Better trim base_url (#4423) 6 days ago
p Update all test dependencies (#4419) 1 week ago
tests New search engine (#4378) 4 weeks ago
.dockerignore GitHub Action automatic tests (#3920) 8 months ago
.editorconfig Improved markdownlint (#3918) 8 months ago
.eslintignore GitHub Actions CI optimisation (#3929) 8 months ago
.eslintrc.json New sharing service: Web sharing API (#4271) 3 months ago
.gitattributes export-ignore (#4415) 1 week ago
.gitignore GitHub Action automatic tests (#3920) 8 months ago
.hadolint.yaml Readme 2454-2456 3 years ago
.jshintignore GitHub Actions CI optimisation (#3929) 8 months ago
.jshintrc ESLint upgrade from JSHint (#3906) 8 months ago
.markdownlint.json Fix Docker button, add PikaPods as automated install option (#4351) 2 months ago
.markdownlintignore Allow CssXPath updates with composer (#4368) 1 month ago
.stylelintignore GitHub Actions CI optimisation (#3929) 8 months ago
.stylelintrc.json Align .editorconfig with .stylelintrc for CSS files (#3912) 8 months ago
.typos.toml Update all test dependencies (#4419) 1 week ago
CHANGELOG-old.md Update all test dependencies (#4419) 1 week ago
CHANGELOG.md Update all test dependencies (#4419) 1 week ago
CONTRIBUTING.md Use typographic quotes (#4133) 6 months ago
CREDITS.md README.md - GReader Redate not required for Reeder 5 (#4413) 2 weeks ago
LICENSE.txt Update chmod for LICENSE.txt 4 years ago
Makefile Update all test dependencies (#4419) 1 week ago
README.fr.md Fix Minz link (#4414) 1 week ago
README.md Fix Minz link (#4414) 1 week ago
SECURITY.md Create SECURITY.md (#3702) 11 months ago
composer.json Update all test dependencies (#4419) 1 week ago
composer.lock Minor dev composer update (#4424) 6 days ago
config-user.default.php New option to automatically mark as read gone articles (#4426) 2 days ago
config.default.php Custom logo HTML (#4369) 1 month ago
constants.php Start 1.20.0-dev 5 months ago
force-https.default.txt Always rewrite blogger.com to https (#3088) 2 years ago
index.html Config allow robots 7 years ago
index.php HTTP Auth : améliorations + changelog 9 years ago
opml.default.xml Default or custom OPML (#2627) 3 years ago
package-lock.json Update all test dependencies (#4419) 1 week ago
package.json Update all test dependencies (#4419) 1 week ago
phpcs.xml Allow CssXPath updates with composer (#4368) 1 month ago
phpstan.neon Update to PHPMailer 6.6.0 with composer (#4329) 1 month ago

README.md

Liberapay donations

FreshRSS

FreshRSS is a self-hosted RSS feed aggregator like Leed or Kriss Feed.

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.

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

FreshRSS logo

Disclaimer

FreshRSS comes with absolutely no warranty.

FreshRSS screenshot

Documentation

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.0+
  • MySQL 5.5.3+ or MariaDB equivalent, or SQLite 3.7.4+, or PostgreSQL 9.5+

Releases

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.

Installation

Automated install

  • Docker
  • YunoHost
  • Cloudron
  • PikaPods

Manual install

  1. Get FreshRSS with git or by downloading the archive
  2. Put the application somewhere on your server (expose only the ./p/ folder to the Web)
  3. Add write access to the ./data/ folder for the webserver user
  4. Access FreshRSS with your browser and follow the installation process
  5. Everything should be working :) If you encounter any problems, feel free to contact us.
  6. Advanced configuration settings can be found in config.default.php and modified in data/config.php.
  7. 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.

Extensions

FreshRSS supports further customizations by adding extensions on top of its core functionality. See the repository dedicated to those extensions.

APIs & native apps

FreshRSS supports access from mobile / native apps for Linux, Android, iOS, Windows and macOS, via two distinct APIs: Google Reader API (best), and Fever API (limited features and less efficient).

App Platform Free Software Maintained & Developed API Works offline Fast sync Fetch more in individual views Fetch read articles Favourites Labels Podcasts Manage feeds
News+ with Google Reader extension Android Partially 2015 GReader
FeedMe* Android GReader
RSS Guard Windows, GNU/Linux, macOS, OS/2 GReader
EasyRSS Android GReader Bug
Readrops Android GReader
FocusReader Android GReader
ChristopheHenry Android Work in progress GReader
Fluent Reader Windows, Linux, macOS Fever
FeedReader GNU/Linux GReader
NewsFlash GNU/Linux Fever
NewsFlash GNU/Linux Work in Progress GReader
Newsboat 2.24+ GNU/Linux, macOS, FreeBSD GReader
Vienna RSS macOS GReader
Reeder* iOS, macOS GReader, Fever
Unread iOS Fever
Fiery Feeds iOS Fever
Readkit macOS Fever
Netnewswire iOS, macOS Work in progress GReader

* Install and enable the GReader Redate extension to have the correct publication date for feed articles if you are using Reeder 4 or FeedMe. (No longer required for Reeder 5)

Included libraries

Only for some options or configurations