diff options
author | Paulino Michelazzo <paulino@michelazzo.com.br> | 2016-10-18 22:48:23 +0200 |
---|---|---|
committer | Paulino Michelazzo <paulino@michelazzo.com.br> | 2016-10-18 22:48:23 +0200 |
commit | 99731f0bb1f6fd2815eeb9af504ce86df927657b (patch) | |
tree | b080efc608d2bbd52b77a4a0067402007f50c5a8 /docs/fr/developer | |
parent | 3a3c6b866b52721431bed22426d9abfcd0d2dfe0 (diff) | |
parent | 7180aaed45dce62e40620a9e4b202526ebd6a3bb (diff) | |
download | wallabag-99731f0bb1f6fd2815eeb9af504ce86df927657b.tar.gz wallabag-99731f0bb1f6fd2815eeb9af504ce86df927657b.tar.zst wallabag-99731f0bb1f6fd2815eeb9af504ce86df927657b.zip |
Merge remote-tracking branch 'wallabag/master'
Diffstat (limited to 'docs/fr/developer')
-rw-r--r-- | docs/fr/developer/maintenance.rst | 4 | ||||
-rw-r--r-- | docs/fr/developer/rabbitmq.rst | 80 | ||||
-rw-r--r-- | docs/fr/developer/redis.rst | 75 | ||||
-rw-r--r-- | docs/fr/developer/testsuite.rst | 10 |
4 files changed, 167 insertions, 2 deletions
diff --git a/docs/fr/developer/maintenance.rst b/docs/fr/developer/maintenance.rst index 4ea8d01f..8007a85f 100644 --- a/docs/fr/developer/maintenance.rst +++ b/docs/fr/developer/maintenance.rst | |||
@@ -11,7 +11,7 @@ Pour activer le mode maintenance, exécutez cette commande : | |||
11 | 11 | ||
12 | :: | 12 | :: |
13 | 13 | ||
14 | bin/console lexik:maintenance:lock --no-interaction | 14 | bin/console lexik:maintenance:lock --no-interaction -e=prod |
15 | 15 | ||
16 | Vous pouvez spécifier votre adresse IP dans ``app/config/config.yml`` si vous souhaitez accéder à wallabag même si | 16 | Vous pouvez spécifier votre adresse IP dans ``app/config/config.yml`` si vous souhaitez accéder à wallabag même si |
17 | le mode maintenance est activé. Par exemple : | 17 | le mode maintenance est activé. Par exemple : |
@@ -30,4 +30,4 @@ Pour désactiver le mode maintenance, exécutez cette commande : | |||
30 | 30 | ||
31 | :: | 31 | :: |
32 | 32 | ||
33 | bin/console lexik:maintenance:unlock | 33 | bin/console lexik:maintenance:unlock -e=prod |
diff --git a/docs/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst new file mode 100644 index 00000000..92db5a28 --- /dev/null +++ b/docs/fr/developer/rabbitmq.rst | |||
@@ -0,0 +1,80 @@ | |||
1 | Installer RabbitMQ pour des tâches asynchrones | ||
2 | ============================================== | ||
3 | |||
4 | Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ. | ||
5 | |||
6 | Pré-requis | ||
7 | ---------- | ||
8 | |||
9 | Vous devez installer RabbitMQ sur votre serveur. | ||
10 | |||
11 | Installation | ||
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 | |||
21 | Configuration 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 | |||
29 | Arrêter RabbitMQ | ||
30 | ~~~~~~~~~~~~~~~~ | ||
31 | |||
32 | .. code:: bash | ||
33 | |||
34 | rabbitmqctl stop | ||
35 | |||
36 | |||
37 | Configurer RabbitMQ dans wallabag | ||
38 | --------------------------------- | ||
39 | |||
40 | Modifiez 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 | Activer RabbitMQ dans wallabag | ||
50 | ------------------------------ | ||
51 | |||
52 | Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1). | ||
53 | |||
54 | Démarrer les clients RabbitMQ | ||
55 | ----------------------------- | ||
56 | |||
57 | En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job : | ||
58 | |||
59 | .. code:: bash | ||
60 | |||
61 | # for Pocket import | ||
62 | bin/console rabbitmq:consumer -e=prod import_pocket -w | ||
63 | |||
64 | # for Readability import | ||
65 | bin/console rabbitmq:consumer -e=prod import_readability -w | ||
66 | |||
67 | # for Instapaper import | ||
68 | bin/console rabbitmq:consumer -e=prod import_instapaper -w | ||
69 | |||
70 | # for wallabag v1 import | ||
71 | bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w | ||
72 | |||
73 | # for wallabag v2 import | ||
74 | bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w | ||
75 | |||
76 | # for Firefox import | ||
77 | bin/console rabbitmq:consumer -e=prod import_firefox -w | ||
78 | |||
79 | # for Chrome import | ||
80 | bin/console rabbitmq:consumer -e=prod import_chrome -w | ||
diff --git a/docs/fr/developer/redis.rst b/docs/fr/developer/redis.rst new file mode 100644 index 00000000..8a212e8a --- /dev/null +++ b/docs/fr/developer/redis.rst | |||
@@ -0,0 +1,75 @@ | |||
1 | Installer Redis pour des tâches asynchrones | ||
2 | =========================================== | ||
3 | |||
4 | Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis. | ||
5 | |||
6 | Pré-requis | ||
7 | ---------- | ||
8 | |||
9 | Vous devez installer Redis sur votre serveur. | ||
10 | |||
11 | Installation | ||
12 | ~~~~~~~~~~~~ | ||
13 | |||
14 | .. code:: bash | ||
15 | |||
16 | apt-get install redis-server | ||
17 | |||
18 | Démarrage | ||
19 | ~~~~~~~~~ | ||
20 | |||
21 | Le 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 | |||
28 | Configurer Redis dans wallabag | ||
29 | ------------------------------- | ||
30 | |||
31 | Modifiez 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 | Activer Redis dans wallabag | ||
39 | --------------------------- | ||
40 | |||
41 | Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1). | ||
42 | |||
43 | Démarrer les clients Redis | ||
44 | -------------------------- | ||
45 | |||
46 | En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) 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 | |||
71 | Si 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 : | ||
72 | |||
73 | .. code:: bash | ||
74 | |||
75 | bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 | ||
diff --git a/docs/fr/developer/testsuite.rst b/docs/fr/developer/testsuite.rst new file mode 100644 index 00000000..bd5c68c6 --- /dev/null +++ b/docs/fr/developer/testsuite.rst | |||
@@ -0,0 +1,10 @@ | |||
1 | Suite de tests | ||
2 | ============== | ||
3 | |||
4 | Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit <https://phpunit.de>`_. | ||
5 | |||
6 | Si vous contribuez au projet (en traduisant l'application, en corrigeant des bugs ou en ajoutant une nouvelle fonctionnalité), merci d'écrire vos propres tests. | ||
7 | |||
8 | Pour lancer la suite de tests de wallabag, vous devez installer `ant <http://ant.apache.org>`_. | ||
9 | |||
10 | Ensuite, exécutez la commande ``make test``. | ||