README 3.1 KB

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