Skip to content
master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
app
 
 
cli
 
 
 
 
 
 
 
 
lib
 
 
p
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Build Status 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.

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, Internet Explorer 11 / Edge (minus a few details), 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 5.6+ (PHP 7+ recommended for higher performance)
  • 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 master branch.

Installation

Automated install

  • Docker
  • YunoHost
  • Cloudron

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.

F.A.Q.:

  • 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, and OS X, 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 ✔️ ✔️
Readably Android ✔️✔️ Fever ✔️ ✔️
ChristopheHenry Android ✔️ Work in progress GReader ✔️ ✔️ ✔️
Fluent Reader Windows, Linux, MacOS ✔️ ✔️✔️ Fever ✔️ ✔️ ✔️
FeedReader GNU/Linux ✔️ ✔️ GReader ✔️ ✔️ ✔️ ✔️ ✔️
NewsFlash GNU/Linux ✔️ Work in progress Fever, 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 ✔️ ✔️ ✔️

Included libraries

Only for some options or configurations

You can’t perform that action at this time.