aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/upgrade.rst
diff options
context:
space:
mode:
authorJérémy Benoist <j0k3r@users.noreply.github.com>2017-10-23 11:09:17 +0200
committerGitHub <noreply@github.com>2017-10-23 11:09:17 +0200
commit1953a872932a63792293b4aec087880265ba89f7 (patch)
treefd16599e737fcdaf193c933ef3ec4a4ee248b117 /docs/en/user/upgrade.rst
parentd83d25dadec2c38460a32d96f5d2903426fec9d3 (diff)
parent702f2d67d60ca963492b90dad74cb5f8dcc84e51 (diff)
downloadwallabag-1953a872932a63792293b4aec087880265ba89f7.tar.gz
wallabag-1953a872932a63792293b4aec087880265ba89f7.tar.zst
wallabag-1953a872932a63792293b4aec087880265ba89f7.zip
Merge pull request #3011 from wallabag/2.3
wallabag 2.3.0
Diffstat (limited to 'docs/en/user/upgrade.rst')
-rw-r--r--docs/en/user/upgrade.rst148
1 files changed, 0 insertions, 148 deletions
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
deleted file mode 100644
index 46b490c3..00000000
--- a/docs/en/user/upgrade.rst
+++ /dev/null
@@ -1,148 +0,0 @@
1==================================
2Upgrade your wallabag installation
3==================================
4
5You will find here different ways to upgrade your wallabag:
6
7- `from 2.1.x to 2.2.x <#upgrading-from-2-1-x-to-2-2-x>`_
8- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
9- `from 1.x to 2.x <#from-wallabag-1-x>`_
10
11*****************************
12Upgrading from 2.1.x to 2.2.x
13*****************************
14
15Upgrade on a dedicated web server
16=================================
17
18**From 2.1.x:**
19
20::
21
22 make update
23 php bin/console doctrine:migrations:migrate --no-interaction -e=prod
24
25**From 2.2.0:**
26
27::
28
29 make update
30
31Explanations about database migrations
32--------------------------------------
33
34During the update, we execute database migrations.
35
36All the database migrations are stored in ``app/DoctrineMigrations``. You can execute each migration individually:
37``bin/console doctrine:migrations:execute 20161001072726 --env=prod``.
38
39You can also cancel each migration individually: ``bin/console doctrine:migrations:execute 20161001072726 --down --env=prod``.
40
41Here 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
58
59Upgrade on a shared hosting
60===========================
61
62Backup your ``app/config/parameters.yml`` file.
63
64Download the last release of wallabag:
65
66.. code-block:: bash
67
68 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
69
70You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
71
72Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
73
74Please 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>`_.
75
76If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
77
78Empty ``var/cache`` folder.
79
80You 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.
81
82You may encounter issues with indexes names: if so, please change queries with the correct index name.
83
84`You can find all the queries here <http://doc.wallabag.org/en/master/user/query-upgrade-21-22.html>`_.
85
86***************************
87Upgrade from 2.0.x to 2.1.1
88***************************
89
90.. warning::
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.
93
94Upgrade on a dedicated web server
95=================================
96
97::
98
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
106
107Upgrade on a shared hosting
108===========================
109
110Backup your ``app/config/parameters.yml`` file.
111
112Download the 2.1.1 release of wallabag:
113
114.. code-block:: bash
115
116 wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
117
118(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
119
120Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
121
122Please 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>`_.
123
124If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
125
126Empty ``var/cache`` folder.
127
128You 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*****************
141From wallabag 1.x
142*****************
143
144There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:
145
146- export your data
147- install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
148- import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )