aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/developer/redis.rst
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-11-18 09:28:20 +0100
committerGitHub <noreply@github.com>2016-11-18 09:28:20 +0100
commit19d401b15c1151bfa6c2364f31cc1eb87e7c99ef (patch)
tree9c47399f9b1a9ad2228ec365a1fd5e20edc7771f /docs/en/developer/redis.rst
parent9e0a49e6acf60c3dbf3c479cb36d404239dfda89 (diff)
parent50540682ffcaa6acf16f3b17cede3da9694c494f (diff)
downloadwallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.tar.gz
wallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.tar.zst
wallabag-19d401b15c1151bfa6c2364f31cc1eb87e7c99ef.zip
Merge pull request #2550 from wallabag/reorder-documentation
Reordered documentation
Diffstat (limited to 'docs/en/developer/redis.rst')
-rw-r--r--docs/en/developer/redis.rst75
1 files changed, 0 insertions, 75 deletions
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
deleted file mode 100644
index ea084e66..00000000
--- a/docs/en/developer/redis.rst
+++ /dev/null
@@ -1,75 +0,0 @@
1Install Redis for asynchronous tasks
2====================================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
5
6Requirements
7------------
8
9You need to have Redis installed on your server.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Launch
19~~~~~~
20
21The server might be already running after installing, if not you can launch it using:
22
23.. code:: bash
24
25 redis-server
26
27
28Configure Redis in wallabag
29---------------------------
30
31Edit your ``app/config/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
38Enable Redis in wallabag
39------------------------
40
41In internal settings, in the **Import** section, enable Redis (with the value 1).
42
43Launch Redis consumer
44---------------------
45
46Depending 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
71If 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