A bit of documentation for the API

FreshRSS#1687 FreshRSS#443 (comment)
Alkarex · Nov 11, 2017 · 6d915ba · 6d915ba
1 parent db44b48
commit 6d915ba
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 18 deletions.
diff --git a/docs/en/users/01_Installation.md b/docs/en/users/01_Installation.md
@@ -1,6 +1,6 @@
 # Server requirements
 
-FreshRSS is a web application. This means you'll need a web server to run it. FreshRSS requirements are really low, so it could run on most shared host servers.
+FreshRSS is a web application. This means you’ll need a web server to run it. FreshRSS requirements are really low, so it could run on most shared host servers.
 
 You need to verify that your server can run FreshRSS before installing it. If your server has the proper requirements and FreshRSS does not work, please contact us to find a solution.
 
@@ -35,7 +35,7 @@ As its name suggests, it is the working release for developers. **This release i
 
 # Apache installation
 
-This is an example Apache virtual hosts configuration file. It covers http and https configuration.
+This is an example Apache virtual hosts configuration file. It covers HTTP and HTTPS configuration.
 
 ```
 <VirtualHost *:80>
@@ -69,6 +69,7 @@ This is an example Apache virtual hosts configuration file. It covers http and h
 			Protocols h2 http/1.1
 		</IfModule>
 
+		# For the API
 		AllowEncodedSlashes On
 
 		SSLEngine on
@@ -82,7 +83,7 @@ This is an example Apache virtual hosts configuration file. It covers http and h
 
 # Nginx installation
 
-This is an example nginx configuration file. It covers http, https and php-fpm configuration.
+This is an example nginx configuration file. It covers HTTP, HTTP, and php-fpm configuration.
 
 _You can find simpler config file but they may be incompatible with FreshRSS API._
 
@@ -91,12 +92,12 @@ server {
 	listen 80;
 	listen 443 ssl;
 
-	# https configuration
+	# HTTPS configuration
 	ssl on;
 	ssl_certificate /etc/nginx/server.crt;
 	ssl_certificate_key /etc/nginx/server.key;
 
-	# your server's url(s)
+	# your server’s URL(s)
 	server_name rss.example.net;
 
 	# the folder p of your FreshRSS installation
@@ -114,7 +115,7 @@ server {
 		fastcgi_pass unix:/var/run/php5-fpm.sock;
 		fastcgi_split_path_info ^(.+\.php)(/.*)$;
 		# By default, the variable PATH_INFO is not set under PHP-FPM
-		# But FreshRSS API greader.php need it. If you have a "Bad Request" error, double check this var !
+		# But FreshRSS API greader.php need it. If you have a “Bad Request” error, double check this var!
 		fastcgi_param PATH_INFO $fastcgi_path_info;
 		include fastcgi_params;
 		fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
@@ -126,7 +127,7 @@ server {
 }
 ```
 
-A step-by-step tutorial is available [in french](http://www.pihomeserver.fr/2013/05/08/raspberry-pi-home-server-installer-un-agregateur-de-flux-rss-pour-remplacer-google-reader/).
+A step-by-step tutorial is available [in French](http://www.pihomeserver.fr/2013/05/08/raspberry-pi-home-server-installer-un-agregateur-de-flux-rss-pour-remplacer-google-reader/).
 
 # Security
 

diff --git a/docs/en/users/06_Mobile_access.md b/docs/en/users/06_Mobile_access.md
@@ -1 +1,21 @@
-**TODO**
+# Server configuration
+
+See the [section about server setup](01_Installation.md).
+In particular, for Apache, remember the directive [`AllowEncodedSlashes On`](http://httpd.apache.org/docs/trunk/mod/core.html#allowencodedslashes),
+for the best compatibility with clients (such as News+, but not needed for EasyRSS).
+
+# Enable the API in FreshRSS
+
+
+# Testing
+
+
+# Compatible clients
+
+Any client supporting a Google Reader-like API. Selection:
+
+* Android
+	* [News+](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus) with [News+ Google Reader extension](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus.extension.google_reader) (Closed source)
+	* [EasyRSS](https://github.com/Alkarex/EasyRSS) (Open source, F-Droid)
+* Linux
+	* [FeedReader 2.0+](https://jangernert.github.io/FeedReader/) (Open source)
diff --git 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
 
@@ -66,6 +66,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 +80,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 +94,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 +107,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
@@ -1 +1,21 @@
-**TODO**
+# Configuration du serveur
+
+Voir la [section sur l’installation du serveur](01_Installation.md).
+En particulier, pour Apache, bien penser à la directive [`AllowEncodedSlashes On`](http://httpd.apache.org/docs/trunk/mod/core.html#allowencodedslashes),
+pour une compatibilité maximale avec les clients (comme News+, mais inutile pour EasyRSS).
+
+# Activer l’API dans FreshRSS
+
+
+# Tester
+
+
+# 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)