]>
Commit | Line | Data |
---|---|---|
4acbeb93 | 1 | ================================== |
2e389b0b NL |
2 | Upgrade your wallabag installation |
3 | ================================== | |
4 | ||
5 | You will find here different ways to upgrade your wallabag: | |
6 | ||
c8ef0583 | 7 | - `from 2.1.x to 2.2.x <#upgrading-from-2-1-x-to-2-2-x>`_ |
2e389b0b | 8 | - `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_ |
2e389b0b NL |
9 | - `from 1.x to 2.x <#from-wallabag-1-x>`_ |
10 | ||
4acbeb93 | 11 | ***************************** |
c8ef0583 | 12 | Upgrading from 2.1.x to 2.2.x |
4acbeb93 | 13 | ***************************** |
eef8aeec NL |
14 | |
15 | Upgrade on a dedicated web server | |
4acbeb93 | 16 | ================================= |
eef8aeec | 17 | |
eef8aeec NL |
18 | :: |
19 | ||
c8ef0583 NL |
20 | make update |
21 | ||
22 | Explanations about database migrations | |
4acbeb93 | 23 | -------------------------------------- |
c8ef0583 | 24 | |
80aee45f NL |
25 | During the update, we execute database migrations. |
26 | ||
c8ef0583 | 27 | All the database migrations are stored in ``app/DoctrineMigrations``. You can execute each migration individually: |
b87f1712 NL |
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``. | |
c8ef0583 | 31 | |
80aee45f | 32 | Here is the migrations list for 2.1.x to 2.2.0 release: |
c8ef0583 | 33 | |
80aee45f | 34 | * ``20161001072726``: added foreign keys for account resetting |
c8ef0583 NL |
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 | |
b87f1712 NL |
44 | * ``20161128084725``: added ``list_mode`` field on ``config`` table |
45 | * ``20161128131503``: dropped ``locked``, ``credentials_expire_at`` and ``expires_at`` fields on ``user`` table | |
b564d350 | 46 | * ``20161214094402``: renamed ``uuid`` to ``uid`` on ``entry`` table |
b87f1712 | 47 | * ``20161214094403``: added ``uid`` index on ``entry`` table |
b564d350 | 48 | * ``20170127093841``: added ``is_starred`` and ``is_archived`` indexes on ``entry`` table |
eef8aeec NL |
49 | |
50 | Upgrade on a shared hosting | |
4acbeb93 | 51 | =========================== |
eef8aeec NL |
52 | |
53 | Backup your ``app/config/parameters.yml`` file. | |
54 | ||
c8ef0583 | 55 | Download the last release of wallabag: |
eef8aeec NL |
56 | |
57 | .. code-block:: bash | |
58 | ||
c8ef0583 | 59 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
eef8aeec | 60 | |
c8ef0583 | 61 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. |
eef8aeec NL |
62 | |
63 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | |
64 | ||
2e389b0b | 65 | 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>`_. |
b09cafbb | 66 | |
eef8aeec NL |
67 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. |
68 | ||
69 | Empty ``var/cache`` folder. | |
70 | ||
4acbeb93 NL |
71 | 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. |
72 | ||
73 | You may encounter issues with indexes names: if so, please change queries with the correct index name. | |
74 | ||
5d916d03 | 75 | `You can find all the queries here <http://doc.wallabag.org/en/master/user/query-upgrade-21-22.html>`_. |
4acbeb93 NL |
76 | |
77 | *************************** | |
c8ef0583 | 78 | Upgrade from 2.0.x to 2.1.1 |
4acbeb93 | 79 | *************************** |
c8ef0583 NL |
80 | |
81 | .. warning:: | |
82 | ||
83 | 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. | |
2e389b0b NL |
84 | |
85 | Upgrade on a dedicated web server | |
4acbeb93 | 86 | ================================= |
2e389b0b | 87 | |
2e389b0b NL |
88 | :: |
89 | ||
c8ef0583 NL |
90 | rm -rf var/cache/* |
91 | git fetch origin | |
92 | git fetch --tags | |
93 | git checkout 2.1.1 --force | |
94 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | |
95 | php bin/console doctrine:migrations:migrate --env=prod | |
96 | php bin/console cache:clear --env=prod | |
2e389b0b NL |
97 | |
98 | Upgrade on a shared hosting | |
4acbeb93 | 99 | =========================== |
2e389b0b NL |
100 | |
101 | Backup your ``app/config/parameters.yml`` file. | |
102 | ||
c8ef0583 | 103 | Download the 2.1.1 release of wallabag: |
2e389b0b NL |
104 | |
105 | .. code-block:: bash | |
106 | ||
c8ef0583 | 107 | wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz |
2e389b0b | 108 | |
c8ef0583 | 109 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) |
2e389b0b NL |
110 | |
111 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | |
112 | ||
113 | 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>`_. | |
114 | ||
115 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | |
116 | ||
117 | Empty ``var/cache`` folder. | |
118 | ||
c8ef0583 NL |
119 | 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: |
120 | ||
121 | .. code-block:: sql | |
122 | ||
123 | ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; | |
124 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); | |
125 | ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; | |
126 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); | |
127 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); | |
128 | ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; | |
129 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; | |
130 | ||
4acbeb93 | 131 | ***************** |
2e389b0b | 132 | From wallabag 1.x |
4acbeb93 | 133 | ***************** |
2e389b0b NL |
134 | |
135 | There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to: | |
136 | ||
137 | - export your data | |
138 | - install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ ) | |
139 | - import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ ) |