summaryrefslogtreecommitdiff
path: root/README
blob: 30cd56226c19187189d7c50c226564d076093cb0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
Un simple agrégateur de flux rss relativement léger et rapide par rapport aux
mastodontes que sont RSSLounge et TinyTinyRSS

@name FreshRSS
@author Marien Fressinaud <dev@marienfressinaud.fr>
@version 0.2.0
@date 2013-04-17
@license AGPL3

DISCLAIMER
==========
Cette application a été développée pour s'adapter à mes besoins personnels.
Je ne garantis en aucun cas la sécurité de celle-ci, ni son bon fonctionnement
sur un autre serveur que le mien. Je m'engage néanmoins à répondre dans la
mesure du possible aux demandes d'évolution si celles-ci me semblent justifiées.
Privilégiez pour cela des demandes sur GitHub
(https://github.com/marienfressinaud/FreshRSS/issues) ou par mail

De plus, je n'ai réellement testé FreshRSS que sous Firefox, il pourrait y
avoir des soucis sur d'autres navigateurs.

PRE-REQUIS
==========
- Serveur Apache (non testé sur aucun autre)
- PHP 5.3 (il me faudrait des retours sur d'autres versions antérieures)
- libxml pour PHP
- cURL
- PDO et MySQL

INSTALLATION
============
	1. Récupérez l'application FreshRSS via la commande git ou en
	   téléchargeant l'archive
	2. Exécutez le script ./build.sh ou en récupérant à la main la librairie
	   Minz (https://github.com/marienfressinaud/MINZ) et en copian la lib
	   dans /lib/minz
	3. Déplacez l'application où vous voulez sur votre serveur (attention,
	   la partie accessible se trouve dans le répertoire `/public`)
	4. Accéder à FreshRSS à travers votre navigateur web et suivez les
	   instructions !
	5. Tout devrait fonctionner :) En cas de problème, n'hésitez pas à me
	   contacter !

SÉCURITÉ ET CONSEILS
====================
	1. Si possible, faites pointer un sous-domaine sur le répertoire
	   `/public`
	2. Le fichier de log peut être utile à lire si vous avez des soucis
	3. Le fichier `/public/index.php` défini les chemins d'accès aux
	   répertoires clés de l'application. Si vous les bougez, tout se passe
	   ici.
	4. Vous pouvez ajouter une tâche CRON sur le script d'actualisation des
	   flux. Il s'agit d'un script PHP à exécuter avec la commande `php`.
	   Par exemple, pour exécuter le script toutes les heures :
	   0 * * * * php /chemin/vers/freshrss/actualize_script.php >/dev/null 2>&1
	   Veuillez cependant vérifier que le fichier PUBLIC_PATH/data/Configuration.array.php
	   soit accessible en lecture / écriture par l'exécuteur du script

CHANGELOG
=========
2013-04-17 changes with FreshRSS 0.2.0
	*) Création d'un installateur
	*) Actualisation des flux en Ajax
	*) Partage par mail et Shaarli ajouté
	*) Export par flux RSS
	*) Possibilité de vider une catégorie
	*) Possibilité de sélectionner les catégories en vue mobile
	*) Les flux peuvent être sortis du flux principal (système de priorité)
	*) Amélioration ajout / import / export des flux
	*) Amélioration actualisation (meilleure gestion des erreurs)
	*) Améliorations CSS
	*) Changements dans la base de données
	*) Màj de la librairie SimplePie
	*) Flux sans auteurs gérés normalement
	*) Correction bugs divers

2013-04-08 changes with FreshRSS 0.1.0
	*) "Première" version