README 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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 <contact@marienfressinaud.fr>
  5. @version 1.0 alpha
  6. @date 2012-10-28
  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)
  16. De plus, je n'ai réellement testé FreshRSS que sous Firefox 16, il pourrait y
  17. avoir des soucis sur d'autres navigateurs.
  18. PRE-REQUIS
  19. ==========
  20. - Serveur Apache (pas testé sur aucun autre)
  21. - PHP 5.3 (il me faudrait des retours sur d'autres versions)
  22. - libxml pour PHP
  23. - 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. Déplacez la où vous voulez sur votre serveur (attention, la partie
  29. accessible de l'application se trouve dans le répertoire `/public`)
  30. 3. Modifiez le fichier `/app/configuration/application.ini`
  31. a/ environment = "production" de préférence
  32. b/ use_url_rewriting = true si vous pouvez utiliser
  33. l'url_rewriting, false sinon
  34. c/ sel_application = "un_truc_aléatoire" à vous de mettre ce que
  35. vous voulez, mais ne le changez pas après
  36. d/ base_url = "" le chemin qui mène au répertoire `public` à
  37. partir du répertoire pointé par le nom de
  38. domaine (pas de slash à la fin /!\)
  39. e/ title = "FreshRSS" le nom de l'application
  40. f/ [db] (host, user, password, base) les paramètres pour accéder
  41. à votre base de données mysql
  42. 4. Éxécutez le script MySQL `freshrss.sql` sur la table définie par le
  43. paramètre `base` dans votre base de données (à travers PhpMyAdmin
  44. par exemple)
  45. 5. Vérifiez les droits en lecture / écriture sur le répertoire de log
  46. (`/log`) et celui de cache (`/cache`) qui doivent pouvoir étre lu et
  47. écrit par le serveur, mais pas les autres
  48. 6. Tout devrait fonctionner :) En cas de problème, n'hésitez pas à me
  49. contacter !
  50. SÉCURITÉ ET CONSEILS
  51. ====================
  52. 1. Si possible, faites pointer un sous-domaine sur le répertoire
  53. `/public`
  54. 2. Assurez-vous de ne laisser qu'un droit de lecture par le serveur sur
  55. le fichier `/app/configuration/application.ini` (personne d'autre ne
  56. doit avoir le droit d'y accéder !)
  57. 3. Le fichier de log peut être utile à lire si vous avez des soucis
  58. 4. Le fichier `/public/index.php` définie les chemins d'accès aux
  59. répertoires clés de l'application. Si vous les bougez, tout se passe
  60. ici.
  61. 5. Vous pouvez ajouter une tâche CRON sur l'url de mise à jour des flux
  62. (clic droit sur "Mettre les flux à jour" puis "Copier l'adresse du
  63. lien") pour que celle-ci se fasse de manière transparente