README 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  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. @url http://marienfressinaud.github.io/FreshRSS/
  5. @demo http://marienfressinaud.fr/projets/freshrss/
  6. @author Marien Fressinaud <dev@marienfressinaud.fr>
  7. @version 0.3.0
  8. @date 2013-05-05
  9. @license AGPL3
  10. DISCLAIMER
  11. ==========
  12. Cette application a été développée pour s'adapter à mes besoins personnels.
  13. Je ne garantis en aucun cas la sécurité de celle-ci, ni son bon fonctionnement
  14. sur un autre serveur que le mien. Je m'engage néanmoins à répondre dans la
  15. mesure du possible aux demandes d'évolution si celles-ci me semblent justifiées.
  16. Privilégiez pour cela des demandes sur GitHub
  17. (https://github.com/marienfressinaud/FreshRSS/issues) ou par mail
  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 copiant 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édez à 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/data/Configuration.array.php
  51. soit accessible en lecture / écriture par l'exécuteur du script
  52. CHANGELOG
  53. =========
  54. 2013-05-05 changes with FreshRSS 0.3.0
  55. *) Fallback pour les icônes SVG (utilisation de PNG à la place)
  56. *) Fallback pour les propriétés CSS3 (utilisation de préfixes)
  57. *) Affichage des tags associés aux articles
  58. *) Internationalisation de l'application (gestion des langues anglaise
  59. et française)
  60. *) Gestion des flux protégés par authentification HTTP
  61. *) Mise en cache des favicons
  62. *) Création d'un logo *temporaire*
  63. *) Affichage des vidéos dans les articles
  64. *) Gestion de la recherche et filtre par tags pleinement fonctionnels
  65. *) Création d'un vrai script CRON permettant de mettre tous les flux à
  66. jour
  67. *) Correction bugs divers
  68. 2013-04-17 changes with FreshRSS 0.2.0
  69. *) Création d'un installateur
  70. *) Actualisation des flux en Ajax
  71. *) Partage par mail et Shaarli ajouté
  72. *) Export par flux RSS
  73. *) Possibilité de vider une catégorie
  74. *) Possibilité de sélectionner les catégories en vue mobile
  75. *) Les flux peuvent être sortis du flux principal (système de priorité)
  76. *) Amélioration ajout / import / export des flux
  77. *) Amélioration actualisation (meilleure gestion des erreurs)
  78. *) Améliorations CSS
  79. *) Changements dans la base de données
  80. *) Màj de la librairie SimplePie
  81. *) Flux sans auteurs gérés normalement
  82. *) Correction bugs divers
  83. 2013-04-08 changes with FreshRSS 0.1.0
  84. *) "Première" version