README 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. INSTALLATION
  17. ============
  18. 1. Récupérez l'application FreshRSS via la commande git ou en
  19. téléchargeant l'archive
  20. 2. Déplacez la où vous voulez sur votre serveur (attention, la partie
  21. accessible de l'application se trouve dans le répertoire `/public`)
  22. 3. Modifiez le fichier `/app/configuration/application.ini`
  23. a/ environment = "production" de préférence
  24. b/ use_url_rewriting = true si vous pouvez utiliser
  25. l'url_rewriting, false sinon
  26. c/ sel_application = "un_truc_aléatoire" à vous de mettre ce que
  27. vous voulez, mais ne le changez pas après
  28. d/ base_url = "" le chemin qui mène au répertoire `public` à
  29. partir du répertoire pointé par le nom de
  30. domaine (pas de slash à la fin /!\)
  31. e/ title = "FreshRSS" le nom de l'application
  32. f/ [db] (host, user, password, base) les paramètres pour accéder
  33. à votre base de données mysql
  34. 4. Éxécutez le script MySQL `freshrss.sql` sur la table définie par le
  35. paramètre `base` dans votre base de données (à travers PhpMyAdmin
  36. par exemple)
  37. 5. Vérifiez les droits en lecture / écriture sur le répertoire de log
  38. (`/log`) et celui de cache (`/cache`) qui doivent pouvoir étre lu et
  39. écrit par le serveur, mais pas les autres
  40. 6. Tout devrait fonctionner :) En cas de problème, n'hésitez pas à me
  41. contacter !
  42. SÉCURITÉ ET CONSEILS
  43. ====================
  44. 1. Si possible, faites pointer un sous-domaine sur le répertoire
  45. `/public`
  46. 2. Assurez-vous de ne laisser qu'un droit de lecture par le serveur sur
  47. le fichier `/app/configuration/application.ini` (personne d'autre ne
  48. doit avoir le droit d'y accéder !)
  49. 3. Le fichier de log peut être utile à lire si vous avez des soucis
  50. 4. Le fichier `/public/index.php` définie les chemins d'accès aux
  51. répertoires clés de l'application. Si vous les bougez, tout se passe
  52. ici.