wallabag/docs/en/developer/redis.rst

72 lines
2.1 KiB
ReStructuredText
Raw Normal View History

2016-09-11 20:43:16 +02:00
Install Redis for asynchronous tasks
====================================
2016-09-11 20:43:16 +02:00
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
---------------------
2016-09-11 20:43:16 +02:00
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
2016-10-08 09:39:07 +02:00
bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
2016-09-11 20:43:16 +02:00
# for Readability import
2016-10-08 09:39:07 +02:00
bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
2016-09-11 20:43:16 +02:00
# for Instapaper import
2016-10-08 09:39:07 +02:00
bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
2016-09-11 20:43:16 +02:00
# for wallabag v1 import
2016-10-08 09:39:07 +02:00
bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
2016-09-11 20:43:16 +02:00
# for wallabag v2 import
2016-10-08 09:39:07 +02:00
bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
2016-09-11 20:43:16 +02:00
# for Firefox import
2016-10-08 09:39:07 +02:00
bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
# for Chrome import
2016-10-08 09:39:07 +02:00
bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
2016-09-11 20:43:16 +02:00
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
2016-10-08 09:39:07 +02:00
bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12