diff options
Diffstat (limited to 'docs/en/user/upgrade.rst')
-rw-r--r-- | docs/en/user/upgrade.rst | 110 |
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 @@ | |||
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 | ||
11 | ***************************** | ||
12 | Upgrading from 2.1.x to 2.2.x | ||
13 | ***************************** | ||
14 | |||
15 | Upgrade on a dedicated web server | ||
16 | ================================= | ||
17 | |||
18 | :: | ||
19 | |||
20 | make update | ||
21 | |||
22 | Explanations about database migrations | ||
23 | -------------------------------------- | ||
24 | |||
25 | During the update, we execute database migrations. | ||
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 | ||
47 | |||
48 | Upgrade on a shared hosting | ||
49 | =========================== | ||
50 | |||
51 | Backup your ``app/config/parameters.yml`` file. | ||
52 | |||
53 | Download the last release of wallabag: | ||
54 | |||
55 | .. code-block:: bash | ||
56 | |||
57 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | ||
58 | |||
59 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. | ||
60 | |||
61 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
62 | |||
63 | 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>`_. | ||
64 | |||
65 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | ||
66 | |||
67 | Empty ``var/cache`` folder. | ||
68 | |||
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. | ||
70 | |||
71 | You may encounter issues with indexes names: if so, please change queries with the correct index name. | ||
72 | |||
73 | `You can find all the queries here <http://doc.wallabag.org/en/master/user/query-upgrade-21-22.html>`_. | ||
74 | |||
75 | *************************** | ||
10 | Upgrade from 2.0.x to 2.1.1 | 76 | Upgrade from 2.0.x to 2.1.1 |
11 | --------------------------- | 77 | *************************** |
12 | 78 | ||
13 | .. warning:: | 79 | .. warning:: |
14 | 80 | ||
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. | 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. |
16 | 82 | ||
17 | Upgrade on a dedicated web server | 83 | Upgrade on a dedicated web server |
18 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | 84 | ================================= |
19 | 85 | ||
20 | :: | 86 | :: |
21 | 87 | ||
@@ -28,7 +94,7 @@ Upgrade on a dedicated web server | |||
28 | php bin/console cache:clear --env=prod | 94 | php bin/console cache:clear --env=prod |
29 | 95 | ||
30 | Upgrade on a shared hosting | 96 | Upgrade on a shared hosting |
31 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | 97 | =========================== |
32 | 98 | ||
33 | Backup your ``app/config/parameters.yml`` file. | 99 | Backup your ``app/config/parameters.yml`` file. |
34 | 100 | ||
@@ -60,41 +126,9 @@ You must run some SQL queries to upgrade your database. We assume that the table | |||
60 | ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; | 126 | ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; |
61 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; | 127 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; |
62 | 128 | ||
63 | Upgrading from 2.1.x to 2.1.y | 129 | ***************** |
64 | ----------------------------- | ||
65 | |||
66 | Upgrade on a dedicated web server | ||
67 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
68 | |||
69 | In order to upgrade your wallabag installation and get the last version, run the following command in you wallabag folder: | ||
70 | |||
71 | :: | ||
72 | |||
73 | make update | ||
74 | |||
75 | Upgrade on a shared hosting | ||
76 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
77 | |||
78 | Backup your ``app/config/parameters.yml`` file. | ||
79 | |||
80 | Download the last release of wallabag: | ||
81 | |||
82 | .. code-block:: bash | ||
83 | |||
84 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | ||
85 | |||
86 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. | ||
87 | |||
88 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
89 | |||
90 | 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>`_. | ||
91 | |||
92 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | ||
93 | |||
94 | Empty ``var/cache`` folder. | ||
95 | |||
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 | ||