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
  39 Launch Redis consumer
  40 ---------------------
  41
  42 Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
  43
  44 .. code:: bash
  45
  46   # for Pocket import
  47   bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
  48
  49   # for Readability import
  50   bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
  51
  52   # for Instapaper import
  53   bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
  54
  55   # for wallabag v1 import
  56   bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
  57
  58   # for wallabag v2 import
  59   bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
  60
  61   # for Firefox import
  62   bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
  63
  64   # for Chrome import
  65   bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
  66
  67 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 :
  68
  69 .. code:: bash
  70
  71   bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12