Cette application a été développée pour s’adapter à des besoins personnels et non professionnels. Je ne garantis en aucun cas la sécurité de celle-ci, ni son bon fonctionnement. Je m’engage néanmoins à répondre dans la mesure du possible aux demandes d’évolution si celles-ci me semblent justifiées. Privilégiez pour cela des demandes sur GitHub (https://github.com/marienfressinaud/FreshRSS/issues) ou par mail (dev@marienfressinaud.fr)

Pré-requis

Serveur modeste, par exemple sous Linux ou Windows
- Fonctionne même sur un Raspberry Pi avec des temps de réponse < 1s (testé sur 150 flux, 22k articles, soit 32Mo de données partiellement compressées)
Serveur Web Apache2 ou Nginx (non testé sur les autres)
PHP 5.2.1+ (PHP 5.3.7+ recommandé)
- Requis : PDO_MySQL, cURL, LibXML, PCRE, ctype
- Recommandés : JSON, zlib, mbstring, iconv, Zip
MySQL 5.0.3+ (ou SQLite 3.7.4+ à venir)
Un navigateur Web récent tel Firefox 4+, Chrome, Opera, Safari, Internet Explorer 9+
- Fonctionne aussi sur mobile

Installation

Récupérez l’application FreshRSS via la commande git ou en téléchargeant l’archive
Placez l’application sur votre serveur (la partie à exposer au Web est le répertoire ./p/)
Le serveur Web doit avoir les droits d’écriture dans le répertoire ./data/
Accédez à FreshRSS à travers votre navigateur Web et suivez les instructions d’installation
Tout devrait fonctionner :) En cas de problème, n’hésitez pas à me contacter.

Contrôle d’accès

Il est requis pour le mode multi-utilisateur, et recommandé dans tous les cas, de limiter l’accès à votre FreshRSS. Au choix :

En utilisant l’identification par formulaire (requiert JavaScript, et PHP 5.3.7+ recommandé – fonctionne avec certaines versions de PHP 5.3.3+)
En utilisant l’identification par Mozilla Persona incluse dans FreshRSS
En utilisant un contrôle d’accès HTTP défini par votre serveur Web
- Voir par exemple la documentation d’Apache sur l’authentification
  - Créer dans ce cas un fichier ./p/i/.htaccess avec un fichier .htpasswd correspondant.

Rafraîchissement automatique des flux

Vous pouvez ajouter une tâche Cron lançant régulièrement le script d’actualisation automatique des flux. Consultez la documentation de Cron de votre système d’exploitation (Debian/Ubuntu, Red Hat/Fedora, Slackware, Gentoo, Arch Linux…). C’est une bonne idée d’utiliser le même utilisateur que votre serveur Web (souvent “www-data”). Par exemple, pour exécuter le script toutes les heures :

7 * * * * php /chemin/vers/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1

Conseils

Pour une meilleure sécurité, faites en sorte que seul le répertoire ./p/ soit accessible depuis le Web, par exemple en faisant pointer un sous-domaine sur le répertoire ./p/.
- En particulier, les données personnelles se trouvent dans le répertoire ./data/.
Le fichier ./constants.php définit les chemins d’accès aux répertoires clés de l’application. Si vous les bougez, tout se passe ici.
En cas de problème, les logs peuvent être utile à lire, soit depuis l’interface de FreshRSS, soit manuellement depuis ./data/log/*.log.

Sauvegarde

Il faut conserver vos fichiers ./data/config.php ainsi que ./data/*_user.php et éventuellement ./data/persona/
Vous pouvez exporter votre liste de flux depuis FreshRSS au format OPML
Pour sauvegarder les articles eux-même, vous pouvez utiliser phpMyAdmin ou les outils de MySQL :

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

Bibliothèques incluses

Uniquement pour certaines options

Si les fonctions natives ne sont pas disponibles

Languages

PHP 79.9%

CSS 10.6%

HTML 6.9%

JavaScript 2.3%

Shell 0.1%

Other 0.1%

README.md Unescape Escape

FreshRSS

Disclaimer