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