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.
 
 
 
 
 
 
Go to file
Luc SANCHEZ 40aa8b9264
Type hinting and doc (#5063)
2 days ago
.devcontainer Docker uniform timezone behaviour (#4905) 2 months ago
.github Update dev dependencies (#4993) 4 weeks ago
Docker Safer timezone set (#5021) 2 weeks ago
app Type hinting and doc (#5063) 2 days ago
cli API avoid logging passwords (#5001) 4 weeks ago
data Dynamic OPML (#4407) 7 months ago
docs Document cleaning the logs for passwords (#5050) 1 week ago
extensions New core-extensions to allow Docker volumes for third-party extensions (#2837) 3 years ago
lib Type hinting and doc (#5063) 2 days ago
p Remove -x on some files not needing it (#5065) 2 days ago
tests Fix types hint in UserQuery.php (#5045) 1 week ago
.dockerignore GitHub Action automatic tests (#3920) 1 year ago
.editorconfig Dynamic OPML (#4407) 7 months ago
.eslintignore Exclude .git folder (#4824) 3 months ago
.eslintrc.json New sharing service: Web sharing API (#4271) 11 months ago
.gitattributes export-ignore (#4415) 8 months ago
.gitignore i18n en-US (#4519) 6 months ago
.hadolint.yaml Readme 2454-2456 4 years ago
.jshintignore Exclude .git folder (#4824) 3 months ago
.jshintrc ESLint upgrade from JSHint (#3906) 1 year ago
.markdownlint.json Fix Docker button, add PikaPods as automated install option (#4351) 9 months ago
.markdownlintignore tec: Update the lib_opml (#4403) 3 weeks ago
.stylelintignore Exclude .git folder (#4824) 3 months ago
.stylelintrc.json Align .editorconfig with .stylelintrc for CSS files (#3912) 1 year ago
.typos.toml tec: Update the lib_opml (#4403) 3 weeks ago
CHANGELOG-old.md Update all test dependencies (#4419) 8 months ago
CHANGELOG.md Resume 1.21.0-dev 2 months ago
CONTRIBUTING.md fix: Broken link in CONTRIBUTING.md (#4896) 2 months ago
CREDITS.md Update CREDITS.md (#4976) 1 month ago
LICENSE.txt Update chmod for LICENSE.txt 4 years ago
Makefile Update dev dependencies (#4993) 4 weeks ago
README.fr.md tec: Update the lib_opml (#4403) 3 weeks ago
README.md tec: Update the lib_opml (#4403) 3 weeks ago
SECURITY.md Create SECURITY.md (#3702) 2 years ago
composer.json Update dev dependencies (#4993) 4 weeks ago
composer.lock Minor dev depenencies update (#5006) 3 weeks ago
config-user.default.php Added: Dark mode for Origine +Origine compact themes (#4843) 4 weeks ago
config.default.php Update config.default.php (#4434) 7 months ago
constants.php Resume 1.21.0-dev 2 months ago
force-https.default.txt Always rewrite blogger.com to https (#3088) 3 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 Minor dev depenencies update (#5006) 3 weeks ago
package.json Minor dev depenencies update (#5006) 3 weeks ago
phpcs.xml tec: Update the lib_opml (#4403) 3 weeks ago
phpstan.neon tec: Update the lib_opml (#4403) 3 weeks ago

README.md

Liberapay donations

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.

FreshRSS logo

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:

Open in GitHub Codespaces

Screenshot

FreshRSS screenshot

Disclaimer

FreshRSS comes with absolutely no warranty.

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.2+
  • 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

  • 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 ✔️ ✔️ ✔️ ✔️
EasyRSS Android ✔️ ✔️ GReader Bug ✔️
Readrops Android ✔️ ✔️✔️ GReader ✔️ ✔️
Fluent Reader Lite Android, iOS ✔️ ✔️✔️ GReader, Fever ✔️
FocusReader Android ✔️✔️ GReader ✔️ ✔️ ✔️
ChristopheHenry Android ✔️ Work in progress GReader ✔️ ✔️ ✔️
Fluent Reader Windows, Linux, macOS ✔️ ✔️✔️ GReader, Fever ✔️ ✔️
RSS Guard Windows, GNU/Linux, macOS, OS/2 ✔️ ✔️✔️ GReader ✔️ ✔️ ✔️ ✔️ ✔️
NewsFlash GNU/Linux ✔️ ✔️✔️ GReader, Fever ✔️ ✔️ ✔️
Newsboat 2.24+ GNU/Linux, macOS, FreeBSD ✔️ ✔️✔️ GReader ✔️ ✔️ ✔️
Vienna RSS macOS ✔️ ✔️✔️ GReader
Readkit iOS, macOS ✔️✔️ GReader ✔️ ✔️ ✔️ 💲
Reeder* iOS, macOS ✔️✔️ GReader, Fever ✔️ ✔️ ✔️ ✔️
lire iOS, macOS ✔️✔️ GReader
Unread iOS ✔️✔️ Fever ✔️ ✔️
Fiery Feeds iOS ✔️✔️ 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