Third resources
---------------
-Some applications use our API. Here is a non-exhaustive list of them:
+Some applications or libraries use our API. Here is a non-exhaustive list of them:
+- `Java wrapper for the wallabag API <https://github.com/Strubbl/wallabag-java>`_ by Strubbl.
+- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster.
- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_.
--- /dev/null
+Contribute to this documentation\r
+================================\r
+\r
+Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs\r
+\r
+We use `ReadTheDocs\r
+<https://readthedocs.org>`__ to generate it.\r
+\r
+Pages are written in `Restructured Text\r
+<https://en.wikipedia.org/wiki/ReStructuredText>`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles. \r
+\r
+If you create a new page, don't forget to edit the `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/index.rst>`__ file to add a link in the sidebar.
\ No newline at end of file
**wallabag** is a read-it-later application: it saves a web page by
keeping content only. Elements like navigation or ads are deleted.
-.. note::
+.. tip::
This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__.
user/faq
user/installation
- user/migration
user/upgrade
+ user/migration
+ user/import
user/create_account
user/login
user/configuration
user/first_article
user/errors_during_fetching
user/annotations
- user/import
user/download_articles
user/filters
user/tags
developer/api
developer/docker
+ developer/documentation
developer/translate
developer/maintenance
.. image:: ../../img/user/activated_account.png
:alt: Welcome on board!
:align: center
-
-Frequently asked questions
---------------------------
-
-I can't valid the registration form
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Make sure that all fields are well filled:
-
-* valid email address
-* same passwords in two fields
-
-I don't receive my activation email
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Are you sure your email address was correct? Did you check your spams folder?
-
-When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You already enabled your account or the URL of the activation email is wrong.
`Read the documentation about composer to know how to install it
<https://getcomposer.org/doc/00-intro.md>`__.
+
+I can't valid the registration form
+-----------------------------------
+
+Make sure that all fields are well filled:
+
+* valid email address
+* same passwords in two fields
+
+I don't receive my activation email
+-----------------------------------
+
+Are you sure your email address was correct? Did you check your spams folder?
+
+When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
+----------------------------------------------------------------------------------------------------------------------------------
+
+You already enabled your account or the URL of the activation email is wrong.
+
+I forgot my password
+--------------------
+
+You can reset your password by clicking on ``Forgot your password?`` link,
+on the login page. Then, fill the form with your email address or your username,
+you'll receive an email to reset your password.
-Migrate to wallabag
-===================
-
-From wallabag
--------------
-
-Export your data from your wallabag 1.x
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-On your config page, click on ``JSON export`` in the ``Export your wallabag data`` section.
-
-.. image:: ../../img/user/export_wllbg_1.png
- :alt: Export from wallabag 1.x
- :align: center
-
-You will have a ``wallabag-export-1-1970-01-01.json`` file.
-
-Export your data from your wallabag 2.x
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-On the export sidebar, click on ``JSON``.
-
-.. image:: ../../img/user/export_wllbg_2.png
- :alt: Export from wallabag 2.x
- :align: center
-
-You will have a ``Unread articles.json`` file.
-
-Import your data into wallabag 2.x
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Click on ``Import`` link in the menu, choose the right wallabag version,
-select your export file on your computer and import it.
-
-.. image:: ../../img/user/import_wllbg.png
- :alt: Import from wallabag 1.x
- :align: center
-
-All your wallabag articles will be imported.
+Migrate from a third service
+============================
From Pocket
-----------
and submit your new application
Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`).
-You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag.
+You need to configure the ``pocket_consumer_key`` into the ``Import`` section in the ``Internal settings`` menu.
Now, all is fine to migrate from Pocket.
Installation
------------
+On a dedicated web server (recommended way)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
wallabag uses a big number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you don't already have.
Install Composer:
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
php bin/console wallabag:install --env=prod
-To start php's build-in server and test if everything did install correctly, you can do:
+To start PHP's build-in server and test if everything did install correctly, you can do:
::
And access wallabag at http://yourserverip:8000
-.. note::
+.. tip::
To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look to the `Symfony documentation <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__.
-Installing on Apache
---------------------
+On a shared hosting
+~~~~~~~~~~~~~~~~~~~
+
+We provide you a package with all dependancies inside.
+The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``.
+
+We already created a user: login and password are ``wallabag``.
+
+.. caution:: With this package, wallabag don't check mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above).
+
+Execute this command to download and extract the latest package:
+
+.. code-block:: bash
-Assuming you install wallabag in the /var/www/wallabag folder and that you want to use php as an Apache module, here's a vhost for wallabag:
+ wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+
+Now, read the following documentation to create your virtual host, then access to your wallabag.
+If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``.
+
+Installation with Docker
+------------------------
+
+We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
+
+Command to launch container
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+ docker pull wallabag/wallabag
+
+Virtual hosts
+-------------
+
+Configuration on Apache
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for wallabag:
::
After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld.
-Installing on Nginx
--------------------
+Configuration on Nginx
+~~~~~~~~~~~~~~~~~~~~~~
-Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag :
+Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag :
::
After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld.
-.. note::
+.. tip::
When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``.
+Configuration on lighttpd
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it):
+
+::
+
+ 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",
+ )
Rights access to the folders of the project
-------------------------------------------
-
-Test Environment
+Test environment
~~~~~~~~~~~~~~~~
When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem.
-
-Production Environment
+Production environment
~~~~~~~~~~~~~~~~~~~~~~
As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project.
.. code-block:: bash
chown -R www-data:www-data /var/www/wallabag/var
-
.. image:: ../../img/user/login_form.png
:alt: Login form
:align: center
-
-Frequently asked questions
---------------------------
-
-I forgot my password
-~~~~~~~~~~~~~~~~~~~~
-
-You can reset your password by clicking on ``Forgot your password?`` link,
-on the login page. Then, fill the form with your email address or your username,
-you'll receive an email to reset your password.
-Migrate wallabag
-================
+Migrate from v1 or v2
+=====================
From wallabag 1.x
-----------------
---------------------------------
The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.3`` by the last release number):
+
::
git fetch origin
git checkout 2.0.3
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
php bin/console cache:clear --env=prod
-
Upgrade on a shared hosting
---------------------------
-Backup your ``app/config/parameters.yml`` file. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
+Backup your ``app/config/parameters.yml`` file.
+
+Download the last release of wallabag:
+
+.. code-block:: bash
+
+ wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+
+Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
Ressources tierces
------------------
-Certaines applications utilisent notre API. En voici une liste non exhaustive :
+Certaines applications ou bibliothèques utilisent notre API. En voici une liste non exhaustive :
+- `Java wrapper for the wallabag API <https://github.com/Strubbl/wallabag-java>`_ par Strubbl.
+- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ par Julian Oster.
- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ par FoxMaSk, pour son projet `Trigger Happy <https://blog.trigger-happy.eu/>`_.
--- /dev/null
+Contribuer à cette documentation\r
+================================\r
+\r
+Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs\r
+\r
+Nous utilisons `ReadTheDocs\r
+<https://readthedocs.org>`__ pour la générer.\r
+\r
+Les pages sont écrites au format `Restructured Text\r
+<https://fr.wikipedia.org/wiki/ReStructuredText>`__. Vous pouvez utiliser des outils en ligne comme http://rst.aaroniles.net/ ou http://rst.ninjs.org/ pour prévisualiser vos articles. \r
+\r
+Si vous créez une nouvelle page, n'oubliez pas d'éditer le fichier `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/index.rst>`__ pour ajouter un lien dans la barre latérale.
\ No newline at end of file
simplement d’archiver une page web en ne conservant que le contenu. Les
éléments superflus (menu, publicité, etc.) sont supprimés.
-.. note::
+.. tip::
Vous vous trouvez sur la documentation de wallabag v2. Si vous voulez lire la documentation de wallabag v1, `vous pouvez jeter un œil ici <https://github.com/wallabag/documentation>`__.
user/faq
user/installation
+ user/upgrade
user/migration
+ user/import
user/create_account
user/login
user/configuration
user/first_article
user/errors_during_fetching
user/annotations
- user/import
user/download_articles
user/filters
user/tags
developer/api
developer/docker
+ developer/documentation
developer/translate
developer/maintenance
.. 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.
`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é.
-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
-------------
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.
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 :
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 :
::
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 :
::
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.
.. code-block:: bash
chown -R www-data:www-data /var/www/wallabag/var
-
.. 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é.
-Migrer wallabag
-===============
+Migrer depuis la v1 ou la v2
+============================
Depuis wallabag 1.x
-------------------
--- /dev/null
+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``.
projects / github / wallabag / wallabag.git / commitdiff
