From 084fb0d303efc6edd0bfbf43d96b6cbe48acb2b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 10:02:31 +0200 Subject: Some fixes about upgrade from 2.0.x -> 2.1.0 --- docs/en/conf.py | 2 +- docs/en/user/upgrade.rst | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/en') 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/user/upgrade.rst b/docs/en/user/upgrade.rst index 5c37be95..f547f247 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst @@ -11,7 +11,9 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba git fetch origin git fetch --tags git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod Upgrade on a shared hosting --------------------------- -- cgit v1.2.3 From eef8aeec8fa56519363e90977900f198ff3bd19b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 11:13:20 +0200 Subject: Reordered upgrade documentation --- docs/en/index.rst | 3 ++- docs/en/user/upgrade-2.0.x-2.0.y.rst | 34 ++++++++++++++++++++++++ docs/en/user/upgrade-2.0.x-2.1.0.rst | 50 ++++++++++++++++++++++++++++++++++++ docs/en/user/upgrade.rst | 35 ------------------------- 4 files changed, 86 insertions(+), 36 deletions(-) create mode 100644 docs/en/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.1.0.rst delete mode 100644 docs/en/user/upgrade.rst (limited to 'docs/en') diff --git a/docs/en/index.rst b/docs/en/index.rst index 46450b8f..da23400b 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.0 + user/upgrade-2.0.x-2.0.y user/migration user/import user/create_account diff --git a/docs/en/user/upgrade-2.0.x-2.0.y.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst new file mode 100644 index 00000000..6a0818b3 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst @@ -0,0 +1,34 @@ +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.0.8`` by the last release number): + +:: + + git fetch origin + git fetch --tags + 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 +--------------------------- + +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 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. diff --git a/docs/en/user/upgrade-2.0.x-2.1.0.rst b/docs/en/user/upgrade-2.0.x-2.1.0.rst new file mode 100644 index 00000000..3a24ee58 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.0.rst @@ -0,0 +1,50 @@ +Upgrading from 2.0.x to 2.1.0 +============================= + +.. 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. + +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'; diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst deleted file mode 100644 index f547f247..00000000 --- a/docs/en/user/upgrade.rst +++ /dev/null @@ -1,35 +0,0 @@ -Upgrade wallabag -================ - -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. - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. -- cgit v1.2.3 From 9866d39431ca58e4c913b6385ed74287f014c38d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 11:59:35 +0200 Subject: Fixed review --- docs/en/index.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.0.rst | 50 ---------------------------- docs/en/user/upgrade-2.0.x-2.1.y.rst | 64 ++++++++++++++++++++++++++++++++++++ 3 files changed, 65 insertions(+), 51 deletions(-) delete mode 100644 docs/en/user/upgrade-2.0.x-2.1.0.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.1.y.rst (limited to 'docs/en') diff --git a/docs/en/index.rst b/docs/en/index.rst index da23400b..026d174d 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -30,7 +30,7 @@ The documentation is available in other languages: user/faq user/installation - user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.1.y user/upgrade-2.0.x-2.0.y user/migration user/import diff --git a/docs/en/user/upgrade-2.0.x-2.1.0.rst b/docs/en/user/upgrade-2.0.x-2.1.0.rst deleted file mode 100644 index 3a24ee58..00000000 --- a/docs/en/user/upgrade-2.0.x-2.1.0.rst +++ /dev/null @@ -1,50 +0,0 @@ -Upgrading from 2.0.x to 2.1.0 -============================= - -.. 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. - -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'; 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'; -- cgit v1.2.3 From cb0096df41229d41a960eb48132202adb83576ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 16:37:02 +0200 Subject: Added links to async config in english doc --- docs/en/index.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/en') diff --git a/docs/en/index.rst b/docs/en/index.rst index 026d174d..beb3816e 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -57,3 +57,5 @@ The documentation is available in other languages: developer/documentation developer/translate developer/maintenance + developer/redis + developer/rabbitmq -- cgit v1.2.3 From 2d8af6fc7fe32dd8788cb89f8c3aec9269cbe33c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 29 Sep 2016 11:01:15 +0200 Subject: Added french documentation about Redis and RabbitMQ --- docs/en/developer/rabbitmq.rst | 11 ++++++++++- docs/en/developer/redis.rst | 15 ++++++++++++--- 2 files changed, 22 insertions(+), 4 deletions(-) (limited to 'docs/en') 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 -- cgit v1.2.3