docs/en/developer/redis.rst

   1 Install Redis for asynchronous tasks
   2 ====================================
   3
   4 In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
   5
   6 Requirements
   7 ------------
   8
   9 You need to have Redis installed on your server.
  10
  11 Installation
  12 ~~~~~~~~~~~~
  13
  14 .. code:: bash
  15
  16   apt-get install redis-server
  17
  18 Launch
  19 ~~~~~~
  20
  21 The server might be already running after installing, if not you can launch it using:
  22
  23 .. code:: bash
  24
  25   redis-server
  26
  27
  28 Configure Redis in wallabag
  29 ---------------------------
  30
  31 Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok:
  32
  33 .. code:: yaml
  34
  35     redis_host: localhost
  36     redis_port: 6379
  37
  38 Enable Redis in wallabag
  39 ------------------------
  40
  41 In internal settings, in the **Import** section, enable Redis (with the value 1).
  42
  43 Launch Redis consumer
  44 ---------------------
  45
  46 Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
  47
  48 .. code:: bash
  49
  50   # for Pocket import
  51   bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
  52
  53   # for Readability import
  54   bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
  55
  56   # for Instapaper import
  57   bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
  58
  59   # for wallabag v1 import
  60   bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
  61
  62   # for wallabag v2 import
  63   bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
  64
  65   # for Firefox import
  66   bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
  67
  68   # for Chrome import
  69   bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
  70
  71 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 :
  72
  73 .. code:: bash
  74
  75   bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12