Merge pull request #2578 from wallabag/questionmark-icon

[github/wallabag/wallabag.git] / docs / en / developer / redis.rst

diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
index 5748e260de9e363ceeab11987251dac52f1499ff..ea084e66779d1de6841a559a41a0583c7e1a2ffd 100644 (file)
--- 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.
 
@@ -28,35 +28,48 @@ The server might be already running after installing, if not you can launch it u
 Configure Redis in wallabag
 ---------------------------
 
-Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok:
+Edit your ``app/config/parameters.yml`` file to edit Redis configuration. The default one should be ok:
 
 .. code:: yaml
 
     redis_host: localhost
     redis_port: 6379
 
+Enable Redis in wallabag
+------------------------
+
+In internal settings, in the **Import** section, enable Redis (with the value 1).
 
 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
+  bin/console wallabag:import:redis-worker -e=prod 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 Readability import
+  bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
+
+  # for Instapaper import
+  bin/console wallabag:import:redis-worker -e=prod 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
+  bin/console wallabag:import:redis-worker -e=prod 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
+  bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
+
+  # for Firefox import
+  bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
+
+  # for Chrome import
+  bin/console wallabag:import:redis-worker -e=prod 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
 
-  bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12
+  bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12