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