Merge pull request #2315 from wallabag/fixes-about-upgrade

Fixes about upgrade

6 files changed, 98 insertions, 12 deletions

diff --git a/docs/en/conf.py b/docs/en/conf.py
index 86e33704..717b35f1 100644
--- a/docs/en/conf.py
+++ b/docs/en/conf.py
@@ -12,7 +12,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 project = u'wallabag'
 copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence'
-version = '2.0.0'
+version = '2.1.0'
 release = version
 exclude_patterns = ['_build']
 pygments_style = 'sphinx'
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst
index 8cee45fb..63b85106 100644
--- a/docs/en/developer/rabbitmq.rst
+++ b/docs/en/developer/rabbitmq.rst
@@ -57,11 +57,20 @@ Depending on which service you want to import from you need to enable one (or ma
   # for Pocket import
   bin/console rabbitmq:consumer import_pocket -w
 
-  # for Readbility import
+  # for Readability import
   bin/console rabbitmq:consumer import_readability -w
 
+  # for Instapaper import
+  bin/console rabbitmq:consumer import_instapaper -w
+
   # for wallabag v1 import
   bin/console rabbitmq:consumer import_wallabag_v1 -w
 
   # for wallabag v2 import
   bin/console rabbitmq:consumer import_wallabag_v2 -w
+
+  # for Firefox import
+  bin/console rabbitmq:consumer import_firefox -w
+
+  # for Chrome import
+  bin/console rabbitmq:consumer import_chrome -w
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
index 5748e260..820a52e9 100644
--- a/docs/en/developer/redis.rst
+++ b/docs/en/developer/redis.rst
@@ -1,5 +1,5 @@
 Install Redis for asynchronous tasks
-=======================================
+====================================
 
 In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
 
@@ -37,7 +37,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s
 
 
 Launch Redis consumer
-------------------------
+---------------------
 
 Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
 
@@ -46,15 +46,24 @@ Depending on which service you want to import from you need to enable one (or ma
   # for Pocket import
   bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
 
-  # for Readbility import
+  # for Readability import
   bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
 
+  # for Instapaper import
+  bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
+
   # for wallabag v1 import
   bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
 
   # for wallabag v2 import
   bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
 
+  # for Firefox import
+  bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
+
+  # for Chrome import
+  bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
+
 If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message :
 
 .. code:: bash
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 46450b8f..beb3816e 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -30,7 +30,8 @@ The documentation is available in other languages:
 
    user/faq
    user/installation
-   user/upgrade
+   user/upgrade-2.0.x-2.1.y
+   user/upgrade-2.0.x-2.0.y
    user/migration
    user/import
    user/create_account
@@ -56,3 +57,5 @@ The documentation is available in other languages:
    developer/documentation
    developer/translate
    developer/maintenance
+   developer/redis
+   developer/rabbitmq
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst
index 5c37be95..6a0818b3 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst
@@ -1,17 +1,18 @@
-Upgrade wallabag
-================
+Upgrade from 2.0.x to 2.0.y
+===========================
 
 Upgrade on a dedicated web server
 ---------------------------------
 
-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.1.0`` by the last release number):
+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):
 
 ::
 
     git fetch origin
     git fetch --tags
-    git checkout 2.1.0
-    ./install.sh
+    git checkout 2.0.8
+    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
+    php bin/console cache:clear --env=prod
 
 Upgrade on a shared hosting
 ---------------------------
@@ -24,7 +25,7 @@ Download the last release of wallabag:
 
     wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
 
-(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``)
+(md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``)
 
 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
 
diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst
new file mode 100644
index 00000000..5ae5eb43
--- /dev/null
+++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst
@@ -0,0 +1,64 @@
+Upgrading from 2.0.x to 2.1.y
+=============================
+
+.. warning::
+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
+---------------------------------
+
+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.1.0`` by the last release number):
+
+::
+
+    git fetch origin
+    git fetch --tags
+    git checkout 2.1.0
+    ASSETS=build ./install.sh
+    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 last release of wallabag:
+
+.. code-block:: bash
+
+    wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+
+(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``)
+
+Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
+
+Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) :
+
+.. code-block:: bash
+
+    # RabbitMQ processing
+    rabbitmq_host: localhost
+    rabbitmq_port: 5672
+    rabbitmq_user: guest
+    rabbitmq_password: guest
+
+    # Redis processing
+    redis_host: localhost
+    redis_port: 6379
+
+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';