Reordered documentation

[github/wallabag/wallabag.git] / docs / en / user / upgrade.rst

diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
index 90ed6c70129b686de6512e0ca4a2d5fd80eb163d..544d57ebe5fd2547178955bf1e21e14344626a26 100644 (file)
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade.rst
@@ -1,21 +1,79 @@
-Upgrade wallabag
-================
+Upgrade your wallabag installation
+==================================
 
-Upgrade on a dedicated web server
----------------------------------
+You will find here different ways to upgrade your wallabag:
+
+- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
+- `from 2.1.x to 2.1.y <#upgrading-from-2-1-x-to-2-1-y>`_
+- `from 1.x to 2.x <#from-wallabag-1-x>`_
+
+Upgrade from 2.0.x to 2.1.1
+---------------------------
+
+.. warning::
 
-The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.8`` by the last release number):
+    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.
+
+Upgrade on a dedicated web server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ::
 
+    rm -rf var/cache/*
     git fetch origin
     git fetch --tags
-    git checkout 2.0.8
+    git checkout 2.1.1 --force
     SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
+    php bin/console doctrine:migrations:migrate --env=prod
     php bin/console cache:clear --env=prod
 
 Upgrade on a shared hosting
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Backup your ``app/config/parameters.yml`` file.
+
+Download the 2.1.1 release of wallabag:
+
+.. code-block:: bash
+
+    wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
+
+(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
+
+Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
+
+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>`_.
+
+If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
+
+Empty ``var/cache`` folder.
+
+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:
+
+.. code-block:: sql
+
+    ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
+    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
+    ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
+    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
+    INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
+    ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
+    DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
+
+Upgrading from 2.1.x to 2.1.y
+-----------------------------
+
+Upgrade on a dedicated web server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to upgrade your wallabag installation and get the last version, run the following command in you wallabag folder:
+
+::
+
+    make update
+
+Upgrade on a shared hosting
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Backup your ``app/config/parameters.yml`` file.
 
@@ -25,10 +83,21 @@ Download the last release of wallabag:
 
     wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
 
-(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``)
+You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
 
 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
 
+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>`_.
+
 If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
 
 Empty ``var/cache`` folder.
+
+From wallabag 1.x
+-----------------
+
+There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:
+
+- export your data
+- install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
+- import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )