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: [PATCH 01/11] Some fixes about upgrade from 2.0.x -> 2.1.0 --- app/DoctrineMigrations/Version20160812120952.php | 6 +++++- docs/de/conf.py | 2 +- docs/de/user/upgrade.rst | 4 +++- docs/en/conf.py | 2 +- docs/en/user/upgrade.rst | 4 +++- docs/fr/conf.py | 2 +- docs/fr/user/upgrade.rst | 4 +++- .../CoreBundle/Resources/translations/messages.fr.yml | 1 + tests/Wallabag/CoreBundle/Controller/TagControllerTest.php | 4 ++-- tests/Wallabag/CoreBundle/WallabagCoreTestCase.php | 2 +- tests/Wallabag/UserBundle/Mailer/AuthCodeMailerTest.php | 2 +- 11 files changed, 22 insertions(+), 11 deletions(-) diff --git a/app/DoctrineMigrations/Version20160812120952.php b/app/DoctrineMigrations/Version20160812120952.php index 9adfdc8be..a8d3bcf25 100644 --- a/app/DoctrineMigrations/Version20160812120952.php +++ b/app/DoctrineMigrations/Version20160812120952.php @@ -29,7 +29,11 @@ class Version20160812120952 extends AbstractMigration implements ContainerAwareI */ public function up(Schema $schema) { - $this->addSql('ALTER TABLE '.$this->getTable('oauth2_clients').' ADD name longtext COLLATE \'utf8_unicode_ci\' DEFAULT NULL'); + if ($this->connection->getDatabasePlatform()->getName() == 'sqlite') { + $this->addSql('ALTER TABLE '.$this->getTable('oauth2_clients').' ADD name longtext DEFAULT NULL'); + } else { + $this->addSql('ALTER TABLE '.$this->getTable('oauth2_clients').' ADD name longtext COLLATE \'utf8_unicode_ci\' DEFAULT NULL'); + } } /** diff --git a/docs/de/conf.py b/docs/de/conf.py index 8f2d130d0..cc9dcdf81 100644 --- a/docs/de/conf.py +++ b/docs/de/conf.py @@ -12,7 +12,7 @@ source_suffix = '.rst' master_doc = 'index' project = u'wallabag-fr' 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/de/user/upgrade.rst b/docs/de/user/upgrade.rst index 953c84ff7..084dab746 100644 --- a/docs/de/user/upgrade.rst +++ b/docs/de/user/upgrade.rst @@ -11,7 +11,9 @@ Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.htm 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 Update auf einem Shared Webhosting ---------------------------------- diff --git a/docs/en/conf.py b/docs/en/conf.py index 86e337040..717b35f14 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 5c37be950..f547f247b 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 --------------------------- diff --git a/docs/fr/conf.py b/docs/fr/conf.py index f1fe39676..49a57e2d5 100644 --- a/docs/fr/conf.py +++ b/docs/fr/conf.py @@ -12,7 +12,7 @@ source_suffix = '.rst' master_doc = 'index' project = u'wallabag-fr' 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/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst index e3798979c..42aef9c76 100644 --- a/docs/fr/user/upgrade.rst +++ b/docs/fr/user/upgrade.rst @@ -11,7 +11,9 @@ La dernière version de wallabag est publiée à cette adresse : https://www.wal 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 Mise à jour sur un hébergement mutualisé ---------------------------------------- diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml index 968deaf9a..95cb31d18 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml @@ -48,6 +48,7 @@ footer: page_title: 'Configuration' config: + page_title: 'Configuration' tab_menu: settings: 'Paramètres' rss: 'RSS' diff --git a/tests/Wallabag/CoreBundle/Controller/TagControllerTest.php b/tests/Wallabag/CoreBundle/Controller/TagControllerTest.php index 71652760d..2c32393f7 100644 --- a/tests/Wallabag/CoreBundle/Controller/TagControllerTest.php +++ b/tests/Wallabag/CoreBundle/Controller/TagControllerTest.php @@ -47,7 +47,7 @@ class TagControllerTest extends WallabagCoreTestCase $this->assertEquals(1, count($entry->getTags())); - # tag already exists and already assigned + // tag already exists and already assigned $client->submit($form, $data); $this->assertEquals(302, $client->getResponse()->getStatusCode()); @@ -58,7 +58,7 @@ class TagControllerTest extends WallabagCoreTestCase $this->assertEquals(1, count($newEntry->getTags())); - # tag already exists but still not assigned to this entry + // tag already exists but still not assigned to this entry $data = [ 'tag[label]' => 'foo', ]; diff --git a/tests/Wallabag/CoreBundle/WallabagCoreTestCase.php b/tests/Wallabag/CoreBundle/WallabagCoreTestCase.php index 75b7ee0bd..4f103921a 100644 --- a/tests/Wallabag/CoreBundle/WallabagCoreTestCase.php +++ b/tests/Wallabag/CoreBundle/WallabagCoreTestCase.php @@ -83,7 +83,7 @@ abstract class WallabagCoreTestCase extends WebTestCase /** * Check if Redis is installed. - * If not, mark test as skip + * If not, mark test as skip. */ protected function checkRedis() { diff --git a/tests/Wallabag/UserBundle/Mailer/AuthCodeMailerTest.php b/tests/Wallabag/UserBundle/Mailer/AuthCodeMailerTest.php index f670c9258..441d6519f 100644 --- a/tests/Wallabag/UserBundle/Mailer/AuthCodeMailerTest.php +++ b/tests/Wallabag/UserBundle/Mailer/AuthCodeMailerTest.php @@ -37,7 +37,7 @@ class AuthCodeMailerTest extends \PHPUnit_Framework_TestCase ); $this->mailer = new \Swift_Mailer($transport); - $twigTemplate = << Date: Wed, 28 Sep 2016 11:13:20 +0200 Subject: [PATCH 02/11] Reordered upgrade documentation --- docs/de/index.rst | 3 +- .../{upgrade.rst => upgrade-2.0.x-2.0.y.rst} | 7 ++- docs/de/user/upgrade-2.0.x-2.1.0.rst | 50 ++++++++++++++++++ docs/en/index.rst | 3 +- .../{upgrade.rst => upgrade-2.0.x-2.0.y.rst} | 13 +++-- docs/en/user/upgrade-2.0.x-2.1.0.rst | 50 ++++++++++++++++++ docs/fr/index.rst | 3 +- .../{upgrade.rst => upgrade-2.0.x-2.0.y.rst} | 13 +++-- docs/fr/user/upgrade-2.0.x-2.1.0.rst | 51 +++++++++++++++++++ .../Resources/translations/messages.fr.yml | 1 - 10 files changed, 172 insertions(+), 22 deletions(-) rename docs/de/user/{upgrade.rst => upgrade-2.0.x-2.0.y.rst} (84%) create mode 100644 docs/de/user/upgrade-2.0.x-2.1.0.rst rename docs/en/user/{upgrade.rst => upgrade-2.0.x-2.0.y.rst} (74%) create mode 100644 docs/en/user/upgrade-2.0.x-2.1.0.rst rename docs/fr/user/{upgrade.rst => upgrade-2.0.x-2.0.y.rst} (77%) create mode 100644 docs/fr/user/upgrade-2.0.x-2.1.0.rst diff --git a/docs/de/index.rst b/docs/de/index.rst index d8cd8f396..62f8b54a9 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -30,7 +30,8 @@ Die Dokumentation ist in anderen Sprachen verfügbar : 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/de/user/upgrade.rst b/docs/de/user/upgrade-2.0.x-2.0.y.rst similarity index 84% rename from docs/de/user/upgrade.rst rename to docs/de/user/upgrade-2.0.x-2.0.y.rst index 084dab746..c04b68f34 100644 --- a/docs/de/user/upgrade.rst +++ b/docs/de/user/upgrade-2.0.x-2.0.y.rst @@ -4,15 +4,14 @@ Wallabag updaten Update auf einem dedizierten Webserver -------------------------------------- -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer): :: git fetch origin git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod + git checkout 2.0.8 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console cache:clear --env=prod Update auf einem Shared Webhosting diff --git a/docs/de/user/upgrade-2.0.x-2.1.0.rst b/docs/de/user/upgrade-2.0.x-2.1.0.rst new file mode 100644 index 000000000..eb67e686a --- /dev/null +++ b/docs/de/user/upgrade-2.0.x-2.1.0.rst @@ -0,0 +1,50 @@ +Wallabag updaten +================ + +.. 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. + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): + +:: + + 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 + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) + +Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. + +Sie müssen einige SQL-Abfragen ausführen, um Ihre Datenbank zu aktualisieren. 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/index.rst b/docs/en/index.rst index 46450b8f0..da23400b7 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.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst similarity index 74% rename from docs/en/user/upgrade.rst rename to docs/en/user/upgrade-2.0.x-2.0.y.rst index f547f247b..6a0818b3a 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst @@ -1,18 +1,17 @@ -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 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod + 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 @@ -26,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.0.rst b/docs/en/user/upgrade-2.0.x-2.1.0.rst new file mode 100644 index 000000000..3a24ee580 --- /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/fr/index.rst b/docs/fr/index.rst index dfa55afe6..ff99948c6 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -31,7 +31,8 @@ La documentation est disponible dans d'autres langues : 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/fr/user/upgrade.rst b/docs/fr/user/upgrade-2.0.x-2.0.y.rst similarity index 77% rename from docs/fr/user/upgrade.rst rename to docs/fr/user/upgrade-2.0.x-2.0.y.rst index 42aef9c76..d8dfac6eb 100644 --- a/docs/fr/user/upgrade.rst +++ b/docs/fr/user/upgrade-2.0.x-2.0.y.rst @@ -1,18 +1,17 @@ -Mettre à jour wallabag -====================== +Mettre à jour de la 2.0.x à la 2.0.y +==================================== Mise à jour sur un serveur dédié -------------------------------- -La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.0`` par le numéro de la dernière version) : +La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.8`` par le numéro de la dernière version) : :: git fetch origin git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod + git checkout 2.0.8 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console cache:clear --env=prod Mise à jour sur un hébergement mutualisé @@ -26,7 +25,7 @@ Téléchargez la dernière version de wallabag : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) +(hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``) Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. diff --git a/docs/fr/user/upgrade-2.0.x-2.1.0.rst b/docs/fr/user/upgrade-2.0.x-2.1.0.rst new file mode 100644 index 000000000..18f09a631 --- /dev/null +++ b/docs/fr/user/upgrade-2.0.x-2.1.0.rst @@ -0,0 +1,51 @@ +Mettre à jour de la 2.0.x à la 2.1.0 +==================================== + +.. warning:: +Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajoutant votre consumer key dans les paramètres internes, pensez à effectuer une sauvegarde de celle-ci : vous devrez l'ajouter dans la configuration de wallabag après la mise à jour. + +Mise à jour sur un serveur dédié +-------------------------------- + +La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.0`` par le numéro de la dernière version) : + +:: + + 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 + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. + +Vous allez devoir également exécuter des requêtes SQL pour mettre à jour votre base de données. Nous partons du principe que le préfixe de vos tables est ``wallabag_`` et que le serveur SQL est un serveur MySQL : + +.. 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/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml index 95cb31d18..b70ca64df 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml @@ -45,7 +45,6 @@ footer: social: 'Social' powered_by: 'propulsé par' about: 'À propos' - page_title: 'Configuration' config: page_title: 'Configuration' 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: [PATCH 03/11] Fixed review --- docs/de/index.rst | 2 +- docs/de/user/upgrade-2.0.x-2.0.y.rst | 4 ++-- ...e-2.0.x-2.1.0.rst => upgrade-2.0.x-2.1.y.rst} | 14 ++++++++++++++ docs/en/index.rst | 2 +- ...e-2.0.x-2.1.0.rst => upgrade-2.0.x-2.1.y.rst} | 16 +++++++++++++++- docs/fr/index.rst | 2 +- ...e-2.0.x-2.1.0.rst => upgrade-2.0.x-2.1.y.rst} | 16 +++++++++++++++- 7 files changed, 49 insertions(+), 7 deletions(-) rename docs/de/user/{upgrade-2.0.x-2.1.0.rst => upgrade-2.0.x-2.1.y.rst} (85%) rename docs/en/user/{upgrade-2.0.x-2.1.0.rst => upgrade-2.0.x-2.1.y.rst} (83%) rename docs/fr/user/{upgrade-2.0.x-2.1.0.rst => upgrade-2.0.x-2.1.y.rst} (83%) diff --git a/docs/de/index.rst b/docs/de/index.rst index 62f8b54a9..65cf89530 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -30,7 +30,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar : 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/de/user/upgrade-2.0.x-2.0.y.rst b/docs/de/user/upgrade-2.0.x-2.0.y.rst index c04b68f34..adf288bd5 100644 --- a/docs/de/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.0.y.rst @@ -1,5 +1,5 @@ -Wallabag updaten -================ +Wallabag updaten 2.0.x -> 2.1.x +=============================== Update auf einem dedizierten Webserver -------------------------------------- diff --git a/docs/de/user/upgrade-2.0.x-2.1.0.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst similarity index 85% rename from docs/de/user/upgrade-2.0.x-2.1.0.rst rename to docs/de/user/upgrade-2.0.x-2.1.y.rst index eb67e686a..32d13c6a6 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.0.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -33,6 +33,20 @@ Lade das neueste Release von wallabag herunter: Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. +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 + Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. Leere den ``var/cache`` Ordner. diff --git a/docs/en/index.rst b/docs/en/index.rst index da23400b7..026d174da 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.y.rst similarity index 83% rename from docs/en/user/upgrade-2.0.x-2.1.0.rst rename to docs/en/user/upgrade-2.0.x-2.1.y.rst index 3a24ee580..5ae5eb437 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.0.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -1,4 +1,4 @@ -Upgrading from 2.0.x to 2.1.0 +Upgrading from 2.0.x to 2.1.y ============================= .. warning:: @@ -33,6 +33,20 @@ Download the last release of wallabag: 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. diff --git a/docs/fr/index.rst b/docs/fr/index.rst index ff99948c6..d0cd0c43c 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -31,7 +31,7 @@ La documentation est disponible dans d'autres langues : 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/fr/user/upgrade-2.0.x-2.1.0.rst b/docs/fr/user/upgrade-2.0.x-2.1.y.rst similarity index 83% rename from docs/fr/user/upgrade-2.0.x-2.1.0.rst rename to docs/fr/user/upgrade-2.0.x-2.1.y.rst index 18f09a631..a4afe768d 100644 --- a/docs/fr/user/upgrade-2.0.x-2.1.0.rst +++ b/docs/fr/user/upgrade-2.0.x-2.1.y.rst @@ -1,4 +1,4 @@ -Mettre à jour de la 2.0.x à la 2.1.0 +Mettre à jour de la 2.0.x à la 2.1.y ==================================== .. warning:: @@ -33,6 +33,20 @@ Téléchargez la dernière version de wallabag : Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. +Nous avons ajouté de nouveaux paramètres dans cette nouvelle version. Vous devez donc éditer le fichier ``app/config/parameters.yml`` en ajoutant ces lignes (et en remplaçant par votre 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 + Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. Videz le répertoire ``var/cache``. From ff1f55c2a0122c1842cfb59a0431221b247f6851 Mon Sep 17 00:00:00 2001 From: Strubbl Date: Wed, 28 Sep 2016 12:26:29 +0200 Subject: [PATCH 04/11] update German upgrade-2.0.x-2.1.y.rst --- docs/de/user/upgrade-2.0.x-2.1.y.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index 32d13c6a6..cc292957f 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -2,7 +2,7 @@ Wallabag updaten ================ .. 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. +Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. Update auf einem dedizierten Webserver -------------------------------------- @@ -33,7 +33,7 @@ Lade das neueste Release von wallabag herunter: Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. -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) : +Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): .. code-block:: bash @@ -51,7 +51,7 @@ Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installat Leere den ``var/cache`` Ordner. -Sie müssen einige SQL-Abfragen ausführen, um Ihre Datenbank zu aktualisieren. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: +Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen an, dass der Tabellenpräfix ``wallabag_`` und die Datenbank MySQL ist: .. code-block:: sql From 34e4c12604977b2c57ff9eae313278fb5067f8b5 Mon Sep 17 00:00:00 2001 From: Julian Oster Date: Wed, 28 Sep 2016 13:52:06 +0200 Subject: [PATCH 05/11] Little improvements to the german translation --- docs/de/user/upgrade-2.0.x-2.1.y.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index cc292957f..85229d300 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -2,12 +2,12 @@ Wallabag updaten ================ .. warning:: -Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. +Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. Update auf einem dedizierten Webserver -------------------------------------- -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): :: @@ -31,7 +31,7 @@ Lade das neueste Release von wallabag herunter: (md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) -Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. +Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): @@ -51,7 +51,7 @@ Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installat Leere den ``var/cache`` Ordner. -Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen an, dass der Tabellenpräfix ``wallabag_`` und die Datenbank MySQL ist: +Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen in diesem Fall an, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank genutzt wird: .. code-block:: sql 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: [PATCH 06/11] Added links to async config in english doc --- docs/en/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/index.rst b/docs/en/index.rst index 026d174da..beb3816e1 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 From ff5be9720b84b97972e34d9574d1d273d9fd9bb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 16:37:36 +0200 Subject: [PATCH 07/11] Added links to async config in french doc --- docs/fr/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/fr/index.rst b/docs/fr/index.rst index d0cd0c43c..359b103c0 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -57,3 +57,5 @@ La documentation est disponible dans d'autres langues : developer/documentation developer/translate developer/maintenance + developer/redis + developer/rabbitmq From 080cb52fac8e2bf2d304c3d49ca3b96378d3587f Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Thu, 29 Sep 2016 10:36:19 +0200 Subject: [PATCH 08/11] add German rabbitmq.rst --- docs/de/developer/rabbitmq.rst | 67 ++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 docs/de/developer/rabbitmq.rst diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst new file mode 100644 index 000000000..4814a6232 --- /dev/null +++ b/docs/de/developer/rabbitmq.rst @@ -0,0 +1,67 @@ +Installiere RabbitMQ für asynchrone Aufgaben +============================================ + +Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen. + +Voraussetzungen +-------------- + +Du musst RabbitMQ auf deinem Server installiert haben. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc + apt-key add rabbitmq-signing-key-public.asc + apt-get update + apt-get install rabbitmq-server + +Konfiguration und Starten +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) + rabbitmq-server -detached + +RabbitMQ stoppen +~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmqctl stop + + +Konfigure RabbitMQ in wallabag +------------------------------ + +Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein: + +.. code:: yaml + + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + +Starte den RabbitMQ Consumer +------------------------ + +Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): + +.. code:: bash + + # for Pocket import + bin/console rabbitmq:consumer import_pocket -w + + # for Readbility import + bin/console rabbitmq:consumer import_readability -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 From 00283a3b0aa8067f7ab66376509ca4464edd93ec Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Thu, 29 Sep 2016 10:41:07 +0200 Subject: [PATCH 09/11] add German redis.rst --- docs/de/developer/redis.rst | 62 +++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/de/developer/redis.rst diff --git a/docs/de/developer/redis.rst b/docs/de/developer/redis.rst new file mode 100644 index 000000000..19800c46c --- /dev/null +++ b/docs/de/developer/redis.rst @@ -0,0 +1,62 @@ +Installiere Redis für asynchrone Aufgaben +========================================= + +Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen. + +Voraussetzungen +------------ + +Du musst Redis auf deinem Server installiert haben. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + apt-get install redis-server + +Starten +~~~~~~ + +Der Redis Service läuft eventuell schon direkt nach der Installation. Falls nicht kannst du ihn wie folgt starten: + +.. code:: bash + + redis-server + + +Konfigure Redis in wallabag +--------------------------- + +Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein: + +.. code:: yaml + + redis_host: localhost + redis_port: 6379 + + +Starte den Redis Consumer +------------------------ + +Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): + +.. code:: bash + + # for Pocket import + bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + + # for Readbility import + bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.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 + +Wenn du den Import nur für ein paar Nachrichten und nicht für alle starten willst, kannst du die Nummer (im folgenden Beispiel 12) angeben. Der Redis Worker wird dann nach der 12. Nachricht stoppen: + +.. code:: bash + + bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 From c59e628afeee9bfb2b8b358cdc81688e85cff744 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Thu, 29 Sep 2016 10:43:53 +0200 Subject: [PATCH 10/11] Added links to async config in german doc --- docs/de/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/de/index.rst b/docs/de/index.rst index 65cf89530..b3cd33b07 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -56,3 +56,5 @@ Die Dokumentation ist in anderen Sprachen verfügbar : developer/documentation developer/translate developer/maintenance + developer/redis + developer/rabbitmq 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: [PATCH 11/11] Added french documentation about Redis and RabbitMQ --- docs/de/developer/rabbitmq.rst | 18 ++++++-- docs/de/developer/redis.rst | 15 +++++-- docs/en/developer/rabbitmq.rst | 11 ++++- docs/en/developer/redis.rst | 15 +++++-- docs/fr/developer/rabbitmq.rst | 76 ++++++++++++++++++++++++++++++++++ docs/fr/developer/redis.rst | 71 +++++++++++++++++++++++++++++++ 6 files changed, 195 insertions(+), 11 deletions(-) create mode 100644 docs/fr/developer/rabbitmq.rst create mode 100644 docs/fr/developer/redis.rst diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst index 4814a6232..bea02ff49 100644 --- a/docs/de/developer/rabbitmq.rst +++ b/docs/de/developer/rabbitmq.rst @@ -4,7 +4,7 @@ Installiere RabbitMQ für asynchrone Aufgaben Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen. Voraussetzungen --------------- +--------------- Du musst RabbitMQ auf deinem Server installiert haben. @@ -27,7 +27,7 @@ Konfiguration und Starten rabbitmq-server -detached RabbitMQ stoppen -~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~ .. code:: bash @@ -48,7 +48,7 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht Starte den RabbitMQ Consumer ------------------------- +---------------------------- Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): @@ -57,11 +57,21 @@ Abhängig von welchem Service du importieren möchtest, solltest du einen Cron J # 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/de/developer/redis.rst b/docs/de/developer/redis.rst index 19800c46c..d613ce6c4 100644 --- a/docs/de/developer/redis.rst +++ b/docs/de/developer/redis.rst @@ -4,7 +4,7 @@ Installiere Redis für asynchrone Aufgaben Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen. Voraussetzungen ------------- +--------------- Du musst Redis auf deinem Server installiert haben. @@ -37,7 +37,7 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht Starte den Redis Consumer ------------------------- +------------------------- Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): @@ -46,15 +46,24 @@ Abhängig von welchem Service du importieren möchtest, solltest du einen Cron J # 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 + Wenn du den Import nur für ein paar Nachrichten und nicht für alle starten willst, kannst du die Nummer (im folgenden Beispiel 12) angeben. Der Redis Worker wird dann nach der 12. Nachricht stoppen: .. code:: bash diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index 8cee45fb6..63b851063 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 5748e260d..820a52e9e 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/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst new file mode 100644 index 000000000..20182e6ee --- /dev/null +++ b/docs/fr/developer/rabbitmq.rst @@ -0,0 +1,76 @@ +Installer RabbitMQ pour des tâches asynchrones +============================================== + +Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ. + +Pré-requis +---------- + +Vous devez installer RabbitMQ sur votre serveur. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc + apt-key add rabbitmq-signing-key-public.asc + apt-get update + apt-get install rabbitmq-server + +Configuration et démarrage +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) + rabbitmq-server -detached + +Arrêter RabbitMQ +~~~~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmqctl stop + + +Configurer RabbitMQ dans wallabag +--------------------------------- + +Modifiez votre fichier ``parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir : + +.. code:: yaml + + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + +Démarrer les clients RabbitMQ +----------------------------- + +En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job : + +.. code:: bash + + # for Pocket import + bin/console rabbitmq:consumer import_pocket -w + + # 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/fr/developer/redis.rst b/docs/fr/developer/redis.rst new file mode 100644 index 000000000..097e375d7 --- /dev/null +++ b/docs/fr/developer/redis.rst @@ -0,0 +1,71 @@ +Installer Redis pour des tâches asynchrones +=========================================== + +Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis. + +Pré-requis +---------- + +Vous devez installer Redis sur votre serveur. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + apt-get install redis-server + +Démarrage +~~~~~~~~~ + +Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas le cas, vous pouvez le démarrer ainsi : + +.. code:: bash + + redis-server + + +Configurer Redis dans wallabag +------------------------------- + +Modifiez votre fichier ``parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir : + +.. code:: yaml + + redis_host: localhost + redis_port: 6379 + + +Démarrer les clients Redis +-------------------------- + +En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job : + +.. code:: bash + + # for Pocket import + bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + + # 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 + +Si vous souhaitez démarrer l'import pour quelques messages uniquement, vous pouvez spécifier cette valeur en paramètre (ici 12) et le client va s'arrêter après le 12ème message : + +.. code:: bash + + bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12