README.md

• 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 such as Leed or Kriss Feed.

It is at the same time lightweight, easy to work with, powerful and customizable.

It is a multi-user application with an anonymous reading mode. It supports PubSubHubbub for instant notifications from compatible Web sites. There is an API for (mobile) clients, and a Command-Line Interface. Finally, it supports extensions for further tuning.

• Official website: https://freshrss.org
• Demo: https://demo.freshrss.org/
• License: GNU AGPL 3

Releases

See the list of releases.

About branches

• Use the master branch if you need a stable version.
• For those willing to help testing or developing the latest features, the dev branch is waiting for you!

Disclaimer

This application was developed to fulfil personal needs primarily, and comes with absolutely no warranty. Feature requests, bug reports, and other contributions are welcome. The best way is to open an issue on GitHub. We are a friendly community.

Requirements

• 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.3.8+ (PHP 5.4+ recommended, and PHP 5.5+ for performance, and PHP 7 for even higher performance)
  • Required extensions: cURL, DOM, XML, session, ctype, and PDO_MySQL or PDO_SQLite or PDO_PGSQL
  • Recommended extensions: JSON, GMP (for API access on platforms < 64 bits), IDN (for Internationalized Domain Names), mbstring and/or iconv (for charset conversion), ZIP (for import/export), zlib (for compressed feeds)
• MySQL 5.5.3+ (recommended), or SQLite 3.7.4+, or PostgreSQL 9.2+
• A recent browser like Firefox / IceCat, Internet Explorer 11 / Edge, Chromium / Chrome, Opera, Safari.
  • Works on mobile

Documentation

• https://freshrss.github.io/FreshRSS/en/

Installation

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

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

Automated install

• Docker
• 
• 
• YunoHost

Example of full installation on Linux Debian/Ubuntu

# If you use an Apache Web server (otherwise you need another Web server)
sudo apt-get install apache2
sudo a2enmod headers expires rewrite ssl	#Apache modules

# For Ubuntu <= 15.10, Debian <= 8 Jessie
sudo apt-get install php5 php5-curl php5-gmp php5-intl php5-json php5-sqlite
sudo apt-get install libapache2-mod-php5	#For Apache
sudo apt-get install mysql-server mysql-client php5-mysql	#Optional MySQL database
sudo apt-get install postgresql php5-pgsql	#Optional PostgreSQL database

# For Ubuntu >= 16.04, Debian >= 9 Stretch
sudo apt install php php-curl php-gmp php-intl php-mbstring php-sqlite3 php-xml php-zip
sudo apt install libapache2-mod-php	#For Apache
sudo apt install mysql-server mysql-client php-mysql	#Optional MySQL database
sudo apt install postgresql php-pgsql	#Optional PostgreSQL database

# Restart Web server
sudo service apache2 restart

# For FreshRSS itself (git is optional if you manually download the installation files)
cd /usr/share/
sudo apt-get install git
sudo git clone https://github.com/FreshRSS/FreshRSS.git
cd FreshRSS

# If you want to use the development version of FreshRSS
sudo git checkout -b dev origin/dev

# Set the rights so that your Web server can access the files
sudo chown -R :www-data . && sudo chmod -R g+r . && sudo chmod -R g+w ./data/
# If you would like to allow updates from the Web interface
sudo chmod -R g+w .

# Publish FreshRSS in your public HTML directory
sudo ln -s /usr/share/FreshRSS/p /var/www/html/FreshRSS
# Navigate to http://example.net/FreshRSS to complete the installation
# (If you do it from localhost, you may have to adjust the setting of your public address later)
# or use the Command-Line Interface

# Update to a newer version of FreshRSS with git
cd /usr/share/FreshRSS
sudo git pull
sudo chown -R :www-data . && sudo chmod -R g+r . && sudo chmod -R g+w ./data/

See more commands and git commands in the Command-Line Interface documentation.

Access control

It is needed for the multi-user mode to limit access to FreshRSS. You can:

• use form authentication (needs JavaScript, and PHP 5.5+ recommended)
• use HTTP authentication supported by your web server
  • See Apache documentation
    • In that case, create a ./p/i/.htaccess file with a matching .htpasswd file.

Automatic feed update

• You can add a Cron job to launch the update script. Check the Cron documentation related to your distribution (Debian/Ubuntu, Red Hat/Fedora, Slackware, Gentoo, Arch Linux…). It is a good idea to use the Web server user. For instance, if you want to run the script every hour:

9 * * * * php /usr/share/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1

Example on Debian / Ubuntu

Create /etc/cron.d/FreshRSS with:

6,36 * * * * www-data php -f /usr/share/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1

Advices

• For a better security, expose only the ./p/ folder on 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 application folder. If you want to customize your installation, every thing happens here.
• 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.

Backup

• You need to keep ./data/config.php, and ./data/users/*/config.php files
• You can export your feed list in OPML format either from the Web interface, or from the Command-Line Interface
• To save articles, you can use phpMyAdmin or MySQL tools:

mysqldump --skip-comments --disable-keys --user=<db_user> --password --host <db_host> --result-file=freshrss.dump.sql --databases <freshrss_db>

Extensions

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

Included libraries

• SimplePie
• MINZ
• php-http-304
• jQuery
• lib_opml
• jQuery Plugin Sticky-Kit
• keyboard_shortcuts
• flotr2

Only for some options

• bcrypt.js
• phpQuery

If native functions are not available

• Services_JSON
• password_compat

Compatible clients

Any client supporting a Google Reader-like API. Selection:

• Android
  • News+ with News+ Google Reader extension (Closed source)
  • FeedMe 3.5.3+ (Closed source)
  • EasyRSS (Open source, F-Droid)
• GNU/Linux
  • FeedReader 2.0+ (Open source)