README 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. Un simple agrégateur de flux rss relativement léger et rapide par rapport aux
  2. mastodontes que sont RSSLounge et TinyTinyRSS
  3. @name FreshRSS
  4. @author Marien Fressinaud <dev@marienfressinaud.fr>
  5. @version 0.2.0
  6. @date 2013-04-17
  7. @license AGPL3
  8. DISCLAIMER
  9. ==========
  10. Cette application a été développée pour s'adapter à mes besoins personnels.
  11. Je ne garantis en aucun cas la sécurité de celle-ci, ni son bon fonctionnement
  12. sur un autre serveur que le mien. Je m'engage néanmoins à répondre dans la
  13. mesure du possible aux demandes d'évolution si celles-ci me semblent justifiées.
  14. Privilégiez pour cela des demandes sur GitHub
  15. (https://github.com/marienfressinaud/FreshRSS/issues) ou par mail
  16. De plus, je n'ai réellement testé FreshRSS que sous Firefox, il pourrait y
  17. avoir des soucis sur d'autres navigateurs.
  18. PRE-REQUIS
  19. ==========
  20. - Serveur Apache (non testé sur aucun autre)
  21. - PHP 5.3 (il me faudrait des retours sur d'autres versions antérieures)
  22. - libxml pour PHP
  23. - cURL
  24. - PDO et MySQL
  25. INSTALLATION
  26. ============
  27. 1. Récupérez l'application FreshRSS via la commande git ou en
  28. téléchargeant l'archive
  29. 2. Exécutez le script ./build.sh ou en récupérant à la main la librairie
  30. Minz (https://github.com/marienfressinaud/MINZ) et en copian la lib
  31. dans /lib/minz
  32. 3. Déplacez l'application où vous voulez sur votre serveur (attention,
  33. la partie accessible se trouve dans le répertoire `/public`)
  34. 4. Accéder à FreshRSS à travers votre navigateur web et suivez les
  35. instructions !
  36. 5. Tout devrait fonctionner :) En cas de problème, n'hésitez pas à me
  37. contacter !
  38. SÉCURITÉ ET CONSEILS
  39. ====================
  40. 1. Si possible, faites pointer un sous-domaine sur le répertoire
  41. `/public`
  42. 2. Le fichier de log peut être utile à lire si vous avez des soucis
  43. 3. Le fichier `/public/index.php` défini les chemins d'accès aux
  44. répertoires clés de l'application. Si vous les bougez, tout se passe
  45. ici.
  46. 4. Vous pouvez ajouter une tâche CRON sur le script d'actualisation des
  47. flux. Il s'agit d'un script PHP à exécuter avec la commande `php`.
  48. Par exemple, pour exécuter le script toutes les heures :
  49. 0 * * * * php /chemin/vers/freshrss/actualize_script.php >/dev/null 2>&1
  50. Veuillez cependant vérifier que le fichier PUBLIC_PATH/data/Configuration.array.php
  51. soit accessible en lecture / écriture par l'exécuteur du script
  52. CHANGELOG
  53. =========
  54. 2013-04-17 changes with FreshRSS 0.2.0
  55. *) Création d'un installateur
  56. *) Actualisation des flux en Ajax
  57. *) Partage par mail et Shaarli ajouté
  58. *) Export par flux RSS
  59. *) Possibilité de vider une catégorie
  60. *) Possibilité de sélectionner les catégories en vue mobile
  61. *) Les flux peuvent être sortis du flux principal (système de priorité)
  62. *) Amélioration ajout / import / export des flux
  63. *) Amélioration actualisation (meilleure gestion des erreurs)
  64. *) Améliorations CSS
  65. *) Changements dans la base de données
  66. *) Màj de la librairie SimplePie
  67. *) Flux sans auteurs gérés normalement
  68. *) Correction bugs divers
  69. 2013-04-08 changes with FreshRSS 0.1.0
  70. *) "Première" version