Merge pull request #2016 from wallabag/update-documentation

Update documentation

7 files changed, 144 insertions, 85 deletions

diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst
index 7f29b0f0..6e188ab3 100644
--- a/docs/fr/user/create_account.rst
+++ b/docs/fr/user/create_account.rst
@@ -23,24 +23,3 @@ Votre compte est maintenant actif.
 .. image:: ../../img/user/activated_account.png
    :alt: Bienvenue à bord !
    :align: center
-
-Foire aux questions
--------------------
-
-Je ne peux pas valider le formulaire de création de compte
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Soyez sur d'avoir bien renseigné tous les champs :
-
-* une adresse email valide
-* le même mot de passe dans les deux champs
-
-Je n'ai pas reçu mon email d'activation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ?
-
-Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte.
diff --git a/docs/fr/user/faq.rst b/docs/fr/user/faq.rst
index f5ae2776..e220c8a7 100644
--- a/docs/fr/user/faq.rst
+++ b/docs/fr/user/faq.rst
@@ -8,3 +8,28 @@ Il semblerait que vous ayiez un problème avec votre installation de ``composer`
 
 `Vous pouvez lire la documentation de composer pour savoir comment l'installer
 <https://getcomposer.org/doc/00-intro.md>`__.
+
+Je ne peux pas valider le formulaire de création de compte
+----------------------------------------------------------
+
+Soyez sur d'avoir bien renseigné tous les champs :
+
+* une adresse email valide
+* le même mot de passe dans les deux champs
+
+Je n'ai pas reçu mon email d'activation
+---------------------------------------
+
+Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ?
+
+Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
+----------------------------------------------------------------------------------------------------------------------------------
+
+Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte.
+
+J'ai oublié mon mot de passe
+----------------------------
+
+Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``,
+sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur,
+un email vous sera envoyé.
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst
index 967df1f6..e6c2fa02 100644
--- a/docs/fr/user/import.rst
+++ b/docs/fr/user/import.rst
@@ -1,42 +1,5 @@
-Migrer à wallabag
-=================
-
-Depuis wallabag
----------------
-
-Exportez vos données de wallabag 1.x
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Sur la page de configuration, cliquez sur ``Export JSON`` dans la section ``Exportez vos données wallabag``.
-
-.. image:: ../../img/user/export_wllbg_1.png
-   :alt: Export depuis wallabag 1.x
-   :align: center
-
-Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``.
-
-Exportez vos données de wallabag 2.x
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Dans la barre latérale de téléchargement, cliquez sur ``JSON``.
-
-.. image:: ../../img/user/export_wllbg_2.png
-   :alt: Export depuis wallabag 2.x
-   :align: center
-
-Vous obtiendrez un fichier ``Unread articles.json``.
-
-Importez vos données wallabag 2.x
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Cliquez sur le lien ``Importer`` dans le menu, choisissez la version de wallabag correspondante,
-sélectionnez votre fichier d'export sur votre ordinateur et importez-le.
-
-.. image:: ../../img/user/import_wllbg.png
-   :alt: Import depuis wallabag 1.x
-   :align: center
-
-Tous vos articles wallabag seront importés.
+Migrer depuis un service externe
+================================
 
 Depuis Pocket
 -------------
@@ -53,7 +16,7 @@ Vous devez créer une nouvelle application sur leur site dédié aux développeu
   termes d'utilisation du service et soumettez votre application
 
 Pocket vous fournira une **Consumer Key** (par exemple, `49961-985e4b92fe21fe4c78d682c1`).
-Vous devez configurer la ``pocket_consumer_key`` dans le fichier ``app/config/parameters.yml``.
+Vous devez configurer la ``pocket_consumer_key`` dans la section ``Import`` du menu ``Configuration interne``.
 
 Maintenant, tout est bien configuré pour migrer depuis Pocket.
 
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index 33a2cf5c..8f2ae25d 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -32,6 +32,9 @@ wallabag utilise PDO afin de se connecter à une base de données, donc vous aur
 Installation
 ------------
 
+Sur un serveur dédié (méthode conseillée)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 wallabag utilise un grand nombre de bibliothèques pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait.
 
 Installation de Composer :
@@ -60,13 +63,47 @@ Pour démarrer le serveur interne à php et vérifier que tout s'est installé c
 
 Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
 
-.. note::
+.. tip::
     Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire `documentation Symfony <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ pour en savoir plus.
 
-Installation avec Apache
+Sur un serveur mutualisé
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur.
+La configuration par défaut utilise SQLite pour la base de données. Si vous souhaitez changer ces paramètres, vous devez modifier le fichier ``app/config/parameters.yml``.
+
+Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``.
+
+.. caution:: Avec cette archive, wallabag ne vérifie pas si les extensions obligatoires sont présentes sur votre serveur pour bien fonctionner (ces vérifications sont faites durant le ``composer install`` quand vous avez un serveur dédié, voir ci-dessus).
+
+Exécutez cette commande pour télécharger et décompresser l'archive :
+
+.. code-block:: bash
+
+    wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+
+Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
+Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``.
+
+Installation avec Docker
 ------------------------
 
-En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag et que vous utilisiez php comme un module Apache, voici un vhost pour wallabag :
+Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ pour plus d'informations.
+
+Commande pour démarrer le containeur
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+    docker pull wallabag/wallabag
+
+Virtual hosts
+-------------
+
+Configuration avec Apache
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag`` et que vous utilisiez PHP comme un module Apache, voici un vhost pour wallabag :
 
 ::
 
@@ -108,10 +145,10 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab
 
 Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
 
-Installation avec Nginx
------------------------
+Configuration avec Nginx
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag, voici un fichier de configuration Nginx pour wallabag :
+En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag :
 
 ::
 
@@ -148,23 +185,57 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab
 
 Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld.
 
-
-.. note::
+.. tip::
 
     Si vous voulez importer un fichier important dans wallabag, vous devez ajouter cette ligne dans votre configuration nginx ``client_max_body_size XM; # allows file uploads up to X megabytes``.
 
+Configuration avec lighttpd
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration pour wallabag (éditez votre fichier ``lighttpd.conf`` collez-y cette configuration) :
+
+::
+
+    server.modules = (
+        "mod_fastcgi",
+        "mod_access",
+        "mod_alias",
+        "mod_compress",
+        "mod_redirect",
+        "mod_rewrite",
+    )
+    server.document-root = "/var/www/wallabag/web"
+    server.upload-dirs = ( "/var/cache/lighttpd/uploads" )
+    server.errorlog = "/var/log/lighttpd/error.log"
+    server.pid-file = "/var/run/lighttpd.pid"
+    server.username = "www-data"
+    server.groupname = "www-data"
+    server.port = 80
+    server.follow-symlink = "enable"
+    index-file.names = ( "index.php", "index.html", "index.lighttpd.html")
+    url.access-deny = ( "~", ".inc" )
+    static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" )
+    compress.cache-dir = "/var/cache/lighttpd/compress/"
+    compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" )
+    include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port
+    include_shell "/usr/share/lighttpd/create-mime.assign.pl"
+    include_shell "/usr/share/lighttpd/include-conf-enabled.pl"
+    dir-listing.activate = "disable"
+
+    url.rewrite-if-not-file = (
+        "^/([^?])(?:\?(.))?" => "/app.php?$1&$2",
+        "^/([^?]*)" => "/app.php?=$1",
+    )
 
 Droits d'accès aux dossiers du projet
 -------------------------------------
 
-
 Environnement de test
 ~~~~~~~~~~~~~~~~~~~~~
 
 Quand nous souhaitons juste tester wallabag, nous lançons simplement la commande  ``php bin/console server:run --env=prod`` pour démarrer l'instance wallabag et tout se passe correctement car l'utilisateur qui a démarré le projet a accès naturellement au repertoire courant, tout va bien.
 
-
-Environnement de production 
+Environnement de production
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Dès lors que nous utilisons Apache ou Nginx pour accéder à notre instance wallabag, et non plus la commande ``php bin/console server:run --env=prod`` pour la démarrer, il faut prendre garde à octroyer les bons droits aux bons dossiers afin de préserver la sécurité de l'ensemble des fichiers fournis par le projet.
@@ -178,4 +249,3 @@ Cela est dû au fait qu'il faut aussi octroyer les mêmes droits d'accès au dos
 .. code-block:: bash
 
    chown -R www-data:www-data /var/www/wallabag/var
-
diff --git a/docs/fr/user/login.rst b/docs/fr/user/login.rst
index 3a02d1d5..522ac259 100644
--- a/docs/fr/user/login.rst
+++ b/docs/fr/user/login.rst
@@ -11,13 +11,3 @@ vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous
 .. image:: ../../img/user/login_form.png
    :alt: Formulaire de connexion
    :align: center
-
-Foire aux questions
--------------------
-
-J'ai oublié mon mot de passe
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``,
-sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur,
-un email vous sera envoyé.
diff --git a/docs/fr/user/migration.rst b/docs/fr/user/migration.rst
index 012c4988..66024572 100644
--- a/docs/fr/user/migration.rst
+++ b/docs/fr/user/migration.rst
@@ -1,5 +1,5 @@
-Migrer wallabag
-===============
+Migrer depuis la v1 ou la v2
+============================
 
 Depuis wallabag 1.x
 -------------------
diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst
new file mode 100644
index 00000000..84a1692d
--- /dev/null
+++ b/docs/fr/user/upgrade.rst
@@ -0,0 +1,32 @@
+Mettre à jour wallabag
+======================
+
+Mise à jour sur un serveur dédié
+--------------------------------
+
+La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.3`` par le numéro de la dernière version) :
+
+::
+
+    git fetch origin
+    git fetch --tags
+    git checkout 2.0.3
+    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
+    php bin/console cache:clear --env=prod
+
+Mise à jour sur un hébergement mutualisé
+----------------------------------------
+
+Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
+
+Téléchargez la dernière version de wallabag : 
+
+.. code-block:: bash
+
+    wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+
+Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
+
+Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
+
+Videz le répertoire ``var/cache``.