diff options
Diffstat (limited to 'docs/fr')
-rw-r--r-- | docs/fr/conf.py | 2 | ||||
-rw-r--r-- | docs/fr/developer/docker.rst | 2 | ||||
-rw-r--r-- | docs/fr/developer/rabbitmq.rst | 76 | ||||
-rw-r--r-- | docs/fr/developer/redis.rst | 71 | ||||
-rw-r--r-- | docs/fr/index.rst | 5 | ||||
-rw-r--r-- | docs/fr/user/import.rst | 17 | ||||
-rw-r--r-- | docs/fr/user/upgrade-2.0.x-2.0.y.rst (renamed from docs/fr/user/upgrade.rst) | 13 | ||||
-rw-r--r-- | docs/fr/user/upgrade-2.0.x-2.1.y.rst | 65 |
8 files changed, 239 insertions, 12 deletions
diff --git a/docs/fr/conf.py b/docs/fr/conf.py index f1fe3967..49a57e2d 100644 --- a/docs/fr/conf.py +++ b/docs/fr/conf.py | |||
@@ -12,7 +12,7 @@ source_suffix = '.rst' | |||
12 | master_doc = 'index' | 12 | master_doc = 'index' |
13 | project = u'wallabag-fr' | 13 | project = u'wallabag-fr' |
14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' | 14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' |
15 | version = '2.0.0' | 15 | version = '2.1.0' |
16 | release = version | 16 | release = version |
17 | exclude_patterns = ['_build'] | 17 | exclude_patterns = ['_build'] |
18 | pygments_style = 'sphinx' | 18 | pygments_style = 'sphinx' |
diff --git a/docs/fr/developer/docker.rst b/docs/fr/developer/docker.rst index 73cb56be..84724ed3 100644 --- a/docs/fr/developer/docker.rst +++ b/docs/fr/developer/docker.rst | |||
@@ -39,7 +39,7 @@ Exécuter wallabag | |||
39 | #. Editer ``app/config/parameters.yml`` pour remplacer les propriétés ``database_*`` | 39 | #. Editer ``app/config/parameters.yml`` pour remplacer les propriétés ``database_*`` |
40 | par les lignes commentées (celles avec des valeurs préfixées par ``env.``) | 40 | par les lignes commentées (celles avec des valeurs préfixées par ``env.``) |
41 | #. ``composer install`` pour installer les dépendances | 41 | #. ``composer install`` pour installer les dépendances |
42 | #. ``php app/console wallabag:install`` pour créer le schéma de la BDD | 42 | #. ``php bin/console wallabag:install`` pour créer le schéma de la BDD |
43 | #. ``docker-compose up`` pour démarrer les conteneurs | 43 | #. ``docker-compose up`` pour démarrer les conteneurs |
44 | #. Enfin, se rendre sur http://localhost:8080/ pour accéder à une installation | 44 | #. Enfin, se rendre sur http://localhost:8080/ pour accéder à une installation |
45 | tout propre de wallabag. | 45 | tout propre de wallabag. |
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 @@ | |||
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 | |||
50 | Démarrer les clients RabbitMQ | ||
51 | ----------------------------- | ||
52 | |||
53 | 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 : | ||
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 @@ | |||
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 | |||
39 | Démarrer les clients Redis | ||
40 | -------------------------- | ||
41 | |||
42 | 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 : | ||
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 | |||
67 | 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 : | ||
68 | |||
69 | .. code:: bash | ||
70 | |||
71 | bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 | ||
diff --git a/docs/fr/index.rst b/docs/fr/index.rst index dfa55afe..359b103c 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst | |||
@@ -31,7 +31,8 @@ La documentation est disponible dans d'autres langues : | |||
31 | 31 | ||
32 | user/faq | 32 | user/faq |
33 | user/installation | 33 | user/installation |
34 | user/upgrade | 34 | user/upgrade-2.0.x-2.1.y |
35 | user/upgrade-2.0.x-2.0.y | ||
35 | user/migration | 36 | user/migration |
36 | user/import | 37 | user/import |
37 | user/create_account | 38 | user/create_account |
@@ -56,3 +57,5 @@ La documentation est disponible dans d'autres langues : | |||
56 | developer/documentation | 57 | developer/documentation |
57 | developer/translate | 58 | developer/translate |
58 | developer/maintenance | 59 | developer/maintenance |
60 | developer/redis | ||
61 | developer/rabbitmq | ||
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index 99ac602b..6f114dd6 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst | |||
@@ -28,7 +28,7 @@ la section Pocket puis sur ``Se connecter à Pocket et importer les données``. | |||
28 | 28 | ||
29 | Vous devez autoriser wallabag à se connecter à votre compte Pocket. | 29 | Vous devez autoriser wallabag à se connecter à votre compte Pocket. |
30 | Vos données vont être importées. L'import de données est une action qui peut être couteuse | 30 | Vos données vont être importées. L'import de données est une action qui peut être couteuse |
31 | pour votre serveur (nous devons encore travailler pour améliorer cet import). | 31 | pour votre serveur. |
32 | 32 | ||
33 | Depuis Readability | 33 | Depuis Readability |
34 | ------------------ | 34 | ------------------ |
@@ -44,12 +44,23 @@ Importez vos données dans wallabag 2.x | |||
44 | Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans | 44 | Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans |
45 | la section Readability et ensuite sélectionnez votre fichier json pour l'uploader. | 45 | la section Readability et ensuite sélectionnez votre fichier json pour l'uploader. |
46 | 46 | ||
47 | Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur (nous devons encore travailler pour améliorer cet import). | 47 | Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur. |
48 | 48 | ||
49 | Depuis Instapaper | 49 | Depuis Instapaper |
50 | ----------------- | 50 | ----------------- |
51 | 51 | ||
52 | *Fonctionnalité pas encore implémentée dans wallabag v2.* | 52 | Exportez vos données de Instapaper |
53 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
54 | |||
55 | Sur la page des paramètres (`https://www.instapaper.com/user<https://www.instapaper.com/user>`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). | ||
56 | |||
57 | Importez vos données dans wallabag 2.x | ||
58 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
59 | |||
60 | Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans | ||
61 | la section Instapaper et ensuite sélectionnez votre fichier CSV pour l'uploader. | ||
62 | |||
63 | Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur. | ||
53 | 64 | ||
54 | 65 | ||
55 | Depuis un fichier HTML ou JSON | 66 | Depuis un fichier HTML ou JSON |
diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade-2.0.x-2.0.y.rst index e3798979..d8dfac6e 100644 --- a/docs/fr/user/upgrade.rst +++ b/docs/fr/user/upgrade-2.0.x-2.0.y.rst | |||
@@ -1,17 +1,18 @@ | |||
1 | Mettre à jour wallabag | 1 | Mettre à jour de la 2.0.x à la 2.0.y |
2 | ====================== | 2 | ==================================== |
3 | 3 | ||
4 | Mise à jour sur un serveur dédié | 4 | Mise à jour sur un serveur dédié |
5 | -------------------------------- | 5 | -------------------------------- |
6 | 6 | ||
7 | La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.0`` par le numéro de la dernière version) : | 7 | La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.8`` par le numéro de la dernière version) : |
8 | 8 | ||
9 | :: | 9 | :: |
10 | 10 | ||
11 | git fetch origin | 11 | git fetch origin |
12 | git fetch --tags | 12 | git fetch --tags |
13 | git checkout 2.1.0 | 13 | git checkout 2.0.8 |
14 | ./install.sh | 14 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist |
15 | php bin/console cache:clear --env=prod | ||
15 | 16 | ||
16 | Mise à jour sur un hébergement mutualisé | 17 | Mise à jour sur un hébergement mutualisé |
17 | ---------------------------------------- | 18 | ---------------------------------------- |
@@ -24,7 +25,7 @@ Téléchargez la dernière version de wallabag : | |||
24 | 25 | ||
25 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 26 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
26 | 27 | ||
27 | (hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) | 28 | (hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``) |
28 | 29 | ||
29 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. | 30 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. |
30 | 31 | ||
diff --git a/docs/fr/user/upgrade-2.0.x-2.1.y.rst b/docs/fr/user/upgrade-2.0.x-2.1.y.rst new file mode 100644 index 00000000..a4afe768 --- /dev/null +++ b/docs/fr/user/upgrade-2.0.x-2.1.y.rst | |||
@@ -0,0 +1,65 @@ | |||
1 | Mettre à jour de la 2.0.x à la 2.1.y | ||
2 | ==================================== | ||
3 | |||
4 | .. warning:: | ||
5 | Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajoutant votre consumer key dans les paramètres internes, pensez à effectuer une sauvegarde de celle-ci : vous devrez l'ajouter dans la configuration de wallabag après la mise à jour. | ||
6 | |||
7 | Mise à jour sur un serveur dédié | ||
8 | -------------------------------- | ||
9 | |||
10 | La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.0`` par le numéro de la dernière version) : | ||
11 | |||
12 | :: | ||
13 | |||
14 | git fetch origin | ||
15 | git fetch --tags | ||
16 | git checkout 2.1.0 | ||
17 | ASSETS=build ./install.sh | ||
18 | php bin/console doctrine:migrations:migrate --env=prod | ||
19 | php bin/console cache:clear --env=prod | ||
20 | |||
21 | Mise à jour sur un hébergement mutualisé | ||
22 | ---------------------------------------- | ||
23 | |||
24 | Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. | ||
25 | |||
26 | Téléchargez la dernière version de wallabag : | ||
27 | |||
28 | .. code-block:: bash | ||
29 | |||
30 | wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package | ||
31 | |||
32 | (hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) | ||
33 | |||
34 | Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. | ||
35 | |||
36 | Nous avons ajouté de nouveaux paramètres dans cette nouvelle version. Vous devez donc éditer le fichier ``app/config/parameters.yml`` en ajoutant ces lignes (et en remplaçant par votre configuration) : | ||
37 | |||
38 | .. code-block:: bash | ||
39 | |||
40 | # RabbitMQ processing | ||
41 | rabbitmq_host: localhost | ||
42 | rabbitmq_port: 5672 | ||
43 | rabbitmq_user: guest | ||
44 | rabbitmq_password: guest | ||
45 | |||
46 | # Redis processing | ||
47 | redis_host: localhost | ||
48 | redis_port: 6379 | ||
49 | |||
50 | Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. | ||
51 | |||
52 | Videz le répertoire ``var/cache``. | ||
53 | |||
54 | Vous allez devoir également exécuter des requêtes SQL pour mettre à jour votre base de données. Nous partons du principe que le préfixe de vos tables est ``wallabag_`` et que le serveur SQL est un serveur MySQL : | ||
55 | |||
56 | .. code-block:: sql | ||
57 | |||
58 | ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; | ||
59 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); | ||
60 | ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; | ||
61 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); | ||
62 | INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); | ||
63 | ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; | ||
64 | DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; | ||
65 | |||