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. Une démo est disponible sur http://marienfressinaud.fr/projets/freshrss/
  4. @name FreshRSS
  5. @author Marien Fressinaud <dev@marienfressinaud.fr>
  6. @version 0.3.0
  7. @date 2013-05-05
  8. @license AGPL3
  9. DISCLAIMER
  10. ==========
  11. Cette application a été développée pour s'adapter à mes besoins personnels.
  12. Je ne garantis en aucun cas la sécurité de celle-ci, ni son bon fonctionnement
  13. sur un autre serveur que le mien. Je m'engage néanmoins à répondre dans la
  14. mesure du possible aux demandes d'évolution si celles-ci me semblent justifiées.
  15. Privilégiez pour cela des demandes sur GitHub
  16. (https://github.com/marienfressinaud/FreshRSS/issues) ou par mail
  17. PRE-REQUIS
  18. ==========
  19. - Serveur Apache (non testé sur aucun autre)
  20. - PHP 5.3 (il me faudrait des retours sur d'autres versions antérieures)
  21. - libxml pour PHP
  22. - cURL
  23. - PDO et MySQL
  24. INSTALLATION
  25. ============
  26. 1. Récupérez l'application FreshRSS via la commande git ou en
  27. téléchargeant l'archive
  28. 2. Exécutez le script ./build.sh ou en récupérant à la main la librairie
  29. Minz (https://github.com/marienfressinaud/MINZ) et en copiant la lib
  30. dans ./lib/minz
  31. 3. Déplacez l'application où vous voulez sur votre serveur (attention,
  32. la partie accessible se trouve dans le répertoire `./public`)
  33. 4. Accédez à FreshRSS à travers votre navigateur web et suivez les
  34. instructions
  35. 5. Tout devrait fonctionner :) En cas de problème, n'hésitez pas à me
  36. contacter.
  37. SÉCURITÉ ET CONSEILS
  38. ====================
  39. 1. Si possible, faites pointer un sous-domaine sur le répertoire
  40. `./public`
  41. 2. Le fichier de log peut être utile à lire si vous avez des soucis
  42. 3. Le fichier `./public/index.php` défini les chemins d'accès aux
  43. répertoires clés de l'application. Si vous les bougez, tout se passe
  44. ici.
  45. 4. Vous pouvez ajouter une tâche CRON sur le script d'actualisation des
  46. flux. Il s'agit d'un script PHP à exécuter avec la commande `php`.
  47. Par exemple, pour exécuter le script toutes les heures :
  48. 0 * * * * php /chemin/vers/freshrss/actualize_script.php >/dev/null 2>&1
  49. Veuillez cependant vérifier que le fichier ./public/data/Configuration.array.php
  50. soit accessible en lecture / écriture par l'exécuteur du script
  51. CHANGELOG
  52. =========
  53. 2013-05-05 changes with FreshRSS 0.3.0
  54. *) Fallback pour les icônes SVG (utilisation de PNG à la place)
  55. *) Fallback pour les propriétés CSS3 (utilisation de préfixes)
  56. *) Affichage des tags associés aux articles
  57. *) Internationalisation de l'application (gestion des langues anglaise
  58. et française)
  59. *) Gestion des flux protégés par authentification HTTP
  60. *) Mise en cache des favicons
  61. *) Création d'un logo *temporaire*
  62. *) Affichage des vidéos dans les articles
  63. *) Gestion de la recherche et filtre par tags pleinement fonctionnels
  64. *) Création d'un vrai script CRON permettant de mettre tous les flux à
  65. jour
  66. *) Correction bugs divers
  67. 2013-04-17 changes with FreshRSS 0.2.0
  68. *) Création d'un installateur
  69. *) Actualisation des flux en Ajax
  70. *) Partage par mail et Shaarli ajouté
  71. *) Export par flux RSS
  72. *) Possibilité de vider une catégorie
  73. *) Possibilité de sélectionner les catégories en vue mobile
  74. *) Les flux peuvent être sortis du flux principal (système de priorité)
  75. *) Amélioration ajout / import / export des flux
  76. *) Amélioration actualisation (meilleure gestion des erreurs)
  77. *) Améliorations CSS
  78. *) Changements dans la base de données
  79. *) Màj de la librairie SimplePie
  80. *) Flux sans auteurs gérés normalement
  81. *) Correction bugs divers
  82. 2013-04-08 changes with FreshRSS 0.1.0
  83. *) "Première" version