aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-09-29 11:01:15 +0200
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-09-29 11:01:15 +0200
commit2d8af6fc7fe32dd8788cb89f8c3aec9269cbe33c (patch)
treee7a054956c913a83fc63b12c05c58b3db5be0452 /docs
parentc59e628afeee9bfb2b8b358cdc81688e85cff744 (diff)
downloadwallabag-2d8af6fc7fe32dd8788cb89f8c3aec9269cbe33c.tar.gz
wallabag-2d8af6fc7fe32dd8788cb89f8c3aec9269cbe33c.tar.zst
wallabag-2d8af6fc7fe32dd8788cb89f8c3aec9269cbe33c.zip
Added french documentation about Redis and RabbitMQ
Diffstat (limited to 'docs')
-rw-r--r--docs/de/developer/rabbitmq.rst18
-rw-r--r--docs/de/developer/redis.rst15
-rw-r--r--docs/en/developer/rabbitmq.rst11
-rw-r--r--docs/en/developer/redis.rst15
-rw-r--r--docs/fr/developer/rabbitmq.rst76
-rw-r--r--docs/fr/developer/redis.rst71
6 files changed, 195 insertions, 11 deletions
diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst
index 4814a623..bea02ff4 100644
--- a/docs/de/developer/rabbitmq.rst
+++ b/docs/de/developer/rabbitmq.rst
@@ -4,7 +4,7 @@ Installiere RabbitMQ für asynchrone Aufgaben
4Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen. 4Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen.
5 5
6Voraussetzungen 6Voraussetzungen
7-------------- 7---------------
8 8
9Du musst RabbitMQ auf deinem Server installiert haben. 9Du musst RabbitMQ auf deinem Server installiert haben.
10 10
@@ -27,7 +27,7 @@ Konfiguration und Starten
27 rabbitmq-server -detached 27 rabbitmq-server -detached
28 28
29RabbitMQ stoppen 29RabbitMQ stoppen
30~~~~~~~~~~~~~ 30~~~~~~~~~~~~~~~
31 31
32.. code:: bash 32.. code:: bash
33 33
@@ -48,7 +48,7 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht
48 48
49 49
50Starte den RabbitMQ Consumer 50Starte den RabbitMQ Consumer
51------------------------ 51----------------------------
52 52
53Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): 53Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst):
54 54
@@ -57,11 +57,21 @@ Abhängig von welchem Service du importieren möchtest, solltest du einen Cron J
57 # for Pocket import 57 # for Pocket import
58 bin/console rabbitmq:consumer import_pocket -w 58 bin/console rabbitmq:consumer import_pocket -w
59 59
60 # for Readbility import 60 # for Readability import
61 bin/console rabbitmq:consumer import_readability -w 61 bin/console rabbitmq:consumer import_readability -w
62 62
63 # for Instapaper import
64 bin/console rabbitmq:consumer import_instapaper -w
65
63 # for wallabag v1 import 66 # for wallabag v1 import
64 bin/console rabbitmq:consumer import_wallabag_v1 -w 67 bin/console rabbitmq:consumer import_wallabag_v1 -w
65 68
66 # for wallabag v2 import 69 # for wallabag v2 import
67 bin/console rabbitmq:consumer import_wallabag_v2 -w 70 bin/console rabbitmq:consumer import_wallabag_v2 -w
71
72 # for Firefox import
73 bin/console rabbitmq:consumer import_firefox -w
74
75 # for Chrome import
76 bin/console rabbitmq:consumer import_chrome -w
77
diff --git a/docs/de/developer/redis.rst b/docs/de/developer/redis.rst
index 19800c46..d613ce6c 100644
--- a/docs/de/developer/redis.rst
+++ b/docs/de/developer/redis.rst
@@ -4,7 +4,7 @@ Installiere Redis für asynchrone Aufgaben
4Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen. 4Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen.
5 5
6Voraussetzungen 6Voraussetzungen
7------------ 7---------------
8 8
9Du musst Redis auf deinem Server installiert haben. 9Du musst Redis auf deinem Server installiert haben.
10 10
@@ -37,7 +37,7 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht
37 37
38 38
39Starte den Redis Consumer 39Starte den Redis Consumer
40------------------------ 40-------------------------
41 41
42Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): 42Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst):
43 43
@@ -46,15 +46,24 @@ Abhängig von welchem Service du importieren möchtest, solltest du einen Cron J
46 # for Pocket import 46 # for Pocket import
47 bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log 47 bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
48 48
49 # for Readbility import 49 # for Readability import
50 bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log 50 bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
51 51
52 # for Instapaper import
53 bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
54
52 # for wallabag v1 import 55 # for wallabag v1 import
53 bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log 56 bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
54 57
55 # for wallabag v2 import 58 # for wallabag v2 import
56 bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log 59 bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
57 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
58Wenn du den Import nur für ein paar Nachrichten und nicht für alle starten willst, kannst du die Nummer (im folgenden Beispiel 12) angeben. Der Redis Worker wird dann nach der 12. Nachricht stoppen: 67Wenn du den Import nur für ein paar Nachrichten und nicht für alle starten willst, kannst du die Nummer (im folgenden Beispiel 12) angeben. Der Redis Worker wird dann nach der 12. Nachricht stoppen:
59 68
60.. code:: bash 69.. code:: bash
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst
index 8cee45fb..63b85106 100644
--- a/docs/en/developer/rabbitmq.rst
+++ b/docs/en/developer/rabbitmq.rst
@@ -57,11 +57,20 @@ Depending on which service you want to import from you need to enable one (or ma
57 # for Pocket import 57 # for Pocket import
58 bin/console rabbitmq:consumer import_pocket -w 58 bin/console rabbitmq:consumer import_pocket -w
59 59
60 # for Readbility import 60 # for Readability import
61 bin/console rabbitmq:consumer import_readability -w 61 bin/console rabbitmq:consumer import_readability -w
62 62
63 # for Instapaper import
64 bin/console rabbitmq:consumer import_instapaper -w
65
63 # for wallabag v1 import 66 # for wallabag v1 import
64 bin/console rabbitmq:consumer import_wallabag_v1 -w 67 bin/console rabbitmq:consumer import_wallabag_v1 -w
65 68
66 # for wallabag v2 import 69 # for wallabag v2 import
67 bin/console rabbitmq:consumer import_wallabag_v2 -w 70 bin/console rabbitmq:consumer import_wallabag_v2 -w
71
72 # for Firefox import
73 bin/console rabbitmq:consumer import_firefox -w
74
75 # for Chrome import
76 bin/console rabbitmq:consumer import_chrome -w
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
index 5748e260..820a52e9 100644
--- a/docs/en/developer/redis.rst
+++ b/docs/en/developer/redis.rst
@@ -1,5 +1,5 @@
1Install Redis for asynchronous tasks 1Install Redis for asynchronous tasks
2======================================= 2====================================
3 3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. 4In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
5 5
@@ -37,7 +37,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s
37 37
38 38
39Launch Redis consumer 39Launch Redis consumer
40------------------------ 40---------------------
41 41
42Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: 42Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
43 43
@@ -46,15 +46,24 @@ Depending on which service you want to import from you need to enable one (or ma
46 # for Pocket import 46 # for Pocket import
47 bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log 47 bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
48 48
49 # for Readbility import 49 # for Readability import
50 bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log 50 bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
51 51
52 # for Instapaper import
53 bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
54
52 # for wallabag v1 import 55 # for wallabag v1 import
53 bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log 56 bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
54 57
55 # for wallabag v2 import 58 # for wallabag v2 import
56 bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log 59 bin/console wallabag:import:redis-worker wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
57 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
58If 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 : 67If 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 :
59 68
60.. code:: bash 69.. code:: bash
diff --git a/docs/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst
new file mode 100644
index 00000000..20182e6e
--- /dev/null
+++ b/docs/fr/developer/rabbitmq.rst
@@ -0,0 +1,76 @@
1Installer RabbitMQ pour des tâches asynchrones
2==============================================
3
4Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ.
5
6Pré-requis
7----------
8
9Vous devez installer RabbitMQ sur votre serveur.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
17 apt-key add rabbitmq-signing-key-public.asc
18 apt-get update
19 apt-get install rabbitmq-server
20
21Configuration et démarrage
22~~~~~~~~~~~~~~~~~~~~~~~~~~
23
24.. code:: bash
25
26 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
27 rabbitmq-server -detached
28
29Arrêter RabbitMQ
30~~~~~~~~~~~~~~~~
31
32.. code:: bash
33
34 rabbitmqctl stop
35
36
37Configurer RabbitMQ dans wallabag
38---------------------------------
39
40Modifiez votre fichier ``parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir :
41
42.. code:: yaml
43
44 rabbitmq_host: localhost
45 rabbitmq_port: 5672
46 rabbitmq_user: guest
47 rabbitmq_password: guest
48
49
50Démarrer les clients RabbitMQ
51-----------------------------
52
53En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
54
55.. code:: bash
56
57 # for Pocket import
58 bin/console rabbitmq:consumer import_pocket -w
59
60 # for Readability import
61 bin/console rabbitmq:consumer import_readability -w
62
63 # for Instapaper import
64 bin/console rabbitmq:consumer import_instapaper -w
65
66 # for wallabag v1 import
67 bin/console rabbitmq:consumer import_wallabag_v1 -w
68
69 # for wallabag v2 import
70 bin/console rabbitmq:consumer import_wallabag_v2 -w
71
72 # for Firefox import
73 bin/console rabbitmq:consumer import_firefox -w
74
75 # for Chrome import
76 bin/console rabbitmq:consumer import_chrome -w
diff --git a/docs/fr/developer/redis.rst b/docs/fr/developer/redis.rst
new file mode 100644
index 00000000..097e375d
--- /dev/null
+++ b/docs/fr/developer/redis.rst
@@ -0,0 +1,71 @@
1Installer Redis pour des tâches asynchrones
2===========================================
3
4Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis.
5
6Pré-requis
7----------
8
9Vous devez installer Redis sur votre serveur.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Démarrage
19~~~~~~~~~
20
21Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas le cas, vous pouvez le démarrer ainsi :
22
23.. code:: bash
24
25 redis-server
26
27
28Configurer Redis dans wallabag
29-------------------------------
30
31Modifiez votre fichier ``parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir :
32
33.. code:: yaml
34
35 redis_host: localhost
36 redis_port: 6379
37
38
39Démarrer les clients Redis
40--------------------------
41
42En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) 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
67Si vous souhaitez démarrer l'import pour quelques messages uniquement, vous pouvez spécifier cette valeur en paramètre (ici 12) et le client va s'arrêter après le 12ème message :
68
69.. code:: bash
70
71 bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12