1 files changed, 83 insertions, 38 deletions
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
index 544d57eb..b4635075 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade.rst
@@ -1,44 +1,73 @@
+==================================
 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>`_
-Upgrade from 2.0.x to 2.1.1
+*****************************
---------------------------
+Upgrading from 2.1.x to 2.2.x
+*****************************
-.. warning::
+Upgrade on a dedicated web server
+=================================
-    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.
+**From 2.1.x:**
-Upgrade on a dedicated web server
+::
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    make update
+    php bin/console doctrine:migrations:migrate --no-interaction -e=prod
+**From 2.2.0:**
 ::
-    rm -rf var/cache/*
+    make update
-    git fetch origin
-    git fetch --tags
+Explanations about database migrations
-    git checkout 2.1.1 --force
+--------------------------------------
-    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
-    php bin/console doctrine:migrations:migrate --env=prod
+During the update, we execute database migrations.
-    php bin/console cache:clear --env=prod
+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
+* ``20161214094402``: renamed ``uuid`` to ``uid`` on ``entry`` table
+* ``20161214094403``: added ``uid`` index on ``entry`` table
+* ``20170127093841``: added ``is_starred`` and ``is_archived`` indexes on ``entry`` table
 Upgrade on a shared hosting
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+===========================
 Backup your ``app/config/parameters.yml`` file.
-Download the 2.1.1 release of wallabag:
+Download the last release of wallabag:
 .. code-block:: bash
-    wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
+    wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
+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.
@@ -48,42 +77,45 @@ If you use SQLite, you must also copy your ``data/`` folder inside the new insta
 Empty ``var/cache`` folder.
-You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one:
+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.
-.. code-block:: sql
+You may encounter issues with indexes names: if so, please change queries with the correct index name.
-    ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
+`You can find all the queries here <http://doc.wallabag.org/en/master/user/query-upgrade-21-22.html>`_.
-    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
-    ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
-    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
-    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 from 2.0.x to 2.1.1
+***************************
-Upgrade on a dedicated web server
+.. 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.
-In order to upgrade your wallabag installation and get the last version, run the following command in you wallabag folder:
+Upgrade on a dedicated web server
+=================================
 ::
-    make update
+    rm -rf var/cache/*
+    git fetch origin
+    git fetch --tags
+    git checkout 2.1.1 --force
+    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
+    php bin/console doctrine:migrations:migrate --env=prod
+    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
-    wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+    wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
-You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
+(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
@@ -93,8 +125,21 @@ If you use SQLite, you must also copy your ``data/`` folder inside the new insta
 Empty ``var/cache`` folder.
+You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one:
+.. code-block:: sql
+    ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
+    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
+    ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
+    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
+    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';
+*****************
 From wallabag 1.x
-----------------
+*****************
 There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:

diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index 544d57eb..b4635075 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst
@@ -1,44 +1,73 @@
		1	==================================
1	Upgrade your wallabag installation	2	Upgrade your wallabag installation
2	==================================	3	==================================
3		4
4	You will find here different ways to upgrade your wallabag:	5	You will find here different ways to upgrade your wallabag:
5		6
		7	- `from 2.1.x to 2.2.x <#upgrading-from-2-1-x-to-2-2-x>`_
6	- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_	8	- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
7	- `from 2.1.x to 2.1.y <#upgrading-from-2-1-x-to-2-1-y>`_
8	- `from 1.x to 2.x <#from-wallabag-1-x>`_	9	- `from 1.x to 2.x <#from-wallabag-1-x>`_
9		10
10	Upgrade from 2.0.x to 2.1.1	11	*****************************
11	---------------------------	12	Upgrading from 2.1.x to 2.2.x
		13	*****************************
12		14
13	.. warning::	15	Upgrade on a dedicated web server
		16	=================================
14		17
15	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.	18	From 2.1.x:
16		19
17	Upgrade on a dedicated web server	20	::
18	^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^	21
		22	make update
		23	php bin/console doctrine:migrations:migrate --no-interaction -e=prod
		24
		25	From 2.2.0:
19		26
20	::	27	::
21		28
22	rm -rf var/cache/*	29	make update
23	git fetch origin	30
24	git fetch --tags	31	Explanations about database migrations
25	git checkout 2.1.1 --force	32	--------------------------------------
26	SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist	33
27	php bin/console doctrine:migrations:migrate --env=prod	34	During the update, we execute database migrations.
28	php bin/console cache:clear --env=prod	35
		36	All the database migrations are stored in ``app/DoctrineMigrations``. You can execute each migration individually:
		37	``bin/console doctrine:migrations:execute 20161001072726 --env=prod``.
		38
		39	You can also cancel each migration individually: ``bin/console doctrine:migrations:execute 20161001072726 --down --env=prod``.
		40
		41	Here is the migrations list for 2.1.x to 2.2.0 release:
		42
		43	* ``20161001072726``: added foreign keys for account resetting
		44	* ``20161022134138``: converted database to ``utf8mb4`` encoding (for MySQL only)
		45	* ``20161024212538``: added ``user_id`` column on ``oauth2_clients`` to prevent users to delete API clients from other users
		46	* ``20161031132655``: added the internal setting to enable/disable downloading pictures
		47	* ``20161104073720``: added ``created_at`` index on ``entry`` table
		48	* ``20161106113822``: added ``action_mark_as_read`` field on ``config`` table
		49	* ``20161117071626``: added the internal setting to share articles to unmark.it
		50	* ``20161118134328``: added ``http_status`` field on ``entry`` table
		51	* ``20161122144743``: added the internal setting to enable/disable fetching articles with paywall
		52	* ``20161122203647``: dropped ``expired`` and ``credentials_expired`` fields on ``user`` table
		53	* ``20161128084725``: added ``list_mode`` field on ``config`` table
		54	* ``20161128131503``: dropped ``locked``, ``credentials_expire_at`` and ``expires_at`` fields on ``user`` table
		55	* ``20161214094402``: renamed ``uuid`` to ``uid`` on ``entry`` table
		56	* ``20161214094403``: added ``uid`` index on ``entry`` table
		57	* ``20170127093841``: added ``is_starred`` and ``is_archived`` indexes on ``entry`` table
29		58
30	Upgrade on a shared hosting	59	Upgrade on a shared hosting
31	^^^^^^^^^^^^^^^^^^^^^^^^^^^	60	===========================
32		61
33	Backup your ``app/config/parameters.yml`` file.	62	Backup your ``app/config/parameters.yml`` file.
34		63
35	Download the 2.1.1 release of wallabag:	64	Download the last release of wallabag:
36		65
37	.. code-block:: bash	66	.. code-block:: bash
38		67
39	wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz	68	wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
40		69
41	(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)	70	You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
42		71
43	Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.	72	Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
44		73
@@ -48,42 +77,45 @@ If you use SQLite, you must also copy your ``data/`` folder inside the new insta
48		77
49	Empty ``var/cache`` folder.	78	Empty ``var/cache`` folder.
50		79
51	You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one:	80	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.
52		81
53	.. code-block:: sql	82	You may encounter issues with indexes names: if so, please change queries with the correct index name.
54		83
55	ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;	84	`You can find all the queries here <http://doc.wallabag.org/en/master/user/query-upgrade-21-22.html>`_.
56	INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
57	ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
58	INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
59	INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
60	ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
61	DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
62		85
63	Upgrading from 2.1.x to 2.1.y	86	***************************
64	-----------------------------	87	Upgrade from 2.0.x to 2.1.1
		88	***************************
65		89
66	Upgrade on a dedicated web server	90	.. warning::
67	^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^	91
		92	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.
68		93
69	In order to upgrade your wallabag installation and get the last version, run the following command in you wallabag folder:	94	Upgrade on a dedicated web server
		95	=================================
70		96
71	::	97	::
72		98
73	make update	99	rm -rf var/cache/*
		100	git fetch origin
		101	git fetch --tags
		102	git checkout 2.1.1 --force
		103	SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
		104	php bin/console doctrine:migrations:migrate --env=prod
		105	php bin/console cache:clear --env=prod
74		106
75	Upgrade on a shared hosting	107	Upgrade on a shared hosting
76	^^^^^^^^^^^^^^^^^^^^^^^^^^^	108	===========================
77		109
78	Backup your ``app/config/parameters.yml`` file.	110	Backup your ``app/config/parameters.yml`` file.
79		111
80	Download the last release of wallabag:	112	Download the 2.1.1 release of wallabag:
81		113
82	.. code-block:: bash	114	.. code-block:: bash
83		115
84	wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package	116	wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
85		117
86	You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.	118	(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
87		119
88	Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.	120	Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
89		121
@@ -93,8 +125,21 @@ If you use SQLite, you must also copy your ``data/`` folder inside the new insta
93		125
94	Empty ``var/cache`` folder.	126	Empty ``var/cache`` folder.
95		127
		128	You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one:
		129
		130	.. code-block:: sql
		131
		132	ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
		133	INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
		134	ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
		135	INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
		136	INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
		137	ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
		138	DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
		139
		140	*****************
96	From wallabag 1.x	141	From wallabag 1.x
97	-----------------	142	*****************
98		143
99	There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:	144	There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:
100		145