mirror of
https://github.com/wallabag/wallabag.git
synced 2025-07-17 17:08:37 +00:00
Update docs about worker
This commit is contained in:
parent
015c7a8359
commit
03e078d060
2 changed files with 84 additions and 4 deletions
|
@ -1,7 +1,7 @@
|
||||||
Install RabbitMQ for asynchronous tasks
|
Install RabbitMQ for asynchronous tasks
|
||||||
=======================================
|
=======================================
|
||||||
|
|
||||||
In order to launch asynchronous tasks (useful for huge imports for example), we use RabbitMQ.
|
In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ.
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
@ -37,13 +37,31 @@ Stop RabbitMQ
|
||||||
Configure RabbitMQ in wallabag
|
Configure RabbitMQ in wallabag
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
Edit your ``parameters.yml`` file to edit RabbitMQ configuration.
|
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
|
Launch RabbitMQ consumer
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
Put this command in a cron job:
|
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
|
.. code:: bash
|
||||||
|
|
||||||
bin/console rabbitmq:consumer entries -w
|
# 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
|
||||||
|
|
62
docs/en/developer/redis.rst
Normal file
62
docs/en/developer/redis.rst
Normal file
|
@ -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
|
Loading…
Add table
Add a link
Reference in a new issue