A bit of documentation for the API (#1689)

https://github.com/FreshRSS/FreshRSS/issues/1687
https://github.com/FreshRSS/FreshRSS/issues/443#issuecomment-36666133

2 files changed, 69 insertions, 10 deletions

diff --git a/docs/fr/users/01_Installation.md b/docs/fr/users/01_Installation.md
index 03cdbdd88..dd1bacd00 100644
--- a/docs/fr/users/01_Installation.md
+++ b/docs/fr/users/01_Installation.md
@@ -1,6 +1,6 @@
 # Les pré-requis sur le serveur
 
-FreshRSS est un logiciel développé en PHP reposant sur le modèle client - serveur. C'est-à-dire qu'il vous faudra un serveur web pour en profiter. Ensuite, FreshRSS ne demande pas une configuration très fournie et peut donc, en théorie, tourner sur la plupart des serveurs mutualisés.
+FreshRSS est un logiciel développé en PHP reposant sur le modèle client - serveur. C’est-à-dire qu’il vous faudra un serveur web pour en profiter. Ensuite, FreshRSS ne demande pas une configuration très fournie et peut donc, en théorie, tourner sur la plupart des serveurs mutualisés.
 
 Il est toutefois de votre responsabilité de vérifier que votre hébergement permettra de faire tourner FreshRSS avant de nous taper dessus. Dans le cas où les informations listées ci-dessous ne seraient pas à jour, vous pourrez.
 
@@ -24,13 +24,13 @@ FreshRSS possède trois versions différentes (nous parlons de branches) qui sor
 
 [Téléchargement](https://github.com/FreshRSS/FreshRSS/archive/master.zip)
 
-Cette version sort lorsqu'on considère qu'on a répondu à nos objectifs en terme de nouvelles fonctionnalités. Deux versions peuvent ainsi sortir de façon très rapprochée si les développeurs travaillent bien. En pratique, comme nous nous fixons de nombreux objectifs et que nous travaillons sur notre temps libre, les versions sont souvent assez espacées (plusieurs mois). Son avantage est que le code est particulièrement stable et vous ne devriez pas faire face à de méchants bugs.
+Cette version sort lorsqu’on considère qu’on a répondu à nos objectifs en terme de nouvelles fonctionnalités. Deux versions peuvent ainsi sortir de façon très rapprochée si les développeurs travaillent bien. En pratique, comme nous nous fixons de nombreux objectifs et que nous travaillons sur notre temps libre, les versions sont souvent assez espacées (plusieurs mois). Son avantage est que le code est particulièrement stable et vous ne devriez pas faire face à de méchants bugs.
 
 ## La version de développement
 
 [Téléchargement](https://github.com/FreshRSS/FreshRSS/archive/dev.zip)
 
-Comme son nom l'indique, il s'agit de la version sur laquelle les développeurs travaillent. **Elle est donc instable !** Si vous souhaitez recevoir les améliorations au jour le jour, vous pouvez l'utiliser, mais attention à bien suivre les évolutions sur Github (via [le flux RSS de la branche](https://github.com/FreshRSS/FreshRSS/commits/dev.atom) par exemple). On raconte que les développeurs principaux l'utilisent quotidiennement sans avoir de soucis. Sans doute savent-ils ce qu'ils font…
+Comme son nom l’indique, il s’agit de la version sur laquelle les développeurs travaillent. **Elle est donc instable !** Si vous souhaitez recevoir les améliorations au jour le jour, vous pouvez l’utiliser, mais attention à bien suivre les évolutions sur Github (via [le flux RSS de la branche](https://github.com/FreshRSS/FreshRSS/commits/dev.atom) par exemple). On raconte que les développeurs principaux l’utilisent quotidiennement sans avoir de soucis. Sans doute savent-ils ce qu’ils font…
 
 # Installation sur Apache
 
@@ -48,6 +48,11 @@ Comme son nom l'indique, il s'agit de la version sur laquelle les développeurs
 	ServerName rss.example.net
 	DocumentRoot /path/to/FreshRSS/p/
 
+	<Directory /path/to/FreshRSS/p>
+		AllowOverride AuthConfig FileInfo Indexes Limit
+		Require all granted
+	</Directory>
+
 	ErrorLog ${APACHE_LOG_DIR}/freshrss_error.log
 	CustomLog ${APACHE_LOG_DIR}/freshrss_access.log combined
 
@@ -59,6 +64,11 @@ Comme son nom l'indique, il s'agit de la version sur laquelle les développeurs
 		ServerName rss.example.net
 		DocumentRoot /path/to/FreshRSS/p/
 
+		<Directory /path/to/FreshRSS/p>
+			AllowOverride AuthConfig FileInfo Indexes Limit
+			Require all granted
+		</Directory>
+
 		ErrorLog ${APACHE_LOG_DIR}/freshrss_error.log
 		CustomLog ${APACHE_LOG_DIR}/freshrss_access.log combined
 
@@ -66,6 +76,7 @@ Comme son nom l'indique, il s'agit de la version sur laquelle les développeurs
 			Protocols h2 http/1.1
 		</IfModule>
 
+		# Pour l’API
 		AllowEncodedSlashes On
 
 		SSLEngine on
@@ -79,9 +90,9 @@ Comme son nom l'indique, il s'agit de la version sur laquelle les développeurs
 
 # Installation sur Nginx
 
-Voici un fichier de configuration pour nginx. Il couvre la configuration pour http, https et php.
+Voici un fichier de configuration pour nginx. Il couvre la configuration pour HTTP, HTTPS, et PHP.
 
-_Vous pourrez trouver d'autres fichiers de configuration plus simples mais ces derniers ne seront peut-être pas compatibles avec l'API FreshRSS._
+_Vous pourrez trouver d’autres fichiers de configuration plus simples mais ces derniers ne seront peut-être pas compatibles avec l’API FreshRSS._
 
 ```
 server {
@@ -93,7 +104,7 @@ server {
 	ssl_certificate /etc/nginx/server.crt;
 	ssl_certificate_key /etc/nginx/server.key;
 
-	# l'url ou les urls de votre serveur
+	# l’URL ou les URLs de votre serveur
 	server_name rss.example.net;
 
 	# le répertoire où se trouve le dossier p de FreshRSS
@@ -106,12 +117,12 @@ server {
 	error_log /var/log/nginx/rss.error.log;
 
 	# gestion des fichiers php
-	# il est nécessaire d'utiliser cette expression régulière pour le bon fonctionnement de l'API
+	# il est nécessaire d’utiliser cette expression régulière pour le bon fonctionnement de l’API
 	location ~ ^.+?\.php(/.*)?$ {
 		fastcgi_pass unix:/var/run/php5-fpm.sock;
 		fastcgi_split_path_info ^(.+\.php)(/.*)$;
-		# Par défaut la variable PATH_INFO n'est pas définie sous PHP-FPM
-		# or l'API FreshRSS greader.php en a besoin. Si vous avez un "Bad Request", vérifiez bien cette dernière !
+		# Par défaut la variable PATH_INFO n’est pas définie sous PHP-FPM
+		# or l’API FreshRSS greader.php en a besoin. Si vous avez un “Bad Request”, vérifiez bien cette dernière !
 		fastcgi_param PATH_INFO $fastcgi_path_info;
 		include fastcgi_params;
 		fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
diff --git a/docs/fr/users/06_Mobile_access.md b/docs/fr/users/06_Mobile_access.md
index e1a23c8ba..185c94098 100644
--- a/docs/fr/users/06_Mobile_access.md
+++ b/docs/fr/users/06_Mobile_access.md
@@ -1 +1,49 @@
-**TODO**
+Cette page suppose que vous avez fini [l’installation du serveur](01_Installation.md).
+
+# Activer l’API dans FreshRSS
+
+1. Dans la section “Authentification”, cocher l’option “Autoriser l’accès par API (nécessaire pour les applis mobiles)”.
+2. Dans la section “Profil”, remplir le champ “Mot de passe API (ex. : pour applis mobiles)”.
+	* Chaque utilisateur doit choisir son mot de passe API.
+	* La raison d’être d’un mot de passe API différent du mot de passe principal est que le mot de passe API est potentiellement utilisé de manière moins sûre, mais il permet aussi moins de choses.
+
+
+# Tester
+
+3. Dans la section “Profil”, cliquer sur le lien de la forme `https://rss.example.net/api/` à côté du champ “Mot de passe API”.
+4. Cliquer sur le premier lien “Check full server configuration”:
+	* Si vous obtenez `PASS`, tout est bon : passer à l’étape 6.
+	* Si vous obtenez *Bad Request!* ou *Not Found*, alors votre serveur ne semble pas accepter les slashs `/` qui sont encodés `%2F`. Passer à l’étape 5.
+	* Si vous obtenez un autre message d’erreur, passer à l’étape 5.
+
+
+# Débogger la configuration du serveur
+
+5. Cliquer sur le second lien “Check partial server configuration (without `%2F` support)”:
+	* Si vous obtenez `PASS`, alors le problème est bien que votre serveur n’accepte pas les slashs `/` qui sont encodés `%2F`.
+		* Avec Apache, vérifiez la directive [`AllowEncodedSlashes On`](http://httpd.apache.org/docs/trunk/mod/core.html#allowencodedslashes)
+		* Ou utilisez un client qui n’encode pas les slashs (comme EasyRSS), auquel cas passer à l’étape 6.
+	* Si vous obtenez *Service Unavailable!*, retourner à l’étape 6.
+	* Avec __Apache__:
+		* Si vous obtenez *FAIL getallheaders!*, alors la combinaison de votre version de PHP et de votre serveur Web ne permet pas l’accès à [`getallheaders`](http://php.net/getallheaders)
+			* Utilisez au moins PHP 5.4+, ou utilisez PHP en tant que module plutôt que CGI. Sinon, activer Apache `mod_rewrite` :
+				* Autoriser [`FileInfo` dans `.htaccess`](http://httpd.apache.org/docs/trunk/mod/core.html#allowoverride) : revoir [l’installation du serveur](01_Installation.md).
+				* Activer [`mod_rewrite`](http://httpd.apache.org/docs/trunk/mod/mod_rewrite.html) :
+					* Sur Debian / Ubuntu : `sudo a2enmod rewrite`
+	* Avec __nginx__:
+		* Si vous obtenez *Bad Request!*, vérifier la configuration `PATH_INFO` de votre serveur.
+		* Si vous obtenez *File not found!*, vérifier la configuration `fastcgi_split_path_info` de votre serveur.
+	* Si vous obtenez *FAIL 64-bit or GMP extension!*, alors votre installation PHP soit n’est pas en 64 bit, soit n’a pas l’extension PHP [GMP](http://php.net/gmp) activée.
+		* Le plus simple est d’activer l’extension GMP. Sur Debian / Ubuntu : `sudo apt install php-gmp`
+	* Mettre à jour et retourner à l’étape 3.
+
+
+# Clients compatibles
+
+Tout client supportant une API de type Google Reader. Sélection :
+
+* Android
+	* [News+](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus) avec [News+ Google Reader extension](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus.extension.google_reader) (Propriétaire)
+	* [EasyRSS](https://github.com/Alkarex/EasyRSS) (Libre, F-Droid)
+* Linux
+	* [FeedReader 2.0+](https://jangernert.github.io/FeedReader/) (Libre)