Merge pull request #1941 from wallabag/v2-asynchronous-jobs

Use asynchronous jobs for imports

2 files changed, 129 insertions, 0 deletions

diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst
new file mode 100644
index 00000000..8cee45fb
--- /dev/null
+++ b/docs/en/developer/rabbitmq.rst
@@ -0,0 +1,67 @@
+Install RabbitMQ for asynchronous tasks
+=======================================
+
+In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ.
+
+Requirements
+------------
+
+You need to have RabbitMQ installed on your server.
+
+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 and launch
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+  rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
+  rabbitmq-server -detached
+
+Stop RabbitMQ
+~~~~~~~~~~~~~
+
+.. code:: bash
+
+  rabbitmqctl stop
+
+
+Configure RabbitMQ in wallabag
+------------------------------
+
+Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok:
+
+.. code:: yaml
+
+    rabbitmq_host: localhost
+    rabbitmq_port: 5672
+    rabbitmq_user: guest
+    rabbitmq_password: guest
+
+
+Launch RabbitMQ 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:
+
+.. 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
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
new file mode 100644
index 00000000..5748e260
--- /dev/null
+++ b/docs/en/developer/redis.rst
@@ -0,0 +1,62 @@
+Install Redis for asynchronous tasks
+=======================================
+
+In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
+
+Requirements
+------------
+
+You need to have Redis installed on your server.
+
+Installation
+~~~~~~~~~~~~
+
+.. code:: bash
+
+  apt-get install redis-server
+
+Launch
+~~~~~~
+
+The server might be already running after installing, if not you can launch it using:
+
+.. code:: bash
+
+  redis-server
+
+
+Configure Redis in wallabag
+---------------------------
+
+Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok:
+
+.. code:: yaml
+
+    redis_host: localhost
+    redis_port: 6379
+
+
+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:
+
+.. 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
+
+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
+
+  bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12