No Description

Marien Fressinaud 9d87f2f0aa Export is fully implemented 12 years ago
app 9d87f2f0aa Export is fully implemented 12 years ago
data 27764b3635 Improve sharing 12 years ago
lib 9d87f2f0aa Export is fully implemented 12 years ago
p c8aa451c76 Minz: remove url_rewriting 12 years ago
CHANGELOG 7bbd6133af API: Changelog 12 years ago
LICENSE 61b87b1474 Modif du fichier README + l'application s'appellera désormais FreshRSS 13 years ago
README.md 166009f362 Sharing: Compatibility 0.7 12 years ago
constants.php fd829d7567 Constant to enable PHP compression 12 years ago
index.html 67531f796f HTTP Auth : améliorations + changelog 12 years ago
index.php 67531f796f HTTP Auth : améliorations + changelog 12 years ago

README.md

FreshRSS

FreshRSS est un agrégateur de flux RSS à auto-héberger à l’image de Leed ou de Kriss Feed.

Il se veut léger et facile à prendre en main tout en étant un outil puissant et paramétrable.

Il permet de gérer plusieurs utilisateurs, et dispose d’un mode de lecture anonyme.

Logo de FreshRSS

Disclaimer

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é)
  • 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

  1. Récupérez l’application FreshRSS via la commande git ou en téléchargeant l’archive
  2. Placez l’application sur votre serveur (la partie à exposer au Web est le répertoire ./p/)
  3. Le serveur Web doit avoir les droits d’écriture dans le répertoire ./data/
  4. Accédez à FreshRSS à travers votre navigateur Web et suivez les instructions d’installation
  5. 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

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