1 ==================================
2 Upgrade your wallabag installation
3 ==================================
5 You will find here different ways to upgrade your wallabag:
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>`_
11 *****************************
12 Upgrading from 2.1.x to 2.2.x
13 *****************************
15 Upgrade on a dedicated web server
16 =================================
22 Explanations about database migrations
23 --------------------------------------
25 During the update, we execute database migrations.
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``.
30 You can also cancel each migration individually: ``bin/console doctrine:migrations:execute 20161001072726 --down --env=prod``.
32 Here is the migrations list for 2.1.x to 2.2.0 release:
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
48 Upgrade on a shared hosting
49 ===========================
51 Backup your ``app/config/parameters.yml`` file.
53 Download the last release of wallabag:
57 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
59 You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
61 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
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>`_.
65 If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
67 Empty ``var/cache`` folder.
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.
71 You may encounter issues with indexes names: if so, please change queries with the correct index name.
73 `You can find all the queries here <http://doc.wallabag.org/en/master/user/query-upgrade-21-22.html>`_.
75 ***************************
76 Upgrade from 2.0.x to 2.1.1
77 ***************************
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.
83 Upgrade on a dedicated web server
84 =================================
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
96 Upgrade on a shared hosting
97 ===========================
99 Backup your ``app/config/parameters.yml`` file.
101 Download the 2.1.1 release of wallabag:
105 wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
107 (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
109 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
111 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>`_.
113 If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
115 Empty ``var/cache`` folder.
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:
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';
133 There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:
136 - install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
137 - import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )