diff options
author | Nicolas LÅ“uillet <nicolas@loeuillet.org> | 2016-11-06 15:15:48 +0100 |
---|---|---|
committer | Julian Oster <jlnostr@outlook.de> | 2016-11-17 19:22:15 +0100 |
commit | 2e389b0b90f34d795e4bafc43d621955c05850a9 (patch) | |
tree | eb9cd6197751383375339b0fee5ac32f362e3c0a /docs/en/user/upgrade.rst | |
parent | 9e0a49e6acf60c3dbf3c479cb36d404239dfda89 (diff) | |
download | wallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.tar.gz wallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.tar.zst wallabag-2e389b0b90f34d795e4bafc43d621955c05850a9.zip |
Reordered documentation
Diffstat (limited to 'docs/en/user/upgrade.rst')
-rw-r--r-- | docs/en/user/upgrade.rst | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst new file mode 100644 index 00000000..544d57eb --- /dev/null +++ b/docs/en/user/upgrade.rst | |||
@@ -0,0 +1,103 @@ | |||
1 | Upgrade your wallabag installation | ||
2 | ================================== | ||
3 | |||
4 | You will find here different ways to upgrade your wallabag: | ||
5 | |||
6 | - `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 | |||
10 | Upgrade from 2.0.x to 2.1.1 | ||
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 | |||
17 | Upgrade on a dedicated web server | ||
18 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
19 | |||
20 | :: | ||
21 | |||
22 | rm -rf var/cache/* | ||
23 | git fetch origin | ||
24 | git fetch --tags | ||
25 | git checkout 2.1.1 --force | ||
26 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | ||
27 | php bin/console doctrine:migrations:migrate --env=prod | ||
28 | php bin/console cache:clear --env=prod | ||
29 | |||
30 | Upgrade on a shared hosting | ||
31 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
32 | |||
33 | Backup your ``app/config/parameters.yml`` file. | ||
34 | |||
35 | Download the 2.1.1 release of wallabag: | ||
36 | |||
37 | .. code-block:: bash | ||
38 | |||
39 | wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz | ||
40 | |||
41 | (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) | ||
42 | |||
43 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
44 | |||
45 | 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>`_. | ||
46 | |||
47 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | ||
48 | |||
49 | Empty ``var/cache`` folder. | ||
50 | |||
51 | 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: | ||
52 | |||
53 | .. code-block:: sql | ||
54 | |||
55 | ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; | ||
56 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); | ||
57 | ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; | ||
58 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); | ||
59 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); | ||
60 | ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; | ||
61 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; | ||
62 | |||
63 | Upgrading from 2.1.x to 2.1.y | ||
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 | ||
97 | ----------------- | ||
98 | |||
99 | There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to: | ||
100 | |||
101 | - export your data | ||
102 | - install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ ) | ||
103 | - import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ ) | ||