Reordered documentation

[github/wallabag/wallabag.git] / docs / en / user / upgrade.rst

diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade.rst
similarity index 51%
rename from docs/en/user/upgrade-2.0.x-2.1.1.rst
rename to docs/en/user/upgrade.rst
index 3b39fc8cec80af72d9b786d44ba4e9e0a783813a..544d57ebe5fd2547178955bf1e21e14344626a26 100644 (file)
--- a/docs/en/user/upgrade-2.0.x-2.1.1.rst
+++ b/docs/en/user/upgrade.rst
@@ -1,12 +1,21 @@
+Upgrade your wallabag installation
+==================================
+
+You will find here different ways to upgrade your wallabag:
+
+- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
+- `from 2.1.x to 2.1.y <#upgrading-from-2-1-x-to-2-1-y>`_
+- `from 1.x to 2.x <#from-wallabag-1-x>`_
+
 Upgrade from 2.0.x to 2.1.1
-===========================
+---------------------------
 
 .. warning::
 
     Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade.
 
 Upgrade on a dedicated web server
----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ::
 
@@ -19,11 +28,11 @@ Upgrade on a dedicated web server
     php bin/console cache:clear --env=prod
 
 Upgrade on a shared hosting
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Backup your ``app/config/parameters.yml`` file.
 
-Download the last release of wallabag:
+Download the 2.1.1 release of wallabag:
 
 .. code-block:: bash
 
@@ -33,42 +42,7 @@ Download the last release of wallabag:
 
 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
 
-Please check that your ``app/config/parameters.yml`` contains all the required parameters. Here is a default ``parameters.yml`` file. If you don't know which parameter you need to set, please leave the default one.
-
-.. code-block:: yml
-
-    parameters:
-        database_driver: pdo_sqlite
-        database_host: 127.0.0.1
-        database_port: null
-        database_name: symfony
-        database_user: root
-        database_password: null
-        database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
-        database_table_prefix: wallabag_
-        database_socket: null
-        mailer_transport: smtp
-        mailer_host: 127.0.0.1
-        mailer_user: null
-        mailer_password: null
-        locale: en
-        secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
-        twofactor_auth: true
-        twofactor_sender: no-reply@wallabag.org
-        fosuser_registration: true
-        fosuser_confirmation: true
-        from_email: no-reply@wallabag.org
-        rss_limit: 50
-        rabbitmq_host: localhost
-        rabbitmq_port: 5672
-        rabbitmq_user: guest
-        rabbitmq_password: guest
-        redis_scheme: tcp
-        redis_host: localhost
-        redis_port: 6379
-        redis_path: null
-
-You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
+Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
 
 If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
 
@@ -85,3 +59,45 @@ You must run some SQL queries to upgrade your database. We assume that the table
     INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
     ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
     DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
+
+Upgrading from 2.1.x to 2.1.y
+-----------------------------
+
+Upgrade on a dedicated web server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to upgrade your wallabag installation and get the last version, run the following command in you wallabag folder:
+
+::
+
+    make update
+
+Upgrade on a shared hosting
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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
+
+You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
+
+Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
+
+Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
+
+If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
+
+Empty ``var/cache`` folder.
+
+From wallabag 1.x
+-----------------
+
+There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:
+
+- export your data
+- install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
+- import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )