Merge pull request #2416 from wallabag/2.2

wallabag 2.2.0

1 files changed, 72 insertions, 38 deletions

diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
index 544d57eb..99260e13 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade.rst
@@ -1,21 +1,87 @@
+==================================
 Upgrade your wallabag installation
 ==================================
 
 You will find here different ways to upgrade your wallabag:
 
+- `from 2.1.x to 2.2.x <#upgrading-from-2-1-x-to-2-2-x>`_
 - `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>`_
 
+*****************************
+Upgrading from 2.1.x to 2.2.x
+*****************************
+
+Upgrade on a dedicated web server
+=================================
+
+::
+
+    make update
+
+Explanations about database migrations
+--------------------------------------
+
+During the update, we execute database migrations.
+
+All the database migrations are stored in ``app/DoctrineMigrations``. You can execute each migration individually:
+``bin/console doctrine:migrations:execute 20161001072726 --env=prod``.
+
+You can also cancel each migration individually: ``bin/console doctrine:migrations:execute 20161001072726 --down --env=prod``.
+
+Here is the migrations list for 2.1.x to 2.2.0 release:
+
+* ``20161001072726``: added foreign keys for account resetting
+* ``20161022134138``: converted database to ``utf8mb4`` encoding (for MySQL only)
+* ``20161024212538``: added ``user_id`` column on ``oauth2_clients`` to prevent users to delete API clients from other users
+* ``20161031132655``: added the internal setting to enable/disable downloading pictures
+* ``20161104073720``: added ``created_at`` index on ``entry`` table
+* ``20161106113822``: added ``action_mark_as_read`` field on ``config`` table
+* ``20161117071626``: added the internal setting to share articles to unmark.it
+* ``20161118134328``: added ``http_status`` field on ``entry`` table
+* ``20161122144743``: added the internal setting to enable/disable fetching articles with paywall
+* ``20161122203647``: dropped ``expired`` and ``credentials_expired`` fields on ``user`` table
+* ``20161128084725``: added ``list_mode`` field on ``config`` table
+* ``20161128131503``: dropped ``locked``, ``credentials_expire_at`` and ``expires_at`` fields on ``user`` table
+* ``20161214094403``: added ``uid`` index on ``entry`` table
+
+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.
+
+You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_``. Don't forgete to backup your database before migrating.
+
+You may encounter issues with indexes names: if so, please change queries with the correct index name.
+
+`You can find all the queries here <http://doc.wallabag.org/en/master/user/query-upgrade-21-22.html>`_.
+
+***************************
 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
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+=================================
 
 ::
 
@@ -28,7 +94,7 @@ 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.
 
@@ -60,41 +126,9 @@ You must run some SQL queries to upgrade your database. We assume that the table
     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: