From 2d8af6fc7fe32dd8788cb89f8c3aec9269cbe33c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 29 Sep 2016 11:01:15 +0200 Subject: Added french documentation about Redis and RabbitMQ --- docs/fr/developer/rabbitmq.rst | 76 ++++++++++++++++++++++++++++++++++++++++++ docs/fr/developer/redis.rst | 71 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 147 insertions(+) create mode 100644 docs/fr/developer/rabbitmq.rst create mode 100644 docs/fr/developer/redis.rst (limited to 'docs/fr/developer') 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 @@ +Installer RabbitMQ pour des tâches asynchrones +============================================== + +Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ. + +Pré-requis +---------- + +Vous devez installer RabbitMQ sur votre serveur. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc + apt-key add rabbitmq-signing-key-public.asc + apt-get update + apt-get install rabbitmq-server + +Configuration et démarrage +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) + rabbitmq-server -detached + +Arrêter RabbitMQ +~~~~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmqctl stop + + +Configurer RabbitMQ dans wallabag +--------------------------------- + +Modifiez votre fichier ``parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir : + +.. code:: yaml + + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + +Démarrer les clients RabbitMQ +----------------------------- + +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 : + +.. code:: bash + + # for Pocket import + bin/console rabbitmq:consumer import_pocket -w + + # for Readability import + bin/console rabbitmq:consumer import_readability -w + + # for Instapaper import + bin/console rabbitmq:consumer import_instapaper -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 + + # for Firefox import + bin/console rabbitmq:consumer import_firefox -w + + # for Chrome import + 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 @@ +Installer Redis pour des tâches asynchrones +=========================================== + +Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis. + +Pré-requis +---------- + +Vous devez installer Redis sur votre serveur. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + apt-get install redis-server + +Démarrage +~~~~~~~~~ + +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 : + +.. code:: bash + + redis-server + + +Configurer Redis dans wallabag +------------------------------- + +Modifiez votre fichier ``parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir : + +.. code:: yaml + + redis_host: localhost + redis_port: 6379 + + +Démarrer les clients Redis +-------------------------- + +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 : + +.. code:: bash + + # for Pocket import + bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + + # for Readability import + bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log + + # for Instapaper import + bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.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 + + # for Firefox import + bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log + + # for Chrome import + bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log + +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 : + +.. code:: bash + + bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 -- cgit v1.2.3 From ba69216853b25f747591740fb039491692c1f76e Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Sat, 8 Oct 2016 09:39:07 +0200 Subject: Set env to prod in documentation --- docs/fr/developer/maintenance.rst | 4 ++-- docs/fr/developer/rabbitmq.rst | 14 +++++++------- docs/fr/developer/redis.rst | 16 ++++++++-------- 3 files changed, 17 insertions(+), 17 deletions(-) (limited to 'docs/fr/developer') 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 : :: - bin/console lexik:maintenance:lock --no-interaction + bin/console lexik:maintenance:lock --no-interaction -e=prod Vous pouvez spécifier votre adresse IP dans ``app/config/config.yml`` si vous souhaitez accéder à wallabag même si le mode maintenance est activé. Par exemple : @@ -30,4 +30,4 @@ Pour désactiver le mode maintenance, exécutez cette commande : :: - bin/console lexik:maintenance:unlock + bin/console lexik:maintenance:unlock -e=prod diff --git a/docs/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst index 20182e6e..771725a7 100644 --- a/docs/fr/developer/rabbitmq.rst +++ b/docs/fr/developer/rabbitmq.rst @@ -55,22 +55,22 @@ En fonction du service dont vous souhaitez importer vos données, vous devez act .. code:: bash # for Pocket import - bin/console rabbitmq:consumer import_pocket -w + bin/console rabbitmq:consumer -e=prod import_pocket -w # for Readability import - bin/console rabbitmq:consumer import_readability -w + bin/console rabbitmq:consumer -e=prod import_readability -w # for Instapaper import - bin/console rabbitmq:consumer import_instapaper -w + bin/console rabbitmq:consumer -e=prod import_instapaper -w # for wallabag v1 import - bin/console rabbitmq:consumer import_wallabag_v1 -w + bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w # for wallabag v2 import - bin/console rabbitmq:consumer import_wallabag_v2 -w + bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w # for Firefox import - bin/console rabbitmq:consumer import_firefox -w + bin/console rabbitmq:consumer -e=prod import_firefox -w # for Chrome import - bin/console rabbitmq:consumer import_chrome -w + bin/console rabbitmq:consumer -e=prod import_chrome -w diff --git a/docs/fr/developer/redis.rst b/docs/fr/developer/redis.rst index 097e375d..5557e7a8 100644 --- a/docs/fr/developer/redis.rst +++ b/docs/fr/developer/redis.rst @@ -44,28 +44,28 @@ En fonction du service dont vous souhaitez importer vos données, vous devez act .. code:: bash # for Pocket import - bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log # for Readability import - bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.log + bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log # for Instapaper import - bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log + bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log # for wallabag v1 import - bin/console wallabag:import:redis-worker wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log + bin/console wallabag:import:redis-worker -e=prod 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 + bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log # for Firefox import - bin/console wallabag:import:redis-worker firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log + bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log # for Chrome import - bin/console wallabag:import:redis-worker instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log + bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log 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 : .. code:: bash - bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 + bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 -- cgit v1.2.3 From 84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 09:15:53 +0200 Subject: Added documentation about testsuite Fix #2415 --- docs/fr/developer/testsuite.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/fr/developer/testsuite.rst (limited to 'docs/fr/developer') 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 @@ +Suite de tests +============== + +Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit `_. + +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. + +Pour lancer la suite de tests de wallabag, vous devez installer `ant `_. + +Ensuite, exécutez la commande ``make test``. -- cgit v1.2.3 From fa4c39b37c1e1a1b52739a070775e9ba0fafe802 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 15:38:49 +0200 Subject: Added steps about Redis/RabbitMQ activation --- docs/fr/developer/rabbitmq.rst | 4 ++++ docs/fr/developer/redis.rst | 4 ++++ 2 files changed, 8 insertions(+) (limited to 'docs/fr/developer') diff --git a/docs/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst index 771725a7..92db5a28 100644 --- a/docs/fr/developer/rabbitmq.rst +++ b/docs/fr/developer/rabbitmq.rst @@ -46,6 +46,10 @@ Modifiez votre fichier ``parameters.yml`` pour éditer la configuration RabbitMQ rabbitmq_user: guest rabbitmq_password: guest +Activer RabbitMQ dans wallabag +------------------------------ + +Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1). Démarrer les clients RabbitMQ ----------------------------- diff --git a/docs/fr/developer/redis.rst b/docs/fr/developer/redis.rst index 5557e7a8..8a212e8a 100644 --- a/docs/fr/developer/redis.rst +++ b/docs/fr/developer/redis.rst @@ -35,6 +35,10 @@ Modifiez votre fichier ``parameters.yml`` pour éditer la configuration Redis. C redis_host: localhost redis_port: 6379 +Activer Redis dans wallabag +--------------------------- + +Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1). Démarrer les clients Redis -------------------------- -- cgit v1.2.3