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.

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

Releases

See the list of releases.

Note on branches

This application is under continuous development! Please use the branch that suits your needs:

Use the master branch if you need a stable version.
For developers and tech savvy persons willing to help testing 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 issues 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.3+ (PHP 5.4+ recommended, and PHP 5.5+ for performance, and PHP 7 for even higher performance)
- Required extensions: DOM, XML, PDO_MySQL or PDO_SQLite or PDO_PGSQL, cURL
- 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 (experimental)
A recent browser like Firefox, Internet Explorer 11 / Edge, Chrome, Opera, Safari.
- Works on mobile

Installation

Get FreshRSS with git or by downloading the archive
Dump the application on your server (expose only the ./p/ folder)
Add write access on ./data/ folder to the webserver user
Access FreshRSS with your browser and follow the installation process
Everything should be working :) If you encounter any problem, feel free to contact me.
Advanced configuration settings can be seen in config.php.

Automated install

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
# Set the rights so that your Web server can access the files
cd FreshRSS
sudo chown -R :www-data .
sudo chmod -R g+r .
sudo chmod -R g+w ./data/
# 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)

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

Access control

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

use form authentication (need JavaScript and PHP 5.3.7+, works with some PHP 5.3.3+)
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’s a good idea to use the Web server user. For example, 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/log/*.log files.

Backup

You need to keep ./data/config.php, and ./data/*_user.php files
You can export your feed list in OPML format from FreshRSS

To save articles, you can use phpMyAdmin or MySQL tools:

mysqldump -u user -p --databases freshrss > freshrss.sql

Included libraries

Only for some options

If native functions are not available

Compatible clients

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

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

README.md 8.2 KB Histórico Raw