From 3fad6c74fe72b50bceb5f1c67c3f81370660634e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 27 Apr 2016 20:30:24 +0200 Subject: Add CLI import for wallabag v2 files --- docs/en/user/migration.rst | 36 ++++++++++++++++++++---------------- docs/fr/user/migration.rst | 36 ++++++++++++++++++++---------------- 2 files changed, 40 insertions(+), 32 deletions(-) (limited to 'docs') diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index e141ae40..cfbca922 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst @@ -24,20 +24,38 @@ After creating an user account on your new wallabag v2 instance, you must head o :alt: Import from wallabag v1 :align: center +From wallabag 2.x +----------------- + +From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. + +.. image:: ../../img/user/export_v2.png + :alt: Export depuis wallabag v2 + :align: center + +From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. + +.. note:: + If you encounter issues during the export or the import, don't hesitate to `ask for support `__. + Import via command-line interface (CLI) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------------- If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: :: - bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod + bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod Please replace values: * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export +If you want to mark all these entries as read, you can add the ``--markAsRead=yes`` option. + +To import a wallabag v2 file, you need to add the option ``--importer=v2``. + You'll have this in return: :: @@ -46,17 +64,3 @@ You'll have this in return: 403 imported 0 already saved End : 05-04-2016 11:36:09 --- - -From wallabag 2.x ------------------ - -From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. - -.. image:: ../../img/user/export_v2.png - :alt: Export depuis wallabag v2 - :align: center - -From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. - -.. note:: - If you encounter issues during the export or the import, don't hesitate to `ask for support `__. diff --git a/docs/fr/user/migration.rst b/docs/fr/user/migration.rst index 66024572..a69df295 100644 --- a/docs/fr/user/migration.rst +++ b/docs/fr/user/migration.rst @@ -24,20 +24,38 @@ Une fois que vous avez créé un compte utilisateur sur votre nouvelle instance :alt: Import depuis wallabag v1 :align: center +Depuis wallabag 2.x +------------------- + +Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json. + +.. image:: ../../img/user/export_v2.png + :alt: Export depuis wallabag v2 + :align: center + +Depuis votre nouvelle instance de wallabag, créez votre compte utilisateur puis cliquez sur le lien dans le menu pour accéder à l'import. Choisissez l'import depuis wallabag v2 puis sélectionnez votre fichier json pour l'uploader. + +.. note:: + S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide `__. + Import via via la ligne de commande (CLI) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------------------- Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 : :: - bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod + bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod Remplacez les valeurs : * ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1) * ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1 +Si vous voulez marquer tous ces articles comme lus, vous pouvez ajouter l'option ``--markAsRead=yes``. + +Pour importer un fichier wallabag v2, vous devez ajouter l'option ``--importer=v2``. + Vous obtiendrez : :: @@ -46,17 +64,3 @@ Vous obtiendrez : 403 imported 0 already saved End : 05-04-2016 11:36:09 --- - -Depuis wallabag 2.x -------------------- - -Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json. - -.. image:: ../../img/user/export_v2.png - :alt: Export depuis wallabag v2 - :align: center - -Depuis votre nouvelle instance de wallabag, créez votre compte utilisateur puis cliquez sur le lien dans le menu pour accéder à l'import. Choisissez l'import depuis wallabag v2 puis sélectionnez votre fichier json pour l'uploader. - -.. note:: - S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide `__. -- cgit v1.2.3 From 235026e2c708eea306a12f1cc1de3da38593db37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 28 Apr 2016 13:41:36 +0200 Subject: Enhance option in command --- docs/en/user/migration.rst | 2 +- docs/fr/user/migration.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index cfbca922..42062796 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst @@ -52,7 +52,7 @@ Please replace values: * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export -If you want to mark all these entries as read, you can add the ``--markAsRead=yes`` option. +If you want to mark all these entries as read, you can add the ``--markAsRead`` option. To import a wallabag v2 file, you need to add the option ``--importer=v2``. diff --git a/docs/fr/user/migration.rst b/docs/fr/user/migration.rst index a69df295..91f8bab2 100644 --- a/docs/fr/user/migration.rst +++ b/docs/fr/user/migration.rst @@ -38,8 +38,8 @@ Depuis votre nouvelle instance de wallabag, créez votre compte utilisateur puis .. note:: S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide `__. -Import via via la ligne de commande (CLI) ------------------------------------------ +Import via la ligne de commande (CLI) +------------------------------------- Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 : @@ -52,7 +52,7 @@ Remplacez les valeurs : * ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1) * ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1 -Si vous voulez marquer tous ces articles comme lus, vous pouvez ajouter l'option ``--markAsRead=yes``. +Si vous voulez marquer tous ces articles comme lus, vous pouvez ajouter l'option ``--markAsRead``. Pour importer un fichier wallabag v2, vous devez ajouter l'option ``--importer=v2``. -- cgit v1.2.3 From eae86d340321a4c24a8808ebdc5242eb619b8998 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 23 May 2016 16:54:46 +0200 Subject: Prepare wallabag 2.0.5 --- docs/en/user/installation.rst | 2 +- docs/fr/user/installation.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 41542c45..2c6a2f5f 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -53,7 +53,7 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.4 + git checkout 2.0.5 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 8f9a7932..b1136c12 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -51,7 +51,7 @@ Pour installer wallabag, vous devez exécuter ces deux commandes : git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.4 + git checkout 2.0.5 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod -- cgit v1.2.3 From afbe800be237e5124ba7b4fe3a15680ebd986fc9 Mon Sep 17 00:00:00 2001 From: Even Allmighty Date: Mon, 13 Jun 2016 10:35:05 +0200 Subject: Corrected Regex for lighttpd rewrite --- docs/en/user/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 2c6a2f5f..58d9fb7e 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -226,7 +226,7 @@ Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe dir-listing.activate = "disable" url.rewrite-if-not-file = ( - "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", + "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2", "^/([^?]*)" => "/app.php?=$1", ) -- cgit v1.2.3 From 3247b907768b520299bc4adae0adcc599d0b66d8 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Mon, 23 May 2016 21:41:00 +0200 Subject: translate documentation to German --- docs/de/developer/api.rst | 270 ++++++++++++++++++++++++++ docs/de/developer/docker.rst | 57 ++++++ docs/de/developer/documentation.rst | 10 + docs/de/developer/maintenance.rst | 32 ++++ docs/de/developer/translate.rst | 57 ++++++ docs/de/index.rst | 52 +++++ docs/de/user/android.rst | 107 +++++++++++ docs/de/user/annotations.rst | 24 +++ docs/de/user/configuration.rst | 119 ++++++++++++ docs/de/user/create_account.rst | 25 +++ docs/de/user/download_articles.rst | 17 ++ docs/de/user/errors_during_fetching.rst | 28 +++ docs/de/user/faq.rst | 45 +++++ docs/de/user/filters.rst | 49 +++++ docs/de/user/first_article.rst | 68 +++++++ docs/de/user/import.rst | 46 +++++ docs/de/user/installation.rst | 326 ++++++++++++++++++++++++++++++++ docs/de/user/login.rst | 13 ++ docs/de/user/migration.rst | 62 ++++++ docs/de/user/tags.rst | 2 + docs/de/user/upgrade.rst | 32 ++++ docs/en/user/configuration.rst | 2 +- docs/fr/user/configuration.rst | 2 +- 23 files changed, 1443 insertions(+), 2 deletions(-) create mode 100644 docs/de/developer/api.rst create mode 100644 docs/de/developer/docker.rst create mode 100644 docs/de/developer/documentation.rst create mode 100644 docs/de/developer/maintenance.rst create mode 100644 docs/de/developer/translate.rst create mode 100644 docs/de/index.rst create mode 100644 docs/de/user/android.rst create mode 100644 docs/de/user/annotations.rst create mode 100644 docs/de/user/configuration.rst create mode 100644 docs/de/user/create_account.rst create mode 100644 docs/de/user/download_articles.rst create mode 100644 docs/de/user/errors_during_fetching.rst create mode 100644 docs/de/user/faq.rst create mode 100644 docs/de/user/filters.rst create mode 100644 docs/de/user/first_article.rst create mode 100644 docs/de/user/import.rst create mode 100644 docs/de/user/installation.rst create mode 100644 docs/de/user/login.rst create mode 100644 docs/de/user/migration.rst create mode 100644 docs/de/user/tags.rst create mode 100644 docs/de/user/upgrade.rst (limited to 'docs') diff --git a/docs/de/developer/api.rst b/docs/de/developer/api.rst new file mode 100644 index 00000000..f8911181 --- /dev/null +++ b/docs/de/developer/api.rst @@ -0,0 +1,270 @@ +API DoKumentation +================= + +Dank dieser Dokumentation werden wir sehen, wie wir mit der wallabag API interagieren. + +Voraussetzungen +--------------- + +* wallabag frisch (oder nicht) installiert auf http://localhost:8000 +* ``httpie`` installiert auf deinem Computer (`siehe Projektwebsite `__). Beachte, dass du die Kommandos auch mit curl oder wget nutzen kannst. +* alle API Methoden sind hier dokumentiert http://localhost:8000/api/doc + +Einen neuen API Client erstellen +-------------------------------- + +In deinem wallabag Account, kannst du einen neuen API Client unter dieser URL http://localhost:8000/developer/client/create erstellen. + +Gib dazu nur die Umleitungs-URL deiner Appliaktion an und erstelle deinen Client. Wenn deine Applikation eine Desktopapplikation ist, trage die URL, die dir am besten passt, ein. + +Du bekommst Informationen wie diese: + +:: + + Client ID: + + 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc + + Client secret: + + 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 + + +Einen Aktualisierungstoken erhalten +----------------------------------- + +Für jeden API Aufruf brauchst du einen Token. Lass uns einen erstellen mit diesem Kommando (ersetze ``client_id``, ``client_secret``, ``username`` und ``password`` mit ihren Werten): + +:: + + http POST http://localhost:8000/oauth/v2/token \ + grant_type=password \ + client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ + client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ + username=wallabag \ + password=wallabag + +Du bekommst folgendes zurück: + +:: + + HTTP/1.1 200 OK + Cache-Control: no-store, private + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 08:44:33 GMT + Host: localhost:8000 + Pragma: no-cache + X-Debug-Token: 19c8e0 + X-Debug-Token-Link: /_profiler/19c8e0 + X-Powered-By: PHP/7.0.4 + + { + "access_token": "ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA", + "expires_in": 3600, + "refresh_token": "OTNlZGE5OTJjNWQwYzc2NDI5ZGE5MDg3ZTNjNmNkYTY0ZWZhZDVhNDBkZTc1ZTNiMmQ0MjQ0OThlNTFjNTQyMQ", + "scope": null, + "token_type": "bearer" + } + +Wir werden mit dem ``access_token`` Wert in unseren nächsten Aufrufen arbeiten. + +cURL Beispiel: + +:: + + curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag" + +Existierende Einträge erhalten +------------------------------ + +Dokumentation für diese Methode: http://localhost:8000/api/doc#get--api-entries.{_format} + +Da wir auf einer neuen wallabag Installation arbeiten, bekommen wir keine Ergebnisse mit diesem Kommando: + +:: + + http GET http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +gibt zurück: + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 08:51:32 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=nrogm748md610ovhu6j70c3q63; path=/; HttpOnly + X-Debug-Token: 4fbbc4 + X-Debug-Token-Link: /_profiler/4fbbc4 + X-Powered-By: PHP/7.0.4 + + { + "_embedded": { + "items": [] + }, + "_links": { + "first": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + }, + "last": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + }, + "self": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + } + }, + "limit": 30, + "page": 1, + "pages": 1, + "total": 0 + } + +Das Array ``items`` ist leer. + +cURL Beispiel: + +:: + + curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +Deinen ersten Eintrag hinzufügen +-------------------------------- + +Dokumentation für diese Methode: http://localhost:8000/api/doc#post--api-entries.{_format} + +:: + + http POST http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" \ + url="http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" + +gibt zurück: + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 09:07:54 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=bjie40ck72kp2pst3i71gf43a4; path=/; HttpOnly + X-Debug-Token: e01c51 + X-Debug-Token-Link: /_profiler/e01c51 + X-Powered-By: PHP/7.0.4 + + { + "_links": { + "self": { + "href": "/api/entries/1" + } + }, + "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", + "created_at": "2016-04-05T09:07:54+0000", + "domain_name": "www.numerama.com", + "id": 1, + "is_archived": 0, + "is_starred": 0, + "language": "fr-FR", + "mimetype": "text/html", + "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", + "reading_time": 2, + "tags": [], + "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", + "updated_at": "2016-04-05T09:07:54+0000", + "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", + "user_email": "", + "user_id": 1, + "user_name": "wallabag" + } + +Wenn du jetzt das vorherige Kommando (siehe **Existierende Einträge erhalten**), wirst du Daten erhalten. + +cURL Beispiel: + +:: + + curl "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA&url=http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" + +Eintrag löschen +----------------- + +Dokumentation für diese Methode: http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} + +:: + + http DELETE http://localhost:8000/api/entries/1.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +gibt zurück: + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 09:19:07 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=jopgnfvmuc9a62b27sqm6iulr6; path=/; HttpOnly + X-Debug-Token: 887cef + X-Debug-Token-Link: /_profiler/887cef + X-Powered-By: PHP/7.0.4 + + { + "_links": { + "self": { + "href": "/api/entries/" + } + }, + "annotations": [], + "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", + "created_at": "2016-04-05T09:07:54+0000", + "domain_name": "www.numerama.com", + "is_archived": 0, + "is_starred": 0, + "language": "fr-FR", + "mimetype": "text/html", + "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", + "reading_time": 2, + "tags": [], + "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", + "updated_at": "2016-04-05T09:07:54+0000", + "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", + "user_email": "", + "user_id": 1, + "user_name": "wallabag" + } + +Und wenn du die existierenden Einträge nun listen willst (siehe **Existierende Einträge erhalten**), ist das Array wieder leer. + +cURL Beispiel: + +:: + + curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +Andere Methoden +--------------- + +Wir werden nicht für jede API Methode Beispiele schreiben. + +Wirf einen Blick in die Liste http://localhost:8000/api/doc, um alle Methode kennenzulernen. + + +Drittanbieter Ressourcen +------------------------ + +Einige Applikationen oder Bibliotheken nutzen unsere API. Hier ist eine nicht abschließende Aufzählung von ihnen: + +- `Java wrapper for the wallabag API `_ von Strubbl. +- `.NET library for the wallabag v2 API `_ von Julian Oster. +- `Python API for wallabag `_ von FoxMaSk, für sein Projekt `Trigger Happy `_. +- `A plugin `_ entworfen für `Tiny Tiny RSS `_, das die wallabag v2 API nutzt. Von Josh Panter. diff --git a/docs/de/developer/docker.rst b/docs/de/developer/docker.rst new file mode 100644 index 00000000..c63194aa --- /dev/null +++ b/docs/de/developer/docker.rst @@ -0,0 +1,57 @@ +Lasse wallabag in docker-compose laufen +======================================= + +Um deine eigene Entwicklungsinstanz von wallabag laufen zu lassen, +möchtest du vielleicht die vorkonfigurierten docker compose Dateien +nutzen. + +Voraussetzungen +--------------- + +Stelle sicher `Docker +`__ und `Docker +Compose `__ auf deinem +System verfügbar und aktuell zu haben. + +Wechsel des DBMS +---------------- + +Standardmäßig startet wallabag mit einer SQLite Datenbank. +Da wallabag Unterstützung für Postgresql und MySQL bietet, gibt es +auch docker Container für diese. + +In der ``docker-compose.yml`` kommentierst du für das gewählte DBMS +aus: + +- die Container Definition (``postgres`` oder ``mariadb`` root + Level Block) +- den Container Link in dem ``php`` Container +- die Container Umgebungsdatei in dem ``php`` Container + +Um mit Symfony Kommandos auf deinem Host auszuführen (wie z.B. +``wallabag:install``), sollst du außerdem: + +- die richtige Umgebungsdatei auf deiner Kommandozeile einlesen, + sodass Variablen wie ``SYMFONY__ENV__DATABASE_HOST`` existieren +- eine Zeile ``127.0.0.1 rdbms`` in deiner ``hosts`` Datei auf dem + System erstellen + +wallabag laufen lassen +---------------------- + +#. Forke und klone das Projekt +#. Bearbeite ``app/config/parameters.yml`` um ``database_*`` + Eigenschaften mit den kommentierten zu ersetzen (mit Werten + mit ``env.`` Präfix) +#. ``composer install`` die Projektabhängigkeiten +#. ``php app/console wallabag:install``, um das Schema zu erstellen +#. ``docker-compose up`` um die Container laufen zu lassen +#. Schließlich öffne http://localhost:8080/, um dein frisch + installiertes wallabag zu finden. + +In den verschiedenen Schritten wirst du vielleicht in verschiendene +Probleme laufen wie UNIX Berechtigungsprobleme, falschen Pfaden im +generierten Cache, etc.… +Operationen wie das Löschen der Cachedateien oder das Ändern der +Dateibesitzer können öfter gebraucht werden, darum habe keine Angst +sie anzupassen. diff --git a/docs/de/developer/documentation.rst b/docs/de/developer/documentation.rst new file mode 100644 index 00000000..41e19363 --- /dev/null +++ b/docs/de/developer/documentation.rst @@ -0,0 +1,10 @@ +Wirke an dieser Dokumentation mit +================================= + +Quellen der Dokumentation sind hier zu finden https://github.com/wallabag/wallabag/tree/master/docs + +Wir nutzen `ReadTheDocs `__, um sie zu generieren. + +Seiten werden in `reStructuredText `__ geschrieben. Du kannst Onlinetools wie http://rst.aaroniles.net/ oder http://rst.ninjs.org/ nutzen, um eine Vorschau deiner Artikel zu betrachten. + +Wenn du eine neue Seite erstellst, vergiss nicht die `index.rst `__ zu bearbeiten, um dort einen Link für die Seitenleiste hinzuzufügen. diff --git a/docs/de/developer/maintenance.rst b/docs/de/developer/maintenance.rst new file mode 100644 index 00000000..2a9070e1 --- /dev/null +++ b/docs/de/developer/maintenance.rst @@ -0,0 +1,32 @@ +Wartungsmodus +============= + +Wenn du längere Aufgaben auf deiner wallabag Instanz ausführen willst, kannst du den Wartungsmodus aktivieren. +Keiner wird dann Zugang zu deiner Instanz haben. + +Aktivieren des Wartungsmodus +---------------------------- + +Um den Wartungsmodus zu aktivieren, führe folgendes Kommando aus: + +:: + + bin/console lexik:maintenance:lock --no-interaction + +Du kannst deine IP Adresse in ``app/config/config.yml`` setzen, wenn du Zugriff zu wallabag haben willst, auch wenn der Wartungsmodus aktiv ist. Zum Beispiel: + +:: + + lexik_maintenance: + authorized: + ips: ['127.0.0.1'] + + +Deaktivieren des Wartungsmodus +------------------------ + +Um den Wartungsmodus zu deaktivieren, führe dieses Kommando aus: + +:: + + bin/console lexik:maintenance:unlock diff --git a/docs/de/developer/translate.rst b/docs/de/developer/translate.rst new file mode 100644 index 00000000..50e136ea --- /dev/null +++ b/docs/de/developer/translate.rst @@ -0,0 +1,57 @@ +Übersetze wallabag +================== + +wallabag Webapplikation +----------------------- + +Übersetzungsdateien +~~~~~~~~~~~~~~~~~~~ + +.. note:: + + Da wallabag hauptsächlich von einem französischem Team entwickelt wird, betrachte + die französische Übersetzung als die aktuellste und kopiere sie, um deine eigene Übersetzung zu starten. + +Du kannst die Übersetzungsdateien hier finden: https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations. + +Du musst die ``messages.CODE.yml`` und ``validators.CODE.yml`` erstellen, wobei CODE +der ISO 639-1 Code deiner Sprache ist (`siehe Wikipedia `__). + +Andere Dateien zum Übersetzen: + +- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. +- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations. + +Du musst die ``THE_TRANSLATION_FILE.CODE.yml`` Dateien erstellen. + +Konfigurationsdatei +~~~~~~~~~~~~~~~~~~~ + +Du musst die `app/config/config.yml `__ bearbeiten, +um deine Sprache auf der Konfigurationsseite in wallabag anzuzeigen (um Nutzern zu erlauben zu dieser neuen Übersetzung zu wechseln). + +Unter dem Abschnitt ``wallabag_core.languages`` musst du eine neue Zeile mit deiner Übersetzung hinzufügen. Zum Beispiel: + +:: + + wallabag_core: + ... + languages: + en: 'English' + fr: 'Français' + + +Für die erste Spalte (``en``, ``fr``, etc.) musst du den ISO 639-1 Code deiner Sprache hinzufügen (siehe oben). + +Für die zweite Spalte trägst du den Namen deiner Sprache ein. Nur den. + +wallabag Dokumentation +---------------------- + +.. note:: + + Im Gegensatz zur Webapplikation ist die Hauptsprache für die Dokumentation Englisch. + +Documentationsdateien sind hier gespeichert: https://github.com/wallabag/wallabag/tree/master/docs + +Du musst die Ordnerstruktur des Ordners ``en`` beachten, wenn du deine eigene Übersetzung startest. diff --git a/docs/de/index.rst b/docs/de/index.rst new file mode 100644 index 00000000..5311150f --- /dev/null +++ b/docs/de/index.rst @@ -0,0 +1,52 @@ +wallabag Dokumentation +====================== + +.. image:: ../img/wallabag.png + :alt: wallabag Logo + :align: center + +**wallabag** ist eine Read-it-later Applikation: es speichert Websites, +indem es nur den Inhalt behält. Elemente wie Navigation oder Werbung werden gelöscht. + +.. tip:: + + Diese Dokumentation ist über wallabag v2. Wenn du die Dokumentation für wallabag v1 lesen willst, `siehe dir bitte das hier an `__. + +Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organisiert: + +* :ref:`user-docs` +* :ref:`dev-docs` + +.. _user-docs: + +.. toctree:: + :maxdepth: 2 + :caption: Nutzerdokumentation + + user/faq + user/installation + user/upgrade + user/migration + user/import + user/create_account + user/login + user/configuration + user/first_article + user/errors_during_fetching + user/annotations + user/download_articles + user/filters + user/tags + user/android + +.. _dev-docs: + +.. toctree:: + :maxdepth: 2 + :caption: Entwicklerdokumentation + + developer/api + developer/docker + developer/documentation + developer/translate + developer/maintenance diff --git a/docs/de/user/android.rst b/docs/de/user/android.rst new file mode 100644 index 00000000..8573bcb8 --- /dev/null +++ b/docs/de/user/android.rst @@ -0,0 +1,107 @@ +Android App +=========== + + +Zweck dieses Dokuments +---------------------- + +Dieses Dokument beschreibt wie du deine Android App einrichtest, damit sie mit deiner Wallabaginstanz zusammenarbeitet. Es gibt hierbei keinen Unterschied im Vorgang - egal ob du Wallabag v1 oder v2 einsetzt. + + +Schritte, um dein App zu einzurichten +------------------------------------- + +Wenn du das erste Mal die App startest, siehst du den Willkommensbildschirm, wo du angewiesen wirst zunächst deine App mit deiner Wallabaginstanz einzurichten. + +.. image:: ../../img/user/android_welcome_screen.de.png + :alt: Willkommensbildschirm + :align: center + +Bestätige nur diese Nachricht und du wirst zum Einstellungsbildschirm weitergeleitet. + +.. image:: ../../img/user/android_configuration_screen.de.png + :alt: Einstellungsbildschirm + :align: center + +Trage deine Wallabagdaten ein. Du musst deine Wallabagadresse eintragen. Es ist wichtig, dass die URL nicht mit einem Schrägstrich endet. Füge auch deine Wallabagzugangsdaten in das Nutzer- und Passwortfeld ein. + +.. image:: ../../img/user/android_configuration_filled_in.de.png + :alt: Eingetragene Einstellungen + :align: center + +Nachdem du deine Daten eingetragen hast, drücke den Button Verbindung testen und warte auf das Fertigstellen des Tests. + +.. image:: ../../img/user/android_configuration_connection_test.de.png + :alt: Verbindungstest mit deinen Wallabagdaten + :align: center + +Der Verbindungstest sollte mit Erfolg ausgehen. Falls nicht, musst du zunächst deine Daten korrigieren bevor du zum nächsten Schritt gehst. + +.. image:: ../../img/user/android_configuration_connection_test_success.de.png + :alt: Verbindungstest war erfolgreich + :align: center + +Nach dem Verbindungstest erfolgreich war, kannst du den Button zum Feedzugangsdaten abholen drücken. Die App versucht nun sich bei deiner Wallabaginstanz einzuloggen und die Nutzer ID und den dazugehörigen Token für die Feeds zu laden. + +.. image:: ../../img/user/android_configuration_get_feed_credentials.de.png + :alt: Feedzugangsdaten abholen + :align: center + +Wenn der Prozess des Abholens deiner Feedzugangsdaten erfolgreich beendet wurde, siehst du eine Toastnachricht, dass die User ID und der Token automatisch in das Formular eingetragen wurden. + +.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.de.png + :alt: Feedzugangsdaten erfolgreich abgeholt + :align: center + +Jetzt scrollst du bis zum unteren Rand des Einstellungsbildschirms. Natürlich kannst du die Einstellungen dort deinen Wünschen anpassen. Schließe die Einrichtung mit dem Drücken des Speicherbuttons ab. + +.. image:: ../../img/user/android_configuration_scroll_bottom.de.png + :alt: unterer Rand des Einstellungsbildschirms + :align: center + +Nachdem du den Speicherbutton gedrückt hast, kommst du in den folgenden Bildschirm. Die App schlägt vor, eine initiale Synchronisation der Artikelfeeds durchzuführen. Hier ist es empfohlen, dies zu bestätigen und Ja zu drücken. + +.. image:: ../../img/user/android_configuration_saved_feed_update.de.png + :alt: Einstellung erstmals gespeichert + :align: center + +Schließlich nach der ersten erfolgreichen Synchronisation, wird dir die Liste der ungelesenen Artikel präsentiert. + +.. image:: ../../img/user/android_unread_feed_synced.de.png + :alt: Gefüllte Artikellist da Feeds erfolgreich synchronisiert sind + :align: center + + + +Bekannte Limitierungen +--------------------- + +2FA +~~~ + +Zur Zeit unterstützt die App keine Zwei-Faktor Authentifizierung. Du solltest sie deaktivieren damit die App funktioniert. + + +Begrenzte Anzahl Artikel mit Wallabag v2 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In deiner Wallabaginstanz kannst du einstellen, wie viele Artikel Teil deiner RSS Feeds sind. Diese Option existierte in Wallabag v1 nicht, wo immer alle Artikel Teil des Feeds waren. Also wenn du die Anzahl der Artikel, die in der App angezeigt werden sollen, größer einstellst als die Anzahl Artikel in deinem Feed, wirst du nur die Anzahl an Artikel deines Feeds sehen. + + +SSL/TLS Verschlüsselung +~~~~~~~~~~~~~~~~~~~~~~~ + +Wenn du deine Wallabaginstanz per HTTPS erreichen kannst, solltest du das so konfigurieren. Besonders dann, wenn deine HTTP URL nach HTTPS umleitet. Im Moment kann die App mit dieser Weiterleitung nicht korrekt umgehen. + + +Referenzen +---------- + +`Quellcode der Android Applikation `_ + +`Android Applikation auf F-Droid `_ + +`Android Applikation auf Google Play `_ + +`Support Chat auf English `_ + diff --git a/docs/de/user/annotations.rst b/docs/de/user/annotations.rst new file mode 100644 index 00000000..4b4d58b0 --- /dev/null +++ b/docs/de/user/annotations.rst @@ -0,0 +1,24 @@ +Anmerkungen +=========== + +In jedem Artikel, den du liest, kannst du Anmerkungen hinzufügen. Es ist einfacher mit ein paar Bilder erklärt. + +Wähle den Teil des Artikels aus, den du kommentieren willst und klicke auf den Bleistift: + +.. image:: ../../img/user/annotations_1.png + :alt: Wähle den Text + :align: center + +Schreibe deinen Kommentar: + +.. image:: ../../img/user/annotations_2.png + :alt: Schreibe deinen Kommentar + :align: center + +Der Text ist nun hervorgehoben und du kannst deine Anmerkung lesen, wenn du den Mauspfeil darüber fährst. + +.. image:: ../../img/user/annotations_3.png + :alt: lese deine Anmerkung + :align: center + +Du kannst so viele Anmerkungen erstellen wie du möchtest. diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst new file mode 100644 index 00000000..67695ff1 --- /dev/null +++ b/docs/de/user/configuration.rst @@ -0,0 +1,119 @@ +Konfiguration +============= + +Nun, da du eingeloggt bist, ist es Zeit, deinen Account so zu konfigurieren, +wie du möchtest. + +Klicke auf ``Konfiguration`` im Menü. Du hast fünf Karteireiter: ``Einstellungen``, +``RSS``, ``Benutzer-Informationen``, ``Kennwort`` und ``Tagging-Regeln``. + +Einstellungen +------------- + +Theme +~~~~~ + +wallabag ist anpassbar. Du kannst dein bevorzugtes Theme hier auswählen. Du kannst +auch ein neues erstellen, ein extra Kapitel wird dem gewidmet sein. Das Standardtheme +ist ``Material``, es ist das Theme, dass in den Dokumentationsbildschirmfotos genutzt wird. + +Artikel pro Seite +~~~~~~~~~~~~~~~~~ + +Du kannst die Anzahl der dargestellten Artikel pro Seite ändern. + +Lesegeschwindigkeit +~~~~~~~~~~~~~~~~~~~ + +wallabag berechnet die Lesezeit für jeden Artikel. Du kannst hier definieren, dank dieser Liste, ob du +ein schneller oder langsamer Leser bist. wallabag wird die Lesezeit für jeden Artikel neu berechnen. + +Sprache +~~~~~~~ + +Du kannst die Sprache von der wallabag Benutzeroberfläche ändern. Du musst die ausloggen, damit diese +Änderung Wirkung zeigt. + +RSS +--- + +wallabag stellt RSS Feeds für jeden Artikelstatus bereit: ungelesen, Favoriten und Archiv. + +Als erstes musst du einen persönlciehn Token erstellen: Klicke auf ``Token generieren``. +Es ist möglich deinen Token zu ändern, indem du auf ``Token zurücksetzen`` klickst. + +Jetzt hast du drei Links, einen für jeden Status: Füge sie in deinem liebsten Feedreader hinzu. + +Du kannst auch definieren wie viele Artikel du in deinem RSS Feed (Standardwert: 50) haben willst. + +Benutzer-Informationen +---------------------- + +Du kannst deinen Namen ändern, deine E-Mail-Adresse und die Zwei-Faktor-Authentifizierung aktivieren. + +Zwei-Faktor-Authentifizierung +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Die Zwei-Faktor-Authentifizierung (2FA) dient dem Identitätsnachweis eines Nutzers mittels der + Kombination zweier verschiedener und insbesondere unabhängiger Komponenten (Faktoren). + +https://de.wikipedia.org/wiki/Zwei-Faktor-Authentifizierung + +Wenn du 2FA aktivierst, erhälst du jedes Mal, wenn du dich bei wallabag einloggen willst, einen Code per +Mail. Du musst den Code in das folgende Formular eingeben. + +.. image:: ../../img/user/2FA_form.png + :alt: Zwei-Faktor-Authentifizierung + :align: center + +Wenn du nicht jedes Mal, wenn du dich einloggen willst, einen Code zugesendet bekommen möchtest, kannst du +die Checkbox ``Ich bin an einem persönlichen Computer`` anhaken: wallabag wird sich an dich für 15 Tage +erinnern. + +Passwort +-------- + +Du kannst dein Passwort hier ändern (8 Zeichen Minimum). + +Tagging-Regeln +-------------- + +Wenn du automatisch einen Tag zu einem neuen Artikel zuweisen lassen möchtest, ist dieser Teil der +Konfiguration, was du suchst. + +Was ist mit Tagging-Regeln gemeint? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Dies sind Regeln, die von wallabag genutzt werden, um neue Artikel automatisch zu taggen +Jedes Mal, wenn ein neuer Artikel hinzugefügt wird, werden alle Tagging-Regeln genutzt, um deine +konfigurierten Tags hinzuzufügen, folglich um dir den Aufwand zu sparen, die Artikel manuell einzuteilen. + +Wie benutze ich sie? +~~~~~~~~~~~~~~~~~~~~ + +Nehmen wir an, du möchtest neuen Artikeln einen Tag *schnell gelesen*, wenn du die Lesezeit kleiner als +3 Minuten ist. +In diesem Fall solltest du in das Regelfeld "readingTime <= 3" eintragen und *schnell gelesen* in das Tags-Feld. +Mehrere Tags können gleichzeitig hinzugefügt werden, wenn man sie mit einem Komma trennt: +*schnell gelesen, Pflichtlektüre*. +Komplexe Regeln können mit vordefinierten Operatoren geschrieben werden: +Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu lesen, github*. + +Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen: + +=========== ============================================== ======== ========== +Variable Bedeutung Operator Bedeutung +----------- ---------------------------------------------- -------- ---------- +title Titel des Artikels <= Kleiner gleich als… +url URL des Artikels < Kleiner als… +isArchived Ob der Artikel archiviert ist oder nicht => Größer gleich als… +isStarred Ob der Artikel favorisiert ist oder nicht > Größer als… +content Inhalt des Eintrags = Gleich zu… +language Sprache des Eintrags != Nicht gleich zu… +mimetype MIME-Typ des Eintrags OR Eine Regel oder die andere +readingTime Die geschätzte Lesezeit in Minuten AND Eine Regel und die andere +domainName Der Domain-Name des Eintrags matches Testet, dass ein Feld einer Suche (unabhängig von Groß- und Kleinschreibung) übereinstimmt. Z.B.: title matches "Fußball" +=========== ============================================== ======== ========== diff --git a/docs/de/user/create_account.rst b/docs/de/user/create_account.rst new file mode 100644 index 00000000..ce1b02a4 --- /dev/null +++ b/docs/de/user/create_account.rst @@ -0,0 +1,25 @@ +Account erstellen +================= + +Klicke auf der Loginseite auf den ``Registrieren`` Button- + +.. image:: ../../img/user/registration_form.png + :alt: Registrierungsformular + :align: center + +Du musst das Formular ausfüllen. Bitte stelle sicher, dass du eine gültige +E-Mail-Adresse eingibst, wir werden dir eine Aktivierungsmail schicken. + +.. image:: ../../img/user/sent_email.png + :alt: E-Mail wurde gesendet, um Account zu aktivieren + :align: center + +Überprüfge deinen Posteingang, du hast jetzt eine neue Mail mit einem Link wie diesen +``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. +Klicke auf den Link, um deinen Account zu aktivieren. + +Dein Account ist nun aktiviert. + +.. image:: ../../img/user/activated_account.png + :alt: Willkommen! + :align: center diff --git a/docs/de/user/download_articles.rst b/docs/de/user/download_articles.rst new file mode 100644 index 00000000..6f5384b2 --- /dev/null +++ b/docs/de/user/download_articles.rst @@ -0,0 +1,17 @@ +Artikel herunterladen +===================== + +Du kannst jeden Artikel in verschiedenen Formaten herunterladen: ePUB, MOBI, PDF, XML, JSON, CSV. + +In der Artikelansicht, klickst du auf dieses Icon in der Seitenleiste: + +.. image:: ../../img/user/download_article.png + :alt: Artikel herunterladen + :align: center + +Du kannst auch eine ganze Kategorie (ungelesen, Favoriten, Archiv) in diesen Formaten herunterladen. +Zum Beispiel, in der Ansicht **Ungelesen**, klickst du auf das Icon in der oberen Leiste: + +.. image:: ../../img/user/download_articles.png + :alt: Artikel herunterladen + :align: center diff --git a/docs/de/user/errors_during_fetching.rst b/docs/de/user/errors_during_fetching.rst new file mode 100644 index 00000000..b8e3e999 --- /dev/null +++ b/docs/de/user/errors_during_fetching.rst @@ -0,0 +1,28 @@ +Fehler während des Artikelladens +================================ + +Warum schlägt das Laden eines Artikels fehl? +-------------------------------------------- + +Das kann verschiedene Ursachen haben: + +- Netzwerkprobleme +- wallabag kann den Inhalt aufgrund der Websitestruktur nicht laden + +Wie kann ich helfen das zu beheben? +----------------------------------- + +- `indem du uns eine Mail mit der URL des Artikels sendest `_ +- indem du versuchst das Laden des Artikels durch Erstellen einer Datei für den Artikel + selbst zu beheben + Du kannst `dieses Tool `__ nutzen. + +Wie kann ich versuchen, einen Artikel erneut zu laden? +------------------------------------------------------ + +Wenn wallabag beim Laden eines Artikels fehlschlägt, kannst du auf den erneut laden Button +klicken (der dritte in dem unteren Bild). + +.. image:: ../../img/user/refetch.png + :alt: Inhalt neu laden + :align: center diff --git a/docs/de/user/faq.rst b/docs/de/user/faq.rst new file mode 100644 index 00000000..1a199c1c --- /dev/null +++ b/docs/de/user/faq.rst @@ -0,0 +1,45 @@ +Häufig gestellte Fragen +========================== + +Während der Installation sehe ich den Fehler ``Error Output: sh: 1: @post-cmd: not found`` +------------------------------------------------------------------------------------------ + +Es scheint, dass du ein Problem bei deiner ``composer`` Installation hast. Versuche es zu deinstallieren und neu zu installieren. + +`Lies die Dokumentation über composer, um zu erfahren wie es installiert wird +`__. + +Ich kann das Registrierungsformular nicht validieren +---------------------------------------------------- + +Stelle sicher, dass alle Felder ausgefüllt sind: + +* valide E-Mail-Adresse +* das gleiche Passwort in zwei Feldern + +Ich erhalte meine Aktivierungsmail nicht +---------------------------------------- + +Bist du sicher, dass deine eingegebene E-Mail-Adresse korrekt war? Hast du deinen Spamordner überprüft? + +Wenn du dann immer noch nicht deine Aktivierungsmail siehst, stelle bitte sicher, dass du einen MTA +korrekt installiert und eingerichtet hast. Prüfe, dass deine Firewallregel existiert, z.B. für firewalld: + +:: + firewall-cmd --permanent --add-service=smtp + firewall-cmd --reload + +Schließlich, falls du SELinux aktiviert hast, setze folgende Regel: + +``setsebool -P httpd_can_sendmail 1`` + +Wenn ich den Aktivierungslink klicke, bekomme ich die Nachricht ``Der Nutzer mit dem Bestätigungstoken "DtrOPfbQeVkWf6N" existiert nicht`` +------------------------------------------------------------------------------------------------------------------------------------------ + +Du hast deinen Account schon aktiviert oder die URL der Aktivierungsmail ist falsch. + +Ich habe mein Passwort vergessen +-------------------------------- + +Du kannst dein Passwort zurücksetzen, indem du auf den Link ``Kennwort vergessen?`` auf der Loginseite klickst. Fülle dann das Formular mit deiner E-Mail-Adresse oder deinem Nutzernamen aus +und du wirst eine E-Mail zum Passwort zurücksetzen erhalten. diff --git a/docs/de/user/filters.rst b/docs/de/user/filters.rst new file mode 100644 index 00000000..c9cda6b6 --- /dev/null +++ b/docs/de/user/filters.rst @@ -0,0 +1,49 @@ +Filter +====== + +Um Artikel leichter zu erreichen, kannst du sie filtern. +Klicke auf das dritte Symbol in der oberen Leiste. + +.. image:: ../../img/user/topbar.png + :alt: Obere Leiste + :align: center + +Alle diese Filter können kombiniert werden. + +.. image:: ../../img/user/filters.png + :alt: Kombiniere alle Filter + :align: center + +Status +------ + +Nutze die Checkboxen, um einen archivierten oder favorisierten Artikel zu finden. + +Vorschaubild +--------------- + +Hake diesen Filter an, wenn du Artikel mit einem Vorschaubild erhalten willst. + +Sprache +------- + +wallabag (via graby) kann die Artikelsprache erkennen. Es ist einfach für dich, Artikel +in einer bestimmten Sprache zu filtern. + +Lesezeit +-------- + +wallabag schätzt wieviel Zeit du brauchst, um einen Artikel zu lesen. Mit diesem Filter +kannst du zum Beispiel Artikel mit einer Lesezeit zwischen 2 und 5 Minuten finden. + +Domainname +---------- + +Dank dieses Filters, kannst ud Artikel von der gleichen Domain finden. +Zum Beispiel tippst du in diesem Feld ``bbc.co.uk``, um Artikel dieser Website zu finden. + +Erstellungsdatum +---------------- + +Wenn du Artikel speicherst, merkt sich wallabag das aktuelle Datum. So praktisch, um Aritkel, die +zwischen dem 1. und 31. Januar geschrieben sind, zu finden. diff --git a/docs/de/user/first_article.rst b/docs/de/user/first_article.rst new file mode 100644 index 00000000..b8ceda07 --- /dev/null +++ b/docs/de/user/first_article.rst @@ -0,0 +1,68 @@ +Speichere deinen ersten Artikel +=============================== + +Der Hauptzweck von wallabag ist es Webartikel zu speichern. Du hast viele Wege das zu tun. + +.. note:: + + Eine Schnellstartanleitung wird in der Anwendung angezeigt bis du deinen ersten + Artikel gespeichert hast. + +Durch Nutzung eines Bookmarklets +-------------------------------- + +Auf der ``How-To`` Seite, hast du einen Reiter ``Bookmarklet``. Ziehe und lasse den +``bag it!`` Link in die Lesezeichenleiste deines Browser los. + +Jetzt kannst du immer wenn du einen Artikel im Web liest und ihn du ihn speichern +willst, klicke auf den ``bag it!`` Link in deiner Lesezeichenleiste. Der Artikel +wird gespeichert. + +Durch Nutzung des klassischen Formulars +--------------------------------------- + +In der oberen Leiste auf deinem Bildschirm, hast du drei Icons. Mit dem ersten, einem +Pluszeichen, kannst du einfach neue Artikel speichern. + +.. image:: ../../img/user/topbar.png + :alt: obere Leiste + :align: center + +Klick darauf, um ein neues Feld anzeigen zu lassen, füge deine Artikel URL ein und +drücke die ``Enter`` Taste. Der Artikel wird gespeichert. + +Durch Nutzung eines Browser Add-ons +----------------------------------- + +Firefox +~~~~~~~ + +*Dieses Addon ist noch nicht für wallbag v2 verfügbar*. + +Chrome +~~~~~~ + +*Dieses Addon ist noch nicht für wallbag v2 verfügbar*. + +Durch Nutzung deiner Smartphone App +----------------------------------- + +Android +~~~~~~~ + +*Diese Applikation ist noch nicht für wallbag v2 verfügbar*. + +Firefox OS +~~~~~~~~~~ + +*Diese Applikation ist noch nicht für wallbag v2 verfügbar*. + +Windows Phone +~~~~~~~~~~~~~ + +*Diese Applikation ist noch nicht für wallbag v2 verfügbar*. + +iOS +~~~ + +*Diese Applikation ist noch nicht für wallbag v2 verfügbar*. diff --git a/docs/de/user/import.rst b/docs/de/user/import.rst new file mode 100644 index 00000000..ecd3134b --- /dev/null +++ b/docs/de/user/import.rst @@ -0,0 +1,46 @@ +Migration von einem Drittanbieter +================================= + +Von Pocket +----------- + +Erstelle eine neue Applikation in Pocket +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Um deine Daten von Pocket zu importieren, nutzen wir die Pocket API. Du musst +eine neue Applikation auf ihrer Entwicklerwebsite erstellen, um fortzufahren. + +* Erstelle eine neue Applikation `auf der Entwicklerwebsite `_ +* Fülle die erforderlichen Felder aus: Name, Beschreibung, Berechtigungen (nur **abrufen**), Plattform + (**web**), akzeptiere die Nutzungsbedingungen und reiche deine neue Applikation ein + +Pocket wird dir einen **Consumer Key** geben (z.B. `49961-985e4b92fe21fe4c78d682c1`). +Du musst den ``pocket_consumer_key`` in dem Abschnitt ``Import`` in dem ``Interne Einstellungen`` Menü +konfigurieren. + +Jetzt ist alles in Ordnung, um von Pocket zu migrieren. + +Importiere deine Daten in wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Klicke auf den ``Importieren`` Link im menü, auf ``Inhalte importieren`` in dem Pocketabschnitt und +dann auf ``Verbinde mit Pocket und importieren Daten``. + +Du musst wallabag erlauben, mit deinem Pocketaccount zu interagieren. +Deine Daten werden importiert. Datenimport kann ein sehr anspruchsvoller Prozess für deinen Server +sein (wir müssen daran arbeiten, um diesen Import zu verbessern). + +Von Instapaper +-------------- + +*Funktion noch nicht implementiert in wallabag v2.* + +Von Readability +--------------- + +*Funktion noch nicht implementiert in wallabag v2.* + +Von einer HTML oder JSON Datei +------------------------------ + +*Funktion noch nicht implementiert in wallabag v2.* diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst new file mode 100644 index 00000000..37a80170 --- /dev/null +++ b/docs/de/user/installation.rst @@ -0,0 +1,326 @@ +Installation von wallabag +========================= + +Voraussetzungen +--------------- + +wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. + +Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell +nicht alle folgenden Pakete installieren. + +- php-session +- php-ctype +- php-dom +- php-hash +- php-simplexml +- php-json +- php-gd +- php-mbstring +- php-xml +- php-tidy +- php-iconv +- php-curl +- php-gettext +- php-tokenizer + +wallabag nutzt PDO, um sich mit der Datenbank zu verbinden, darum benötigst du eines der folgenden Komponenten: + +- pdo_mysql +- pdo_sqlite +- pdo_pgsql + +und dessen dazugehörigen Datenbankserver. + +Installation +------------ + +Auf einem dedizierten Webserver (empfohlener Weg) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. + +Composer installieren: + +:: + + curl -s http://getcomposer.org/installer | php + +Du kannst eine spezifische Anleitung `hier `__ finden: + +Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: + +:: + + git clone https://github.com/wallabag/wallabag.git + cd wallabag + git checkout 2.0.5 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console wallabag:install --env=prod + +Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: + +:: + + php bin/console server:run --env=prod + +Und wallabag unter http://deineserverip:8000 erreichen + +.. tip:: + + Um Parameter mit Umgebungsvariable zu definieren, musst du die Variable mit dem ``SYMFONY__`` Präfix setzen. Zum Beispiel ``SYMFONY__DATABASE_DRIVER``. Du kannst einen Blick die `Symfony Dokumentation `__ werfen. + +Auf einem geteilten Webhosting +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Wir stellen ein Paket inkl. aller Abhängigkeiten bereit. +Die Standardkonfiguration nutzt SQLite für die Datenbank. Wenn du diese Einstellung ändern willst, ändere bitte ``app/config/parameters.yml``. + +Wir haben bereits einen Nutzer erstellt: Login und Passwort sind ``wallabag``. + +.. caution:: Mit diesem Paket überprüft wallabag nicht die von der Applikation gebrauchten Exentions (diese Tests werden während ``composer install`` durchgeführt wenn du einen dedizierten Webserver hast, siehe oben). + +Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacken: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. +Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``. + +Installation mit Docker +------------------------ + +Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub `__, um mehr Informationen zu erhalten. + +Kommando, um den Container zu starten +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: bash + + docker pull wallabag/wallabag + +Virtualhosts +------------ + +Konfiguration von Apache +~~~~~~~~~~~~~~~~~~~~~~~ + +Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren und du willst PHP als Apache Modul nutzen, dann ist hier ein vhost für wallabag: + +:: + + + ServerName domain.tld + ServerAlias www.domain.tld + + DocumentRoot /var/www/wallabag/web + + AllowOverride None + Order Allow,Deny + Allow from All + + + Options -MultiViews + RewriteEngine On + RewriteCond %{REQUEST_FILENAME} !-f + RewriteRule ^(.*)$ app.php [QSA,L] + + + + # uncomment the following lines if you install assets as symlinks + # or run into problems when compiling LESS/Sass/CoffeScript assets + # + # Options FollowSymlinks + # + + # optionally disable the RewriteEngine for the asset directories + # which will allow apache to simply reply with a 404 when files are + # not found instead of passing the request into the full symfony stack + + + RewriteEngine Off + + + ErrorLog /var/log/apache2/wallabag_error.log + CustomLog /var/log/apache2/wallabag_access.log combined + + +Nach dem du Apache neugeladen oder neugestartet hast, solltest du nun wallabag unter http://domain.tld erreichen. + +Konfiguration von Nginx +~~~~~~~~~~~~~~~~~~~~~~~ + +Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag: + +:: + + server { + server_name domain.tld www.domain.tld; + root /var/www/wallabag/web; + + location / { + # try to serve file directly, fallback to app.php + try_files $uri /app.php$is_args$args; + } + location ~ ^/app\.php(/|$) { + fastcgi_pass unix:/var/run/php5-fpm.sock; + fastcgi_split_path_info ^(.+\.php)(/.*)$; + include fastcgi_params; + # When you are using symlinks to link the document root to the + # current version of your application, you should pass the real + # application path instead of the path to the symlink to PHP + # FPM. + # Otherwise, PHP's OPcache may not properly detect changes to + # your PHP files (see https://github.com/zendtech/ZendOptimizerPlus/issues/126 + # for more information). + fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name; + fastcgi_param DOCUMENT_ROOT $realpath_root; + # Prevents URIs that include the front controller. This will 404: + # http://domain.tld/app.php/some-path + # Remove the internal directive to allow URIs like this + internal; + } + + error_log /var/log/nginx/wallabag_error.log; + access_log /var/log/nginx/wallabag_access.log; + } + +Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http://domain.tld erreichen. + +.. tip:: + + When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. + Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``. + +Konfiguration von lighttpd +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag (bearbeite deine ``lighttpd.conf`` und füge die Konfiguration dort ein): + +:: + + server.modules = ( + "mod_fastcgi", + "mod_access", + "mod_alias", + "mod_compress", + "mod_redirect", + "mod_rewrite", + ) + server.document-root = "/var/www/wallabag/web" + server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) + server.errorlog = "/var/log/lighttpd/error.log" + server.pid-file = "/var/run/lighttpd.pid" + server.username = "www-data" + server.groupname = "www-data" + server.port = 80 + server.follow-symlink = "enable" + index-file.names = ( "index.php", "index.html", "index.lighttpd.html") + url.access-deny = ( "~", ".inc" ) + static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" ) + compress.cache-dir = "/var/cache/lighttpd/compress/" + compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" ) + include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port + include_shell "/usr/share/lighttpd/create-mime.assign.pl" + include_shell "/usr/share/lighttpd/include-conf-enabled.pl" + dir-listing.activate = "disable" + + url.rewrite-if-not-file = ( + "^/([^?]*)(?:\?(.*))?" => "/app.php?$1&$2", + "^/([^?]*)" => "/app.php?=$1", + ) + +Rechte, um das Projektverzeichnis zu betreten +--------------------------------------------- + +Testumgebung +~~~~~~~~~~~~ + +Wenn wir nur wallabag testen wollen, führen wir nur das Kommando ``php bin/console server:run --env=prod`` aus, um unsere wallabag Instanz zu starten und alles wird geschmeidig laufen, weil der Nutzer, der das Projekt gestartet hat, den aktuellen Ordner ohne Probleme betreten kann. + +Produktionsumgebung +~~~~~~~~~~~~~~~~~~~ + +Sobald wir Apache oder Nginx nutzen, um unsere wallabag Instanz zu erreichen, und nicht das Kommando ``php bin/console server:run --env=prod`` nutzen, sollten wir dafür sorgen, die Rechte vernünftig zu vergeben, um die Ordner des Projektes zu schützen. + +Um dies zu machen, muss der Ordner, bekannt als ``DocumentRoot`` (bei Apache) oder ``root`` (bei Nginx), von dem Apache-/Nginx-Nutzer zugänglich sein. Sein Name ist meist ``www-data``, ``apache`` oder ``nobody`` (abhängig vom genutzten Linuxsystem). + +Der Ordner ``/var/www/wallabag/web`` musst dem letztgenannten zugänglich sein. Aber dies könnte nicht genug sein, wenn wir nur auf diesen Ordner achten, weil wir eine leere Seite sehen könnten oder einen Fehler 500, wenn wir die Homepage des Projekt öffnen. + +Dies kommt daher, dass wir die gleichen Rechte dem Ordner ``/var/www/wallabag/var`` geben müssen, so wie wir es für den Ordner ``/var/www/wallabag/web`` gemacht haben. Somit beheben wir das Problem mit dem folgenden Kommando: + +.. code-block:: bash + + chown -R www-data:www-data /var/www/wallabag/var + +Es muss analog für die folgenden Ordner ausgeführt werden + +* /var/www/wallabag/bin/ +* /var/www/wallabag/app/config/ +* /var/www/wallabag/vendor/ +* /var/www/wallabag/data/ + +durch Eingabe der Kommandos + +.. code-block:: bash + + chown -R www-data:www-data /var/www/wallabag/bin + chown -R www-data:www-data /var/www/wallabag/app/config + chown -R www-data:www-data /var/www/wallabag/vendor + chown -R www-data:www-data /var/www/wallabag/data/ + +ansonsten wirst du früher oder später folgenden Fehlermeldung sehen: + +.. code-block:: bash + + Unable to write to the "bin" directory. + file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied + file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied + +Zusätzliche Regeln für SELinux +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Wenn SELinux in deinem System aktiviert ist, wirst du zusätzliche Kontexte konfigurieren müssen damit wallabag ordentlich funktioniert. Um zu testen, ob SELinux aktiviert ist, führe einfach folgendes aus: + +``getenforce`` + +Dies wird ``Enforcing`` ausgeben, wenn SELinux aktiviert ist. Einen neuen Kontext zu erstellen, erfordert die folgende Syntax: + +``semanage fcontext -a -t `` + +Zum Beispiel: + +``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"`` + +Dies wird rekursiv den httpd_sys_content_t Kontext auf das wallabag Verzeichnis und alle darunterliegenden Dateien und Ordner anwenden. Die folgenden Regeln werden gebraucht: + ++-----------------------------------+----------------------------+ +| Vollständiger Pfad | Kontext | ++===================================+============================+ +| /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` | ++-----------------------------------+----------------------------+ + +Nach dem diese Kontexte erstellt wurden, tippe das folgende, um deine Regeln anzuwenden: + +``restorecon -R -v /var/www/wallabag`` + +Du kannst deine Kontexte in einem Verzeichnis überprüfen, indem du ``ls -lZ`` tippst und alle deine aktuellen Regeln mit ``semanage fcontext -l -C`` überprüfst. + +Wenn du das vorkonfigurierte latest-v2-package installierst, dann ist eine weitere Regel während der Installation nötig: + +``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"`` + +Nachdem du erfolgreich dein wallabag erreichst und die Installation fertiggestellt hast, kann dieser Kontext entfernt werden: + +:: + + semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var" + retorecon -R -v /var/www/wallabag/var diff --git a/docs/de/user/login.rst b/docs/de/user/login.rst new file mode 100644 index 00000000..cf1cdc4c --- /dev/null +++ b/docs/de/user/login.rst @@ -0,0 +1,13 @@ +Login +===== + +Dein Account ist nun aktiviert, Glückwünsch! + +Um dich bei wallabag einzuloggen, fülle das Formular auf der Loginseite aus. + +Wenn du an deinem persönlichen Computer arbeitest und verbunden bleiben willst, +kannst du die Checkbox ``Angemeldet bleiben`` anhaken: wallabag wird sich für ein Jahr an deinen Login erinnern. + +.. image:: ../../img/user/login_form.png + :alt: Loginformular + :align: center diff --git a/docs/de/user/migration.rst b/docs/de/user/migration.rst new file mode 100644 index 00000000..bc8a61b0 --- /dev/null +++ b/docs/de/user/migration.rst @@ -0,0 +1,62 @@ +Migration von v1 oder v2 +======================== + +Von wallabag 1.x +----------------- + +Wenn du bisher wallabag v1.x genutzt hast, musst du deine Daten exportieren bevor du zu wallabag v2.x migrierst, weil die Applikation und ihre Datenbank sich stark geändert haben. In deiner alten wallabag Installation kannst du deine Daten auf der Konfigurationsseite exportieren. + +.. image:: ../../img/user/export_v1.png + :alt: Export von wallabag v1 + :align: center + +.. note:: + Wenn du mehrere Accounts auf der gleichen Instanz von wallabag hast, muss jeder Nutzer von v1 exportieren und in v2 seine Daten importieren. + +.. note:: + Wenn du Probleme während des Exports oder Imports hast, scheue dich nicht davor `nach Hilfe zu fragen `__. + +Wenn du eine JSON Datei mit deinen Artikeln erhalten hast, kannst du wallabag v2 installieren falls benötigt durch Befolgen `der Standardprozedur `__. + +Nachdem du einen Nutzerkonto auf deiner neuen wallabag v2 Instanz eingerichtet hast, kannst du zu dem Abschnitt `Import` springen und `Import von wallabag v1` auswählen. Wähle deine JSON Datei aus und lade sie hoch. + +.. image:: ../../img/user/import_wallabagv1.png + :alt: Import von wallabag v1 + :align: center + +Import via command-line interface (CLI) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Wenn du CLI Zugang zu deinem Webserver hast, kannst du dieses Kommando ausführen, um deine Aritkel vom wallabag v1 Export zu importieren: + +:: + + bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod + +Bitte ersetze folgende Werte: + +* ``1`` ist die Nutzer ID in der Databank (Die ID von dem ersten erstellten Nutzer in wallabag ist 1) +* ``~/Downloads/wallabag-export-1-2016-04-05.json`` ist der Pfad zu deinem wallabag v1 Export + +Du wirst eine solche Ausgabe erhalten: + +:: + + Start : 05-04-2016 11:36:07 --- + 403 imported + 0 already saved + End : 05-04-2016 11:36:09 --- + +Von wallabag 2.x +---------------- + +In der vorherigen wallabag Instanz, gehe zu `Alle Artikel` und exportiere diese Artikel als JSON. + +.. image:: ../../img/user/export_v2.png + :alt: Export von wallabag v2 + :align: center + +In deiner neuen wallabag Instanz erstellst du ein Nutzerkonto und klickst auf den Link im Menü, um den Import fortzusetzen. Wähle Import von wallabag v2 aus und lade deine JSON Datei hoch. + +.. note:: + Wenn du Probleme während des Exports oder Imports hast, scheue dich nicht davor `nach Hilfe zu fragen `__. diff --git a/docs/de/user/tags.rst b/docs/de/user/tags.rst new file mode 100644 index 00000000..8ddc0f40 --- /dev/null +++ b/docs/de/user/tags.rst @@ -0,0 +1,2 @@ +Tags +==== \ No newline at end of file diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst new file mode 100644 index 00000000..13e3104f --- /dev/null +++ b/docs/de/user/upgrade.rst @@ -0,0 +1,32 @@ +Wallabag updaten +================ + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.3`` mit der neuesten Releasenummer): + +:: + + git fetch origin + git fetch --tags + git checkout 2.0.3 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index f681d874..f4c55dea 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst @@ -108,7 +108,7 @@ Variable Meaning Operator Meaning title Title of the entry <= Less than… url URL of the entry < Strictly less than… isArchived Whether the entry is archived or not => Greater than… -isStared Whether the entry is starred or not > Strictly greater than… +isStarred Whether the entry is starred or not > Strictly greater than… content The entry's content = Equal to… language The entry's language != Not equal to… mimetype The entry's mime-type OR One rule or another diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst index 89305998..278f0022 100644 --- a/docs/fr/user/configuration.rst +++ b/docs/fr/user/configuration.rst @@ -110,7 +110,7 @@ Variable Sens Opérateur Sens title Titre de l'article <= Inférieur ou égal à … url URL de l'article < Strictement inférieur à … isArchived Si l'article est archivé ou non => Supérieur ou égal à … -isStared Si l'article est en favori ou non > Strictement supérieur à … +isStarred Si l'article est en favori ou non > Strictement supérieur à … content Le contenu de l'article = Égal à … language La langue de l'article != Différent de … mimetype The type MIME de l'article OR Telle règle ou telle autre règle -- cgit v1.2.3 From dc9d76b4906c34a79fbfa6255814f267082033d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 1 Sep 2016 13:36:26 +0200 Subject: Added documentation for Readability migration --- docs/en/user/import.rst | 21 ++++++++++++++++----- docs/fr/user/import.rst | 20 ++++++++++++++++---- 2 files changed, 32 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 63210484..e6c37d72 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -30,14 +30,25 @@ You need to authorize wallabag to interact with your Pocket account. Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). -From Instapaper ---------------- - -*Feature not yet implemented in wallabag v2.* - From Readability ---------------- +Export your Readability data +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +On the tools (`https://www.readability.com/tools/`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). + +Import your data into wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Click on ``Import`` link in the menu, on ``Import contents`` in Readability section +and then select your json file and upload it. + +Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). + +From Instapaper +--------------- + *Feature not yet implemented in wallabag v2.* From HTML or JSON file diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index e6c2fa02..99ac602b 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst @@ -30,15 +30,27 @@ Vous devez autoriser wallabag à se connecter à votre compte Pocket. 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). +Depuis Readability +------------------ + +Exportez vos données de Readability +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sur la page des outils (`https://www.readability.com/tools/`_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json. + +Importez vos données dans wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans +la section Readability et ensuite sélectionnez votre fichier json pour l'uploader. + +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). + Depuis Instapaper ----------------- *Fonctionnalité pas encore implémentée dans wallabag v2.* -Depuis Readability ------------------- - -*Fonctionnalité pas encore implémentée dans wallabag v2.* Depuis un fichier HTML ou JSON ------------------------------ -- cgit v1.2.3 From 56c778b4152a1b886353933276ee3626e4e8c004 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 15 Jan 2016 08:24:32 +0100 Subject: 1st draft for rabbitMQ --- docs/en/developer/rabbitmq.rst | 49 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/en/developer/rabbitmq.rst (limited to 'docs') diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst new file mode 100644 index 00000000..a17e6e4d --- /dev/null +++ b/docs/en/developer/rabbitmq.rst @@ -0,0 +1,49 @@ +Install RabbitMQ for asynchronous tasks +======================================= + +In order to launch asynchronous tasks (useful for huge imports for example), we use RabbitMQ. + +Requirements +------------ + +You need to have RabbitMQ installed on your server. + +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 and launch +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) + rabbitmq-server -detached + +Stop RabbitMQ +~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmqctl stop + + +Configure RabbitMQ in wallabag +------------------------------ + +Edit your ``parameters.yml`` file to edit RabbitMQ configuration. + +Launch RabbitMQ consumer +------------------------ + +Put this command in a cron job: + +.. code:: bash + + bin/console rabbitmq:consumer entries -w \ No newline at end of file -- cgit v1.2.3 From 03e078d060db410fe56b978cdf45d8eec5e177cb Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Sun, 11 Sep 2016 20:43:16 +0200 Subject: Update docs about worker --- docs/en/developer/rabbitmq.rst | 26 +++++++++++++++--- docs/en/developer/redis.rst | 62 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 4 deletions(-) create mode 100644 docs/en/developer/redis.rst (limited to 'docs') diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index a17e6e4d..8cee45fb 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst @@ -1,7 +1,7 @@ Install RabbitMQ for asynchronous tasks ======================================= -In order to launch asynchronous tasks (useful for huge imports for example), we use RabbitMQ. +In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ. Requirements ------------ @@ -37,13 +37,31 @@ Stop RabbitMQ Configure RabbitMQ in wallabag ------------------------------ -Edit your ``parameters.yml`` file to edit RabbitMQ configuration. +Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok: + +.. code:: yaml + + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + Launch RabbitMQ consumer ------------------------ -Put this command in a cron job: +Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: .. code:: bash - bin/console rabbitmq:consumer entries -w \ No newline at end of file + # for Pocket import + bin/console rabbitmq:consumer import_pocket -w + + # for Readbility import + bin/console rabbitmq:consumer import_readability -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 diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst new file mode 100644 index 00000000..5748e260 --- /dev/null +++ b/docs/en/developer/redis.rst @@ -0,0 +1,62 @@ +Install Redis for asynchronous tasks +======================================= + +In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. + +Requirements +------------ + +You need to have Redis installed on your server. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + apt-get install redis-server + +Launch +~~~~~~ + +The server might be already running after installing, if not you can launch it using: + +.. code:: bash + + redis-server + + +Configure Redis in wallabag +--------------------------- + +Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok: + +.. code:: yaml + + redis_host: localhost + redis_port: 6379 + + +Launch Redis consumer +------------------------ + +Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: + +.. code:: bash + + # for Pocket import + bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + + # for Readbility import + bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.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 + +If 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 : + +.. code:: bash + + bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 -- cgit v1.2.3 From 78d5da87fa19e9d385514f6ee5ec68f475f4e56d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 15 Sep 2016 14:58:14 +0200 Subject: Add links to translations in documentation homepage --- docs/de/index.rst | 5 +++++ docs/en/index.rst | 5 +++++ docs/fr/index.rst | 5 +++++ 3 files changed, 15 insertions(+) (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index 5311150f..d8cd8f39 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -17,6 +17,11 @@ Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organis * :ref:`user-docs` * :ref:`dev-docs` +Die Dokumentation ist in anderen Sprachen verfügbar : + +* `Documentation in english `_ +* `Documentation en français `_ + .. _user-docs: .. toctree:: diff --git a/docs/en/index.rst b/docs/en/index.rst index 03025ef9..bc3ce4c2 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -17,6 +17,11 @@ The main documentation for this application is organized into a couple sections: * :ref:`user-docs` * :ref:`dev-docs` +The documentation is available in other languages: + +* `Documentation en français `_ +* `Deutsch Dokumentation `_ + .. _user-docs: .. toctree:: diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 1e72dae7..095f1a69 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -18,6 +18,11 @@ La documentation principale de cette application est découpée en plusieurs sec * :ref:`user-docs` * :ref:`dev-docs` +La documentation est disponible dans d'autres langues : + +* `Documentation in english `_ +* `Deutsch Dokumentation `_ + .. _user-docs: .. toctree:: -- cgit v1.2.3 From 8fed8d1bacbbcbf606a94497c5b58f49068bd6a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 25 Aug 2016 15:28:46 +0200 Subject: Add documentation about article sharing --- docs/de/user/installation.rst | 2 +- docs/en/index.rst | 1 + docs/en/user/installation.rst | 16 +++++++++++----- docs/en/user/share.rst | 17 +++++++++++++++++ docs/fr/index.rst | 1 + docs/fr/user/installation.rst | 18 ++++++++++++------ docs/fr/user/share.rst | 17 +++++++++++++++++ docs/img/user/share.png | Bin 0 -> 9435 bytes 8 files changed, 60 insertions(+), 12 deletions(-) create mode 100644 docs/en/user/share.rst create mode 100644 docs/fr/user/share.rst create mode 100644 docs/img/user/share.png (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index fced2ed4..2e3108be 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -46,7 +46,7 @@ Composer installieren: curl -s http://getcomposer.org/installer | php -Du kannst eine spezifische Anleitung `hier `__ finden: +Du kannst eine spezifische Anleitung `hier `__ finden. Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: diff --git a/docs/en/index.rst b/docs/en/index.rst index bc3ce4c2..46450b8f 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -40,6 +40,7 @@ The documentation is available in other languages: user/errors_during_fetching user/annotations user/download_articles + user/share user/filters user/tags user/android diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 763d7c66..3794c757 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -37,7 +37,7 @@ Installation On a dedicated web server (recommended way) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag uses a large number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). +wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). Install Composer: @@ -45,7 +45,14 @@ Install Composer: curl -s http://getcomposer.org/installer | php -You can find specific instructions `here `__: +You can find specific instructions `here `__. + +You also need to install node.js (via `the Download page `__), npm (already install with node.js), bower and grunt: + +:: + + npm install -g bower + npm install -g grunt-cli To install wallabag itself, you must run the following commands: @@ -53,9 +60,8 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + git checkout 2.1 + ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: diff --git a/docs/en/user/share.rst b/docs/en/user/share.rst new file mode 100644 index 00000000..e99e51ab --- /dev/null +++ b/docs/en/user/share.rst @@ -0,0 +1,17 @@ +Share articles +============== + +When you're reading an article, you can share it. Just click on the share button: + +.. image:: ../../img/user/share.png + :alt: share article + :align: center + +Now, you can share the article: + +- with a public URL (you'll have a light view of the article) +- with a tweet +- into your Shaarli +- with a post in Diaspora* +- to Carrot +- with an email diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 095f1a69..dfa55afe 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -41,6 +41,7 @@ La documentation est disponible dans d'autres langues : user/errors_during_fetching user/annotations user/download_articles + user/share user/filters user/tags diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 480970c5..105e8122 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -35,7 +35,7 @@ Installation Sur un serveur dédié (méthode conseillée) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag utilise un grand nombre de bibliothèques pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). +wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). Installation de Composer : @@ -43,17 +43,23 @@ Installation de Composer : curl -s http://getcomposer.org/installer | php -Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__ : +Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__. -Pour installer wallabag, vous devez exécuter ces deux commandes : +Vous devez aussi installer node.js (via `la page de téléchargements `__), npm (déjà installé avec node.js), bower et grunt: + +:: + + npm install -g bower + npm install -g grunt-cli + +Pour installer wallabag, vous devez exécuter ces commandes : :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + git checkout 2.1 + ./install.sh Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : diff --git a/docs/fr/user/share.rst b/docs/fr/user/share.rst new file mode 100644 index 00000000..b5faa5ba --- /dev/null +++ b/docs/fr/user/share.rst @@ -0,0 +1,17 @@ +Partager des articles +===================== + +Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage : + +.. image:: ../../img/user/share.png + :alt: partager un article + :align: center + +Vous pouvez maintenant le partager : + +- avec une URL publique (vous obtiendrez une vue allégée de l'article) +- avec un tweet +- dans votre Shaarli +- avec un message dans Diaspora* +- sur Carrot +- avec un email diff --git a/docs/img/user/share.png b/docs/img/user/share.png new file mode 100644 index 00000000..4cfe9edb Binary files /dev/null and b/docs/img/user/share.png differ -- cgit v1.2.3 From ce0a32229a8d139115ccd1d247a0ee4f1fedc8a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 15 Sep 2016 14:26:30 +0200 Subject: Fix wallabag version in documentation --- docs/de/user/installation.rst | 5 ++--- docs/de/user/upgrade.rst | 7 +++---- docs/en/user/installation.rst | 9 +-------- docs/en/user/upgrade.rst | 7 +++---- docs/fr/user/installation.rst | 9 +-------- docs/fr/user/upgrade.rst | 7 +++---- 6 files changed, 13 insertions(+), 31 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 2e3108be..05602bf3 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -54,9 +54,8 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + git checkout 2.1.0 + ./install.sh Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst index c04b68f3..953c84ff 100644 --- a/docs/de/user/upgrade.rst +++ b/docs/de/user/upgrade.rst @@ -4,15 +4,14 @@ Wallabag updaten Update auf einem dedizierten Webserver -------------------------------------- -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer): +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): :: git fetch origin git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod + git checkout 2.1.0 + ./install.sh Update auf einem Shared Webhosting ---------------------------------- diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 3794c757..8e9f71d4 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -47,20 +47,13 @@ Install Composer: You can find specific instructions `here `__. -You also need to install node.js (via `the Download page `__), npm (already install with node.js), bower and grunt: - -:: - - npm install -g bower - npm install -g grunt-cli - To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1 + git checkout 2.1.0 ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index 90ed6c70..5c37be95 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst @@ -4,15 +4,14 @@ Upgrade wallabag Upgrade on a dedicated web server --------------------------------- -The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.8`` by the last release number): +The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): :: git fetch origin git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod + git checkout 2.1.0 + ./install.sh Upgrade on a shared hosting --------------------------- diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 105e8122..4fccd0d4 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -45,20 +45,13 @@ Installation de Composer : Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__. -Vous devez aussi installer node.js (via `la page de téléchargements `__), npm (déjà installé avec node.js), bower et grunt: - -:: - - npm install -g bower - npm install -g grunt-cli - Pour installer wallabag, vous devez exécuter ces commandes : :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1 + git checkout 2.1.0 ./install.sh Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst index 1ead2c94..e3798979 100644 --- a/docs/fr/user/upgrade.rst +++ b/docs/fr/user/upgrade.rst @@ -4,15 +4,14 @@ Mettre à jour wallabag Mise à jour sur un serveur dédié -------------------------------- -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) : +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) : :: git fetch origin git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod + git checkout 2.1.0 + ./install.sh Mise à jour sur un hébergement mutualisé ---------------------------------------- -- cgit v1.2.3 From a7dda1f2bf952d81a0c3ee6a9792db9331919b37 Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Tue, 27 Sep 2016 17:06:32 +0200 Subject: Add Instapaper docs --- docs/en/user/import.rst | 22 ++++++++++++++++------ docs/fr/user/import.rst | 17 ++++++++++++++--- 2 files changed, 30 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index e6c37d72..758e3816 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -23,12 +23,11 @@ Now, all is fine to migrate from Pocket. Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section +Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section and then on ``Connect to Pocket and import data``. You need to authorize wallabag to interact with your Pocket account. -Your data will be imported. Data import can be a demanding process for your server -(we need to work on this import to improve it). +Your data will be imported. Data import can be a demanding process for your server. From Readability ---------------- @@ -41,15 +40,26 @@ On the tools (`https://www.readability.com/tools/`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). + +Import your data into wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Click on ``Import`` link in the menu, on ``Import contents`` in Instapaper section +and then select your CSV file and upload it. + +Your data will be imported. Data import can be a demanding process for your server. From HTML or JSON file ---------------------- 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``. Vous devez autoriser wallabag à se connecter à votre compte Pocket. 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). +pour votre serveur. Depuis Readability ------------------ @@ -44,12 +44,23 @@ Importez vos données dans wallabag 2.x Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans la section Readability et ensuite sélectionnez votre fichier json pour l'uploader. -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). +Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur. Depuis Instapaper ----------------- -*Fonctionnalité pas encore implémentée dans wallabag v2.* +Exportez vos données de Instapaper +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Sur la page des paramètres (`https://www.instapaper.com/user`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). + +Importez vos données dans wallabag 2.x +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans +la section Instapaper et ensuite sélectionnez votre fichier CSV pour l'uploader. + +Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur. Depuis un fichier HTML ou JSON -- cgit v1.2.3 From 084fb0d303efc6edd0bfbf43d96b6cbe48acb2b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 10:02:31 +0200 Subject: Some fixes about upgrade from 2.0.x -> 2.1.0 --- docs/de/conf.py | 2 +- docs/de/user/upgrade.rst | 4 +++- docs/en/conf.py | 2 +- docs/en/user/upgrade.rst | 4 +++- docs/fr/conf.py | 2 +- docs/fr/user/upgrade.rst | 4 +++- 6 files changed, 12 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/de/conf.py b/docs/de/conf.py index 8f2d130d..cc9dcdf8 100644 --- a/docs/de/conf.py +++ b/docs/de/conf.py @@ -12,7 +12,7 @@ source_suffix = '.rst' master_doc = 'index' project = u'wallabag-fr' copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' -version = '2.0.0' +version = '2.1.0' release = version exclude_patterns = ['_build'] pygments_style = 'sphinx' diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst index 953c84ff..084dab74 100644 --- a/docs/de/user/upgrade.rst +++ b/docs/de/user/upgrade.rst @@ -11,7 +11,9 @@ Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.htm git fetch origin git fetch --tags git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod Update auf einem Shared Webhosting ---------------------------------- diff --git a/docs/en/conf.py b/docs/en/conf.py index 86e33704..717b35f1 100644 --- a/docs/en/conf.py +++ b/docs/en/conf.py @@ -12,7 +12,7 @@ source_suffix = '.rst' master_doc = 'index' project = u'wallabag' copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' -version = '2.0.0' +version = '2.1.0' release = version exclude_patterns = ['_build'] pygments_style = 'sphinx' diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index 5c37be95..f547f247 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst @@ -11,7 +11,9 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba git fetch origin git fetch --tags git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod Upgrade on a shared hosting --------------------------- 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' master_doc = 'index' project = u'wallabag-fr' copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' -version = '2.0.0' +version = '2.1.0' release = version exclude_patterns = ['_build'] pygments_style = 'sphinx' diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst index e3798979..42aef9c7 100644 --- a/docs/fr/user/upgrade.rst +++ b/docs/fr/user/upgrade.rst @@ -11,7 +11,9 @@ La dernière version de wallabag est publiée à cette adresse : https://www.wal git fetch origin git fetch --tags git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod Mise à jour sur un hébergement mutualisé ---------------------------------------- -- cgit v1.2.3 From eef8aeec8fa56519363e90977900f198ff3bd19b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 11:13:20 +0200 Subject: Reordered upgrade documentation --- docs/de/index.rst | 3 ++- docs/de/user/upgrade-2.0.x-2.0.y.rst | 34 ++++++++++++++++++++++++ docs/de/user/upgrade-2.0.x-2.1.0.rst | 50 +++++++++++++++++++++++++++++++++++ docs/de/user/upgrade.rst | 35 ------------------------- docs/en/index.rst | 3 ++- docs/en/user/upgrade-2.0.x-2.0.y.rst | 34 ++++++++++++++++++++++++ docs/en/user/upgrade-2.0.x-2.1.0.rst | 50 +++++++++++++++++++++++++++++++++++ docs/en/user/upgrade.rst | 35 ------------------------- docs/fr/index.rst | 3 ++- docs/fr/user/upgrade-2.0.x-2.0.y.rst | 34 ++++++++++++++++++++++++ docs/fr/user/upgrade-2.0.x-2.1.0.rst | 51 ++++++++++++++++++++++++++++++++++++ docs/fr/user/upgrade.rst | 35 ------------------------- 12 files changed, 259 insertions(+), 108 deletions(-) create mode 100644 docs/de/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/de/user/upgrade-2.0.x-2.1.0.rst delete mode 100644 docs/de/user/upgrade.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.1.0.rst delete mode 100644 docs/en/user/upgrade.rst create mode 100644 docs/fr/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/fr/user/upgrade-2.0.x-2.1.0.rst delete mode 100644 docs/fr/user/upgrade.rst (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index d8cd8f39..62f8b54a 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -30,7 +30,8 @@ Die Dokumentation ist in anderen Sprachen verfügbar : user/faq user/installation - user/upgrade + user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.0.y user/migration user/import user/create_account diff --git a/docs/de/user/upgrade-2.0.x-2.0.y.rst b/docs/de/user/upgrade-2.0.x-2.0.y.rst new file mode 100644 index 00000000..c04b68f3 --- /dev/null +++ b/docs/de/user/upgrade-2.0.x-2.0.y.rst @@ -0,0 +1,34 @@ +Wallabag updaten +================ + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer): + +:: + + git fetch origin + git fetch --tags + git checkout 2.0.8 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) + +Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. diff --git a/docs/de/user/upgrade-2.0.x-2.1.0.rst b/docs/de/user/upgrade-2.0.x-2.1.0.rst new file mode 100644 index 00000000..eb67e686 --- /dev/null +++ b/docs/de/user/upgrade-2.0.x-2.1.0.rst @@ -0,0 +1,50 @@ +Wallabag updaten +================ + +.. warning:: +Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): + +:: + + git fetch origin + git fetch --tags + git checkout 2.1.0 + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) + +Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. + +Sie müssen einige SQL-Abfragen ausführen, um Ihre Datenbank zu aktualisieren. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst deleted file mode 100644 index 084dab74..00000000 --- a/docs/de/user/upgrade.rst +++ /dev/null @@ -1,35 +0,0 @@ -Wallabag updaten -================ - -Update auf einem dedizierten Webserver --------------------------------------- - -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): - -:: - - git fetch origin - git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Update auf einem Shared Webhosting ----------------------------------- - -Sichere deine ``app/config/parameters.yml`` Datei. - -Lade das neueste Release von wallabag herunter: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) - -Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. - -Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. - -Leere den ``var/cache`` Ordner. diff --git a/docs/en/index.rst b/docs/en/index.rst index 46450b8f..da23400b 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -30,7 +30,8 @@ The documentation is available in other languages: user/faq user/installation - user/upgrade + user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.0.y user/migration user/import user/create_account diff --git a/docs/en/user/upgrade-2.0.x-2.0.y.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst new file mode 100644 index 00000000..6a0818b3 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst @@ -0,0 +1,34 @@ +Upgrade from 2.0.x to 2.0.y +=========================== + +Upgrade on a dedicated web server +--------------------------------- + +The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.8`` by the last release number): + +:: + + git fetch origin + git fetch --tags + git checkout 2.0.8 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Upgrade on a shared hosting +--------------------------- + +Backup your ``app/config/parameters.yml`` file. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. diff --git a/docs/en/user/upgrade-2.0.x-2.1.0.rst b/docs/en/user/upgrade-2.0.x-2.1.0.rst new file mode 100644 index 00000000..3a24ee58 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.0.rst @@ -0,0 +1,50 @@ +Upgrading from 2.0.x to 2.1.0 +============================= + +.. warning:: +Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. + +Upgrade on a dedicated web server +--------------------------------- + +The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): + +:: + + git fetch origin + git fetch --tags + git checkout 2.1.0 + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod + +Upgrade on a shared hosting +--------------------------- + +Backup your ``app/config/parameters.yml`` file. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. + +You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst deleted file mode 100644 index f547f247..00000000 --- a/docs/en/user/upgrade.rst +++ /dev/null @@ -1,35 +0,0 @@ -Upgrade wallabag -================ - -Upgrade on a dedicated web server ---------------------------------- - -The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): - -:: - - git fetch origin - git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Upgrade on a shared hosting ---------------------------- - -Backup your ``app/config/parameters.yml`` file. - -Download the last release of wallabag: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. diff --git a/docs/fr/index.rst b/docs/fr/index.rst index dfa55afe..ff99948c 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -31,7 +31,8 @@ La documentation est disponible dans d'autres langues : user/faq user/installation - user/upgrade + user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.0.y user/migration user/import user/create_account diff --git a/docs/fr/user/upgrade-2.0.x-2.0.y.rst b/docs/fr/user/upgrade-2.0.x-2.0.y.rst new file mode 100644 index 00000000..d8dfac6e --- /dev/null +++ b/docs/fr/user/upgrade-2.0.x-2.0.y.rst @@ -0,0 +1,34 @@ +Mettre à jour de la 2.0.x à la 2.0.y +==================================== + +Mise à jour sur un serveur dédié +-------------------------------- + +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) : + +:: + + git fetch origin + git fetch --tags + git checkout 2.0.8 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``) + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. diff --git a/docs/fr/user/upgrade-2.0.x-2.1.0.rst b/docs/fr/user/upgrade-2.0.x-2.1.0.rst new file mode 100644 index 00000000..18f09a63 --- /dev/null +++ b/docs/fr/user/upgrade-2.0.x-2.1.0.rst @@ -0,0 +1,51 @@ +Mettre à jour de la 2.0.x à la 2.1.0 +==================================== + +.. warning:: +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. + +Mise à jour sur un serveur dédié +-------------------------------- + +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) : + +:: + + git fetch origin + git fetch --tags + git checkout 2.1.0 + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. + +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 : + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; + diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst deleted file mode 100644 index 42aef9c7..00000000 --- a/docs/fr/user/upgrade.rst +++ /dev/null @@ -1,35 +0,0 @@ -Mettre à jour wallabag -====================== - -Mise à jour sur un serveur dédié --------------------------------- - -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) : - -:: - - git fetch origin - git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Mise à jour sur un hébergement mutualisé ----------------------------------------- - -Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. - -Téléchargez la dernière version de wallabag : - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) - -Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. - -Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. - -Videz le répertoire ``var/cache``. -- cgit v1.2.3 From 9866d39431ca58e4c913b6385ed74287f014c38d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 11:59:35 +0200 Subject: Fixed review --- docs/de/index.rst | 2 +- docs/de/user/upgrade-2.0.x-2.0.y.rst | 4 +-- docs/de/user/upgrade-2.0.x-2.1.0.rst | 50 --------------------------- docs/de/user/upgrade-2.0.x-2.1.y.rst | 64 +++++++++++++++++++++++++++++++++++ docs/en/index.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.0.rst | 50 --------------------------- docs/en/user/upgrade-2.0.x-2.1.y.rst | 64 +++++++++++++++++++++++++++++++++++ docs/fr/index.rst | 2 +- docs/fr/user/upgrade-2.0.x-2.1.0.rst | 51 ---------------------------- docs/fr/user/upgrade-2.0.x-2.1.y.rst | 65 ++++++++++++++++++++++++++++++++++++ 10 files changed, 198 insertions(+), 156 deletions(-) delete mode 100644 docs/de/user/upgrade-2.0.x-2.1.0.rst create mode 100644 docs/de/user/upgrade-2.0.x-2.1.y.rst delete mode 100644 docs/en/user/upgrade-2.0.x-2.1.0.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.1.y.rst delete mode 100644 docs/fr/user/upgrade-2.0.x-2.1.0.rst create mode 100644 docs/fr/user/upgrade-2.0.x-2.1.y.rst (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index 62f8b54a..65cf8953 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -30,7 +30,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar : user/faq user/installation - user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.1.y user/upgrade-2.0.x-2.0.y user/migration user/import diff --git a/docs/de/user/upgrade-2.0.x-2.0.y.rst b/docs/de/user/upgrade-2.0.x-2.0.y.rst index c04b68f3..adf288bd 100644 --- a/docs/de/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.0.y.rst @@ -1,5 +1,5 @@ -Wallabag updaten -================ +Wallabag updaten 2.0.x -> 2.1.x +=============================== Update auf einem dedizierten Webserver -------------------------------------- diff --git a/docs/de/user/upgrade-2.0.x-2.1.0.rst b/docs/de/user/upgrade-2.0.x-2.1.0.rst deleted file mode 100644 index eb67e686..00000000 --- a/docs/de/user/upgrade-2.0.x-2.1.0.rst +++ /dev/null @@ -1,50 +0,0 @@ -Wallabag updaten -================ - -.. warning:: -Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. - -Update auf einem dedizierten Webserver --------------------------------------- - -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): - -:: - - git fetch origin - git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Update auf einem Shared Webhosting ----------------------------------- - -Sichere deine ``app/config/parameters.yml`` Datei. - -Lade das neueste Release von wallabag herunter: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) - -Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. - -Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. - -Leere den ``var/cache`` Ordner. - -Sie müssen einige SQL-Abfragen ausführen, um Ihre Datenbank zu aktualisieren. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst new file mode 100644 index 00000000..32d13c6a --- /dev/null +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -0,0 +1,64 @@ +Wallabag updaten +================ + +.. warning:: +Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): + +:: + + git fetch origin + git fetch --tags + git checkout 2.1.0 + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) + +Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) : + +.. code-block:: bash + + # RabbitMQ processing + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + # Redis processing + redis_host: localhost + redis_port: 6379 + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. + +Sie müssen einige SQL-Abfragen ausführen, um Ihre Datenbank zu aktualisieren. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/index.rst b/docs/en/index.rst index da23400b..026d174d 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -30,7 +30,7 @@ The documentation is available in other languages: user/faq user/installation - user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.1.y user/upgrade-2.0.x-2.0.y user/migration user/import diff --git a/docs/en/user/upgrade-2.0.x-2.1.0.rst b/docs/en/user/upgrade-2.0.x-2.1.0.rst deleted file mode 100644 index 3a24ee58..00000000 --- a/docs/en/user/upgrade-2.0.x-2.1.0.rst +++ /dev/null @@ -1,50 +0,0 @@ -Upgrading from 2.0.x to 2.1.0 -============================= - -.. warning:: -Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. - -Upgrade on a dedicated web server ---------------------------------- - -The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): - -:: - - git fetch origin - git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Upgrade on a shared hosting ---------------------------- - -Backup your ``app/config/parameters.yml`` file. - -Download the last release of wallabag: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. - -You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst new file mode 100644 index 00000000..5ae5eb43 --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -0,0 +1,64 @@ +Upgrading from 2.0.x to 2.1.y +============================= + +.. warning:: +Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. + +Upgrade on a dedicated web server +--------------------------------- + +The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): + +:: + + git fetch origin + git fetch --tags + git checkout 2.1.0 + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod + +Upgrade on a shared hosting +--------------------------- + +Backup your ``app/config/parameters.yml`` file. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) : + +.. code-block:: bash + + # RabbitMQ processing + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + # Redis processing + redis_host: localhost + redis_port: 6379 + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. + +You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/fr/index.rst b/docs/fr/index.rst index ff99948c..d0cd0c43 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -31,7 +31,7 @@ La documentation est disponible dans d'autres langues : user/faq user/installation - user/upgrade-2.0.x-2.1.0 + user/upgrade-2.0.x-2.1.y user/upgrade-2.0.x-2.0.y user/migration user/import diff --git a/docs/fr/user/upgrade-2.0.x-2.1.0.rst b/docs/fr/user/upgrade-2.0.x-2.1.0.rst deleted file mode 100644 index 18f09a63..00000000 --- a/docs/fr/user/upgrade-2.0.x-2.1.0.rst +++ /dev/null @@ -1,51 +0,0 @@ -Mettre à jour de la 2.0.x à la 2.1.0 -==================================== - -.. warning:: -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. - -Mise à jour sur un serveur dédié --------------------------------- - -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) : - -:: - - git fetch origin - git fetch --tags - git checkout 2.1.0 - ASSETS=build ./install.sh - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Mise à jour sur un hébergement mutualisé ----------------------------------------- - -Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. - -Téléchargez la dernière version de wallabag : - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) - -Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. - -Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. - -Videz le répertoire ``var/cache``. - -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 : - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; - 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 @@ +Mettre à jour de la 2.0.x à la 2.1.y +==================================== + +.. warning:: +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. + +Mise à jour sur un serveur dédié +-------------------------------- + +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) : + +:: + + git fetch origin + git fetch --tags + git checkout 2.1.0 + ASSETS=build ./install.sh + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +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) : + +.. code-block:: bash + + # RabbitMQ processing + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + # Redis processing + redis_host: localhost + redis_port: 6379 + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. + +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 : + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; + -- cgit v1.2.3 From ff1f55c2a0122c1842cfb59a0431221b247f6851 Mon Sep 17 00:00:00 2001 From: Strubbl Date: Wed, 28 Sep 2016 12:26:29 +0200 Subject: update German upgrade-2.0.x-2.1.y.rst --- docs/de/user/upgrade-2.0.x-2.1.y.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index 32d13c6a..cc292957 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -2,7 +2,7 @@ Wallabag updaten ================ .. warning:: -Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. +Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. Update auf einem dedizierten Webserver -------------------------------------- @@ -33,7 +33,7 @@ Lade das neueste Release von wallabag herunter: Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. -Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) : +Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): .. code-block:: bash @@ -51,7 +51,7 @@ Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installat Leere den ``var/cache`` Ordner. -Sie müssen einige SQL-Abfragen ausführen, um Ihre Datenbank zu aktualisieren. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: +Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen an, dass der Tabellenpräfix ``wallabag_`` und die Datenbank MySQL ist: .. code-block:: sql -- cgit v1.2.3 From 34e4c12604977b2c57ff9eae313278fb5067f8b5 Mon Sep 17 00:00:00 2001 From: Julian Oster Date: Wed, 28 Sep 2016 13:52:06 +0200 Subject: Little improvements to the german translation --- docs/de/user/upgrade-2.0.x-2.1.y.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index cc292957..85229d30 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -2,12 +2,12 @@ Wallabag updaten ================ .. warning:: -Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. +Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. Update auf einem dedizierten Webserver -------------------------------------- -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): :: @@ -31,7 +31,7 @@ Lade das neueste Release von wallabag herunter: (md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) -Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. +Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): @@ -51,7 +51,7 @@ Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installat Leere den ``var/cache`` Ordner. -Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen an, dass der Tabellenpräfix ``wallabag_`` und die Datenbank MySQL ist: +Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen in diesem Fall an, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank genutzt wird: .. code-block:: sql -- cgit v1.2.3 From cb0096df41229d41a960eb48132202adb83576ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 16:37:02 +0200 Subject: Added links to async config in english doc --- docs/en/index.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/en/index.rst b/docs/en/index.rst index 026d174d..beb3816e 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -57,3 +57,5 @@ The documentation is available in other languages: developer/documentation developer/translate developer/maintenance + developer/redis + developer/rabbitmq -- cgit v1.2.3 From ff5be9720b84b97972e34d9574d1d273d9fd9bb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 28 Sep 2016 16:37:36 +0200 Subject: Added links to async config in french doc --- docs/fr/index.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/fr/index.rst b/docs/fr/index.rst index d0cd0c43..359b103c 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -57,3 +57,5 @@ La documentation est disponible dans d'autres langues : developer/documentation developer/translate developer/maintenance + developer/redis + developer/rabbitmq -- cgit v1.2.3 From 080cb52fac8e2bf2d304c3d49ca3b96378d3587f Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Thu, 29 Sep 2016 10:36:19 +0200 Subject: add German rabbitmq.rst --- docs/de/developer/rabbitmq.rst | 67 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 docs/de/developer/rabbitmq.rst (limited to 'docs') diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst new file mode 100644 index 00000000..4814a623 --- /dev/null +++ b/docs/de/developer/rabbitmq.rst @@ -0,0 +1,67 @@ +Installiere RabbitMQ für asynchrone Aufgaben +============================================ + +Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen. + +Voraussetzungen +-------------- + +Du musst RabbitMQ auf deinem Server installiert haben. + +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 + +Konfiguration und Starten +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) + rabbitmq-server -detached + +RabbitMQ stoppen +~~~~~~~~~~~~~ + +.. code:: bash + + rabbitmqctl stop + + +Konfigure RabbitMQ in wallabag +------------------------------ + +Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein: + +.. code:: yaml + + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + +Starte den RabbitMQ Consumer +------------------------ + +Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): + +.. code:: bash + + # for Pocket import + bin/console rabbitmq:consumer import_pocket -w + + # for Readbility import + bin/console rabbitmq:consumer import_readability -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 -- cgit v1.2.3 From 00283a3b0aa8067f7ab66376509ca4464edd93ec Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Thu, 29 Sep 2016 10:41:07 +0200 Subject: add German redis.rst --- docs/de/developer/redis.rst | 62 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/de/developer/redis.rst (limited to 'docs') diff --git a/docs/de/developer/redis.rst b/docs/de/developer/redis.rst new file mode 100644 index 00000000..19800c46 --- /dev/null +++ b/docs/de/developer/redis.rst @@ -0,0 +1,62 @@ +Installiere Redis für asynchrone Aufgaben +========================================= + +Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen. + +Voraussetzungen +------------ + +Du musst Redis auf deinem Server installiert haben. + +Installation +~~~~~~~~~~~~ + +.. code:: bash + + apt-get install redis-server + +Starten +~~~~~~ + +Der Redis Service läuft eventuell schon direkt nach der Installation. Falls nicht kannst du ihn wie folgt starten: + +.. code:: bash + + redis-server + + +Konfigure Redis in wallabag +--------------------------- + +Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein: + +.. code:: yaml + + redis_host: localhost + redis_port: 6379 + + +Starte den Redis Consumer +------------------------ + +Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): + +.. code:: bash + + # for Pocket import + bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log + + # for Readbility import + bin/console wallabag:import:redis-worker readability -vv >> /path/to/wallabag/var/logs/redis-readability.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 + +Wenn 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: + +.. code:: bash + + bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 -- cgit v1.2.3 From c59e628afeee9bfb2b8b358cdc81688e85cff744 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Thu, 29 Sep 2016 10:43:53 +0200 Subject: Added links to async config in german doc --- docs/de/index.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index 65cf8953..b3cd33b0 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -56,3 +56,5 @@ Die Dokumentation ist in anderen Sprachen verfügbar : developer/documentation developer/translate developer/maintenance + developer/redis + developer/rabbitmq -- cgit v1.2.3 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/de/developer/rabbitmq.rst | 18 +++++++--- docs/de/developer/redis.rst | 15 +++++++-- docs/en/developer/rabbitmq.rst | 11 +++++- docs/en/developer/redis.rst | 15 +++++++-- docs/fr/developer/rabbitmq.rst | 76 ++++++++++++++++++++++++++++++++++++++++++ docs/fr/developer/redis.rst | 71 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 195 insertions(+), 11 deletions(-) create mode 100644 docs/fr/developer/rabbitmq.rst create mode 100644 docs/fr/developer/redis.rst (limited to 'docs') 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 Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen. Voraussetzungen --------------- +--------------- Du musst RabbitMQ auf deinem Server installiert haben. @@ -27,7 +27,7 @@ Konfiguration und Starten rabbitmq-server -detached RabbitMQ stoppen -~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~ .. code:: bash @@ -48,7 +48,7 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht Starte den RabbitMQ Consumer ------------------------- +---------------------------- Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): @@ -57,11 +57,21 @@ Abhängig von welchem Service du importieren möchtest, solltest du einen Cron J # for Pocket import bin/console rabbitmq:consumer import_pocket -w - # for Readbility import + # 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/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 Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen. Voraussetzungen ------------- +--------------- Du musst Redis auf deinem Server installiert haben. @@ -37,7 +37,7 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht Starte den Redis Consumer ------------------------- +------------------------- Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst): @@ -46,15 +46,24 @@ Abhängig von welchem Service du importieren möchtest, solltest du einen Cron J # for Pocket import bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log - # for Readbility import + # 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 + Wenn 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: .. 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 # for Pocket import bin/console rabbitmq:consumer import_pocket -w - # for Readbility import + # 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/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 @@ Install Redis for asynchronous tasks -======================================= +==================================== In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. @@ -37,7 +37,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s Launch Redis consumer ------------------------- +--------------------- Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: @@ -46,15 +46,24 @@ Depending on which service you want to import from you need to enable one (or ma # for Pocket import bin/console wallabag:import:redis-worker pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log - # for Readbility import + # 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 + If 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 : .. 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 @@ +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 12f7fd004a64756e84cca963886e99225e79ec9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 3 Oct 2016 09:16:57 +0200 Subject: Prepare wallabag 2.1.0 :rocket: --- docs/de/user/installation.rst | 2 +- docs/en/user/installation.rst | 2 +- docs/fr/user/installation.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 05602bf3..c24f0e00 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -55,7 +55,7 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: git clone https://github.com/wallabag/wallabag.git cd wallabag git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 8e9f71d4..cc8211d8 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -54,7 +54,7 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 4fccd0d4..729fec25 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -52,7 +52,7 @@ Pour installer wallabag, vous devez exécuter ces commandes : git clone https://github.com/wallabag/wallabag.git cd wallabag git checkout 2.1.0 - ./install.sh + ASSETS=build ./install.sh Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : -- cgit v1.2.3 From 9d3603147b0a4219a8065861351439cbe5e52772 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 3 Oct 2016 11:16:35 +0200 Subject: Update md5 hash for wallabag 2.1.0 --- docs/de/user/installation.rst | 2 +- docs/de/user/upgrade-2.0.x-2.1.y.rst | 2 +- docs/en/user/installation.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.y.rst | 2 +- docs/fr/user/installation.rst | 2 +- docs/fr/user/upgrade-2.0.x-2.1.y.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index c24f0e00..f7bc2e4f 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -85,7 +85,7 @@ Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacke wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) +(md5 hash: ``6c33520e29cc754b687f9cee0398dede``) Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``. diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index 85229d30..23bf3682 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -29,7 +29,7 @@ Lade das neueste Release von wallabag herunter: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) +(md5 hash: ``6c33520e29cc754b687f9cee0398dede``) Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index cc8211d8..7954fe0b 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -84,7 +84,7 @@ Execute this command to download and extract the latest package: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) +(md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``) Now, read the following documentation to create your virtual host, then access your wallabag. If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst index 5ae5eb43..63a77e7c 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -29,7 +29,7 @@ Download the last release of wallabag: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the package: ``4f84c725d1d6e3345eae0a406115e5ff``) +(md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``) Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 729fec25..f9777890 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -81,7 +81,7 @@ Exécutez cette commande pour télécharger et décompresser l'archive : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) +(hash md5 de l'archive 2.1.0 : ``6c33520e29cc754b687f9cee0398dede``) Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``. 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 index a4afe768..dc66682a 100644 --- a/docs/fr/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/fr/user/upgrade-2.0.x-2.1.y.rst @@ -29,7 +29,7 @@ Téléchargez la dernière version de wallabag : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(hash md5 de l'archive : ``4f84c725d1d6e3345eae0a406115e5ff``) +(hash md5 de l'archive 2.1.0 : ``6c33520e29cc754b687f9cee0398dede``) Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. -- cgit v1.2.3 From 8fdb5e5766a6bf5970f268200a6c21fd39693637 Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Mon, 3 Oct 2016 14:21:49 +0200 Subject: Re-add wallabag:install --- docs/de/user/installation.rst | 1 + docs/en/user/installation.rst | 1 + docs/fr/user/installation.rst | 1 + 3 files changed, 3 insertions(+) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index f7bc2e4f..7fa8c625 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -56,6 +56,7 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: cd wallabag git checkout 2.1.0 ASSETS=build ./install.sh + php bin/console wallabag:install --env=prod Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 7954fe0b..82fa6f4e 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -55,6 +55,7 @@ To install wallabag itself, you must run the following commands: cd wallabag git checkout 2.1.0 ASSETS=build ./install.sh + php bin/console wallabag:install --env=prod To start PHP's build-in server and test if everything did install correctly, you can do: diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index f9777890..bb4de534 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -53,6 +53,7 @@ Pour installer wallabag, vous devez exécuter ces commandes : cd wallabag git checkout 2.1.0 ASSETS=build ./install.sh + php bin/console wallabag:install --env=prod Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : -- cgit v1.2.3 From 88d8125a5fa3b5c6c91cb22fc2bef1243d7391fc Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Mon, 3 Oct 2016 14:44:12 +0200 Subject: Ensure cache is clear before upgrading If we changed some namespace / classes, we need to refresh the cache before anything else. --- docs/de/user/upgrade-2.0.x-2.0.y.rst | 1 + docs/de/user/upgrade-2.0.x-2.1.y.rst | 1 + docs/en/user/upgrade-2.0.x-2.0.y.rst | 1 + docs/en/user/upgrade-2.0.x-2.1.y.rst | 1 + docs/fr/user/upgrade-2.0.x-2.0.y.rst | 1 + docs/fr/user/upgrade-2.0.x-2.1.y.rst | 1 + 6 files changed, 6 insertions(+) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.0.y.rst b/docs/de/user/upgrade-2.0.x-2.0.y.rst index adf288bd..5820a0d2 100644 --- a/docs/de/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.0.y.rst @@ -8,6 +8,7 @@ Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.htm :: + rm -rf var/cache/* git fetch origin git fetch --tags git checkout 2.0.8 diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index 23bf3682..7c20f4ee 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -11,6 +11,7 @@ Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.htm :: + rm -rf var/cache/* git fetch origin git fetch --tags git checkout 2.1.0 diff --git a/docs/en/user/upgrade-2.0.x-2.0.y.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst index 6a0818b3..3391c2cd 100644 --- a/docs/en/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.0.y.rst @@ -8,6 +8,7 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba :: + rm -rf var/cache/* git fetch origin git fetch --tags git checkout 2.0.8 diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst index 63a77e7c..234045ba 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -11,6 +11,7 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba :: + rm -rf var/cache/* git fetch origin git fetch --tags git checkout 2.1.0 diff --git a/docs/fr/user/upgrade-2.0.x-2.0.y.rst b/docs/fr/user/upgrade-2.0.x-2.0.y.rst index d8dfac6e..8d8ad806 100644 --- a/docs/fr/user/upgrade-2.0.x-2.0.y.rst +++ b/docs/fr/user/upgrade-2.0.x-2.0.y.rst @@ -8,6 +8,7 @@ La dernière version de wallabag est publiée à cette adresse : https://www.wal :: + rm -rf var/cache/* git fetch origin git fetch --tags git checkout 2.0.8 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 index dc66682a..fdd1f0cb 100644 --- a/docs/fr/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/fr/user/upgrade-2.0.x-2.1.y.rst @@ -11,6 +11,7 @@ La dernière version de wallabag est publiée à cette adresse : https://www.wal :: + rm -rf var/cache/* git fetch origin git fetch --tags git checkout 2.1.0 -- cgit v1.2.3 From f7265b4b9dbe93b928874d6ec827cfbc27dffbb2 Mon Sep 17 00:00:00 2001 From: Zayon Date: Mon, 3 Oct 2016 23:21:35 +0200 Subject: Add php-bcmath extension to requirements Fix issue #2342 --- docs/de/user/installation.rst | 1 + docs/en/user/installation.rst | 1 + docs/fr/user/installation.rst | 1 + 3 files changed, 3 insertions(+) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 7fa8c625..a7789656 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -23,6 +23,7 @@ nicht alle folgenden Pakete installieren. - php-curl - php-gettext - php-tokenizer +- php-bcmath wallabag nutzt PDO, um sich mit der Datenbank zu verbinden, darum benötigst du eines der folgenden Komponenten: diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 82fa6f4e..8a26a376 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -22,6 +22,7 @@ You'll need the following extensions for wallabag to work. Some of these may alr - php-curl - php-gettext - php-tokenizer +- php-bcmath wallabag uses PDO to connect to the database, so you'll need one of the following: diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index bb4de534..3dba25a0 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -22,6 +22,7 @@ Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est - php-curl - php-gettext - php-tokenizer +- php-bcmath wallabag utilise PDO afin de se connecter à une base de données, donc vous aurez besoin d'une extension et d'un système de bases de données parmi : -- cgit v1.2.3 From f440e282819a1e92e3200cf2e588fc9a0c1278ac Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Tue, 4 Oct 2016 10:25:49 +0200 Subject: Update doc Merge VALIDATE_TRANSLATION_FILE & ASSET build (less build on Travis) --- docs/de/user/installation.rst | 2 +- docs/de/user/upgrade-2.0.x-2.1.y.rst | 2 +- docs/en/user/installation.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.y.rst | 2 +- docs/fr/user/installation.rst | 2 +- docs/fr/user/upgrade-2.0.x-2.1.y.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 7fa8c625..f9f34c3c 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -55,7 +55,7 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: git clone https://github.com/wallabag/wallabag.git cd wallabag git checkout 2.1.0 - ASSETS=build ./install.sh + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index 7c20f4ee..7319a18a 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -15,7 +15,7 @@ Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.htm git fetch origin git fetch --tags git checkout 2.1.0 - ASSETS=build ./install.sh + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 82fa6f4e..756eb74c 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -54,7 +54,7 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag git checkout 2.1.0 - ASSETS=build ./install.sh + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod To start PHP's build-in server and test if everything did install correctly, you can do: diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst index 234045ba..ce5b5441 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -15,7 +15,7 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba git fetch origin git fetch --tags git checkout 2.1.0 - ASSETS=build ./install.sh + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index bb4de534..e8d18434 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -52,7 +52,7 @@ Pour installer wallabag, vous devez exécuter ces commandes : git clone https://github.com/wallabag/wallabag.git cd wallabag git checkout 2.1.0 - ASSETS=build ./install.sh + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : 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 index fdd1f0cb..a059cfb8 100644 --- a/docs/fr/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/fr/user/upgrade-2.0.x-2.1.y.rst @@ -15,7 +15,7 @@ La dernière version de wallabag est publiée à cette adresse : https://www.wal git fetch origin git fetch --tags git checkout 2.1.0 - ASSETS=build ./install.sh + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod -- cgit v1.2.3 From 5958597ba6c54abe0922e1950f301f6f40cdb430 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 3 Oct 2016 21:11:31 +0200 Subject: Prepare wallabag 2.1.1 --- docs/de/user/installation.rst | 2 +- docs/de/user/upgrade-2.0.x-2.1.y.rst | 4 ++-- docs/en/user/installation.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.y.rst | 4 ++-- docs/fr/user/installation.rst | 2 +- docs/fr/user/upgrade-2.0.x-2.1.y.rst | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index c438761f..3578dca9 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -55,7 +55,7 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.0 + git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index 7319a18a..8ee2ae59 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -7,14 +7,14 @@ Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den inte Update auf einem dedizierten Webserver -------------------------------------- -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.1`` mit der neuesten Releasenummer): :: rm -rf var/cache/* git fetch origin git fetch --tags - git checkout 2.1.0 + git checkout 2.1.0 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 833a36a6..bab8f0a5 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -54,7 +54,7 @@ To install wallabag itself, you must run the following commands: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.0 + git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst index ce5b5441..649ab6ca 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -7,14 +7,14 @@ Before this migration, if you configured the Pocket import by adding your consum Upgrade on a dedicated web server --------------------------------- -The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): +The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.1`` by the last release number): :: rm -rf var/cache/* git fetch origin git fetch --tags - git checkout 2.1.0 + git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index cba8444a..fecdea0f 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -52,7 +52,7 @@ Pour installer wallabag, vous devez exécuter ces commandes : git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.0 + git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod 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 index a059cfb8..42136212 100644 --- a/docs/fr/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/fr/user/upgrade-2.0.x-2.1.y.rst @@ -7,14 +7,14 @@ Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajouta Mise à jour sur un serveur dédié -------------------------------- -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) : +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.1`` par le numéro de la dernière version) : :: rm -rf var/cache/* git fetch origin git fetch --tags - git checkout 2.1.0 + git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod -- cgit v1.2.3 From 8ebb214ec440db0d768fc67f860aec377ae5166d Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Tue, 4 Oct 2016 17:12:45 +0200 Subject: Typo --- docs/de/user/upgrade-2.0.x-2.1.y.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index 8ee2ae59..a30488f8 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -14,7 +14,7 @@ Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.htm rm -rf var/cache/* git fetch origin git fetch --tags - git checkout 2.1.0 --force + git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod -- cgit v1.2.3 From 837247dea48f94644cbc9589b0239265ce33d6f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 4 Oct 2016 17:43:28 +0200 Subject: Update md5 hash for package --- docs/de/user/upgrade-2.0.x-2.1.y.rst | 2 +- docs/en/user/installation.rst | 2 +- docs/en/user/upgrade-2.0.x-2.1.y.rst | 2 +- docs/fr/user/installation.rst | 2 +- docs/fr/user/upgrade-2.0.x-2.1.y.rst | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst index a30488f8..eee50fe4 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.y.rst @@ -30,7 +30,7 @@ Lade das neueste Release von wallabag herunter: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash: ``6c33520e29cc754b687f9cee0398dede``) +(2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``) Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index bab8f0a5..4aaabd82 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -86,7 +86,7 @@ Execute this command to download and extract the latest package: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``) +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) Now, read the following documentation to create your virtual host, then access your wallabag. If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst index 649ab6ca..ec353a18 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.y.rst @@ -30,7 +30,7 @@ Download the last release of wallabag: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the 2.1.0 package: ``6c33520e29cc754b687f9cee0398dede``) +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index fecdea0f..9dd39af7 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -83,7 +83,7 @@ Exécutez cette commande pour télécharger et décompresser l'archive : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(hash md5 de l'archive 2.1.0 : ``6c33520e29cc754b687f9cee0398dede``) +(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``. 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 index 42136212..952fa737 100644 --- a/docs/fr/user/upgrade-2.0.x-2.1.y.rst +++ b/docs/fr/user/upgrade-2.0.x-2.1.y.rst @@ -30,7 +30,7 @@ Téléchargez la dernière version de wallabag : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(hash md5 de l'archive 2.1.0 : ``6c33520e29cc754b687f9cee0398dede``) +(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. -- cgit v1.2.3 From baf0ffa7df64b1bfe140593fb52f979fef97dbae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 7 Oct 2016 14:17:13 +0200 Subject: Added documentation about siteconfig fix Found in #2358, thank you @j0k3r --- docs/en/user/errors_during_fetching.rst | 18 +++++++++++++++--- docs/fr/user/errors_during_fetching.rst | 18 +++++++++++++++--- 2 files changed, 30 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index 68892750..615eb2da 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst @@ -12,9 +12,21 @@ There may be several reasons: How can I help to fix that? --------------------------- -- `by sending us an email with the article's URL `_ -- by trying to fix this article by yourself :) by creating a file for the article. - You can use `this tool `__. +You can `sending us an email with the article's URL `_. + +Or you can also try to fix this problem by yourself. + +You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same way as wallabag to retrieve content). + +If it works here and not on wallabag, it means there are something internally in wallabag that breaks the parser (hard to fix). + +If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). + +You can test it **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. + +Repeat until you have something ok. + +Then you can submit a pull request to `https://github.com/fivefilters/ftr-site-config `_ which is the global repo for siteconfig files. How can I try to re-fetch this article? --------------------------------------- diff --git a/docs/fr/user/errors_during_fetching.rst b/docs/fr/user/errors_during_fetching.rst index 74290bef..a5d3680a 100644 --- a/docs/fr/user/errors_during_fetching.rst +++ b/docs/fr/user/errors_during_fetching.rst @@ -12,9 +12,21 @@ Il peut y avoir plusieurs raisons : Comment puis-je aider pour réparer ça ? --------------------------------------- -- `en nous envoyant un email avec l'URL de l'article `_ -- en essayant de réparer cet article par vous-même :) en créant un fichier pour l'article. - Vous pouvez utiliser `cet outil `__. +Vous pouvez `nous envoyer un email avec l'URL de l'article `_. + +Ou vous pouvez aussi essayer de résoudre ce problème vous même. + +Vous pouvez essayer de voir si ça fonctionne ici : `http://f43.me/feed/test `_ (ce site utilise principalement la même manière de fonctionner que wallabag pour récupérer les articles). + +Si ça fonctionne ici et pas sur wallabag, c'est qu'il y a un souci avec wallabag qui casse le parser (difficile à résoudre). + +Si ça ne fonctionne pas, vous pouvez essayer de créer un fichier de configuration en utilisant : `http://siteconfig.fivefilters.org/ `_ (sélectionnez les parties du contenu qui correspondent à ce que vous souhaitez garder). + +Vous pouvez tester ce fichier sur le site **f43.me** : cliquez sur **Want to try a custom siteconfig?** et insérez le fichier généré depuis siteconfig.fivefilters.org. + +Répétez cette opération jusqu'à avoir quelque chose qui vous convienne. + +Ensuite, vous pouvez créer une pull request ici `https://github.com/fivefilters/ftr-site-config `_, qui est le projet principal pour stocker les fichiers de configuration. Comment puis-je réessayer de récupérer le contenu ? --------------------------------------------------- -- cgit v1.2.3 From 9cfea18a5dbcf0aee8a755396dd25084671e1b02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 7 Oct 2016 14:40:32 +0200 Subject: Fixed review --- docs/en/user/errors_during_fetching.rst | 4 ++-- docs/fr/user/errors_during_fetching.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index 615eb2da..e8ef6ce6 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst @@ -14,7 +14,7 @@ How can I help to fix that? You can `sending us an email with the article's URL `_. -Or you can also try to fix this problem by yourself. +Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same way as wallabag to retrieve content). @@ -22,7 +22,7 @@ If it works here and not on wallabag, it means there are something internally in If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). -You can test it **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. +You can test it on **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. Repeat until you have something ok. diff --git a/docs/fr/user/errors_during_fetching.rst b/docs/fr/user/errors_during_fetching.rst index a5d3680a..5fa29a85 100644 --- a/docs/fr/user/errors_during_fetching.rst +++ b/docs/fr/user/errors_during_fetching.rst @@ -14,7 +14,7 @@ Comment puis-je aider pour réparer ça ? Vous pouvez `nous envoyer un email avec l'URL de l'article `_. -Ou vous pouvez aussi essayer de résoudre ce problème vous même. +Ou vous pouvez aussi essayer de résoudre ce problème vous même (comme ça, nous restons concentrés pour améliorer wallabag au lieu d'écrire ces fichiers de configuration :) ). Vous pouvez essayer de voir si ça fonctionne ici : `http://f43.me/feed/test `_ (ce site utilise principalement la même manière de fonctionner que wallabag pour récupérer les articles). -- cgit v1.2.3 From fba816c43bdf787d587f2fb11ba7c6b385a40dea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 7 Oct 2016 15:14:15 +0200 Subject: Added link to fivefilters website --- docs/en/user/errors_during_fetching.rst | 6 +++--- docs/fr/user/errors_during_fetching.rst | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index e8ef6ce6..3190b4cc 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst @@ -16,11 +16,11 @@ You can `sending us an email with the article's URL ` Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). -You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same way as wallabag to retrieve content). +You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same système as wallabag to retrieve content). -If it works here and not on wallabag, it means there are something internally in wallabag that breaks the parser (hard to fix). +If it works here and not on wallabag, it mean there is something internally in wallabag that breaks the parser (hard to fix: please open an issue about it). -If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). +If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). You can `read this documentation before `_. You can test it on **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. diff --git a/docs/fr/user/errors_during_fetching.rst b/docs/fr/user/errors_during_fetching.rst index 5fa29a85..1a60e4bd 100644 --- a/docs/fr/user/errors_during_fetching.rst +++ b/docs/fr/user/errors_during_fetching.rst @@ -18,9 +18,9 @@ Ou vous pouvez aussi essayer de résoudre ce problème vous même (comme ça, no Vous pouvez essayer de voir si ça fonctionne ici : `http://f43.me/feed/test `_ (ce site utilise principalement la même manière de fonctionner que wallabag pour récupérer les articles). -Si ça fonctionne ici et pas sur wallabag, c'est qu'il y a un souci avec wallabag qui casse le parser (difficile à résoudre). +Si ça fonctionne ici et pas sur wallabag, c'est qu'il y a un souci avec wallabag qui casse le parser (difficile à résoudre : merci d'ouvrir un nouveau ticket à ce sujet). -Si ça ne fonctionne pas, vous pouvez essayer de créer un fichier de configuration en utilisant : `http://siteconfig.fivefilters.org/ `_ (sélectionnez les parties du contenu qui correspondent à ce que vous souhaitez garder). +Si ça ne fonctionne pas, vous pouvez essayer de créer un fichier de configuration en utilisant : `http://siteconfig.fivefilters.org/ `_ (sélectionnez les parties du contenu qui correspondent à ce que vous souhaitez garder). Vous pouvez `lire cette documentation avant `_. Vous pouvez tester ce fichier sur le site **f43.me** : cliquez sur **Want to try a custom siteconfig?** et insérez le fichier généré depuis siteconfig.fivefilters.org. -- cgit v1.2.3 From 4e5d219663b08c5dfba2aaa885c9cef38097bf7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 7 Oct 2016 15:27:05 +0200 Subject: Fixed review --- docs/en/user/errors_during_fetching.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index 3190b4cc..6684563a 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst @@ -16,9 +16,9 @@ You can `sending us an email with the article's URL ` Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). -You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same système as wallabag to retrieve content). +You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same system as wallabag to retrieve content). -If it works here and not on wallabag, it mean there is something internally in wallabag that breaks the parser (hard to fix: please open an issue about it). +If it works here and not on wallabag, it means there is something internally in wallabag that breaks the parser (hard to fix: please open an issue about it). If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). You can `read this documentation before `_. -- 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/de/developer/maintenance.rst | 4 ++-- docs/de/developer/rabbitmq.rst | 14 +++++++------- docs/de/developer/redis.rst | 16 ++++++++-------- docs/en/developer/maintenance.rst | 4 ++-- docs/en/developer/rabbitmq.rst | 14 +++++++------- docs/en/developer/redis.rst | 16 ++++++++-------- docs/fr/developer/maintenance.rst | 4 ++-- docs/fr/developer/rabbitmq.rst | 14 +++++++------- docs/fr/developer/redis.rst | 16 ++++++++-------- 9 files changed, 51 insertions(+), 51 deletions(-) (limited to 'docs') diff --git a/docs/de/developer/maintenance.rst b/docs/de/developer/maintenance.rst index 2a9070e1..31343876 100644 --- a/docs/de/developer/maintenance.rst +++ b/docs/de/developer/maintenance.rst @@ -11,7 +11,7 @@ Um den Wartungsmodus zu aktivieren, führe folgendes Kommando aus: :: - bin/console lexik:maintenance:lock --no-interaction + bin/console lexik:maintenance:lock -e=prod --no-interaction Du kannst deine IP Adresse in ``app/config/config.yml`` setzen, wenn du Zugriff zu wallabag haben willst, auch wenn der Wartungsmodus aktiv ist. Zum Beispiel: @@ -29,4 +29,4 @@ Um den Wartungsmodus zu deaktivieren, führe dieses Kommando aus: :: - bin/console lexik:maintenance:unlock + bin/console lexik:maintenance:unlock -e=prod diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst index bea02ff4..37e9984b 100644 --- a/docs/de/developer/rabbitmq.rst +++ b/docs/de/developer/rabbitmq.rst @@ -55,23 +55,23 @@ Abhängig von welchem Service du importieren möchtest, solltest du einen Cron J .. 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/de/developer/redis.rst b/docs/de/developer/redis.rst index d613ce6c..46334cf0 100644 --- a/docs/de/developer/redis.rst +++ b/docs/de/developer/redis.rst @@ -44,28 +44,28 @@ Abhängig von welchem Service du importieren möchtest, solltest du einen Cron J .. 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 Wenn 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: .. code:: bash - bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 + bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 diff --git a/docs/en/developer/maintenance.rst b/docs/en/developer/maintenance.rst index 8277fb1f..6d55ed60 100644 --- a/docs/en/developer/maintenance.rst +++ b/docs/en/developer/maintenance.rst @@ -11,7 +11,7 @@ To enable maintenance mode, execute this command: :: - bin/console lexik:maintenance:lock --no-interaction + bin/console lexik:maintenance:lock --no-interaction -e=prod You can set your IP address in ``app/config/config.yml`` if you want to access to wallabag even if maintenance mode is enabled. For example: @@ -29,4 +29,4 @@ To disable maintenance mode, execute this command: :: - bin/console lexik:maintenance:unlock + bin/console lexik:maintenance:unlock -e=prod diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index 63b85106..ca0b0f3a 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst @@ -55,22 +55,22 @@ Depending on which service you want to import from you need to enable one (or ma .. 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/en/developer/redis.rst b/docs/en/developer/redis.rst index 820a52e9..005d6e4f 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst @@ -44,28 +44,28 @@ Depending on which service you want to import from you need to enable one (or ma .. 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 If 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 : .. code:: bash - bin/console wallabag:import:redis-worker pocket -vv --maxIterations=12 + bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 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 7eff4736a1309ad71a75fa74dc1081a3b2303169 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 8 Oct 2016 15:10:56 +0200 Subject: Cleaned up documentation for installation process --- docs/de/user/installation.rst | 34 ++++++++++++++++------------------ docs/en/user/android.rst | 10 +++++----- docs/en/user/installation.rst | 32 +++++++++++++++----------------- docs/fr/user/installation.rst | 30 ++++++++++++++---------------- 4 files changed, 50 insertions(+), 56 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 3578dca9..263d53c0 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -6,6 +6,16 @@ Voraussetzungen wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. +wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. + +Composer installieren: + +:: + + curl -s http://getcomposer.org/installer | php + +Du kannst eine spezifische Anleitung `hier `__ finden. + Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell nicht alle folgenden Pakete installieren. @@ -39,25 +49,13 @@ Installation Auf einem dedizierten Webserver (empfohlener Weg) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. - -Composer installieren: - -:: - - curl -s http://getcomposer.org/installer | php - -Du kannst eine spezifische Anleitung `hier `__ finden. - Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + ./install.sh Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: @@ -87,18 +85,18 @@ Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacke wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash: ``6c33520e29cc754b687f9cee0398dede``) +You will find the `md5 hash of the latest package on our website `_. Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``. Installation mit Docker ------------------------- +~~~~~~~~~~~~~~~~~~~~~~ Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub `__, um mehr Informationen zu erhalten. Kommando, um den Container zu starten -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash @@ -108,7 +106,7 @@ Virtualhosts ------------ Konfiguration von Apache -~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~ Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren und du willst PHP als Apache Modul nutzen, dann ist hier ein vhost für wallabag: @@ -198,7 +196,7 @@ Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``. Konfiguration von lighttpd -~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~ Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag (bearbeite deine ``lighttpd.conf`` und füge die Konfiguration dort ein): diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index 4271f037..eec130f6 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst @@ -29,13 +29,13 @@ Fill in your wallabag data. You need to enter your wallabag address. It is impor :alt: Filled in settings :align: center -After you have filled in your data, push the button Connection test and wait for the test to finish. +After you have filled in your data, push the button Connection test and wait for the test to finish. .. image:: ../../img/user/android_configuration_connection_test.en.png :alt: Connection test with your wallabag data :align: center -The connection test shall finish with success. If not, you need to fix this first until you proceed. +The connection test shall finish with success. If not, you need to fix this first until you proceed. .. image:: ../../img/user/android_configuration_connection_test_success.en.png :alt: Connection test successful @@ -65,7 +65,7 @@ After hitting the save button, you get the following screen. The app proposes to :alt: Settings saved the first time :align: center -Finally after the syncronisation finished successfully, you are presented the list of unread articles. +Finally after the syncronisation finished successfully, you are presented the list of unread articles. .. image:: ../../img/user/android_unread_feed_synced.en.png :alt: Filled article list cause feeds successfully syncronized @@ -74,7 +74,7 @@ Finally after the syncronisation finished successfully, you are presented the li Known limitations ----- +----------------- 2FA ~~~ @@ -85,7 +85,7 @@ Currently the does not support two-factor authentication. You should disable tha Limited amount of articles with wallabag v2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. +In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. SSL/TLS encryption diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 4aaabd82..a2f0d07b 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -6,7 +6,17 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. -You'll need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages. +wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). + +Install Composer: + +:: + + curl -s http://getcomposer.org/installer | php + +You can find specific instructions `here `__. + +You'll also need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages. - php-session - php-ctype @@ -38,25 +48,13 @@ Installation On a dedicated web server (recommended way) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). - -Install Composer: - -:: - - curl -s http://getcomposer.org/installer | php - -You can find specific instructions `here `__. - To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: @@ -86,18 +84,18 @@ Execute this command to download and extract the latest package: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) +You will find the `md5 hash of the latest package on our website `_. Now, read the following documentation to create your virtual host, then access your wallabag. If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. Installation with Docker ------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~ We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub `__ to have more information. Command to launch container -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 9dd39af7..b47813be 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -6,6 +6,16 @@ Pré-requis wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. +wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). + +Installation de Composer : + +:: + + curl -s http://getcomposer.org/installer | php + +Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__. + Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est possible que certaines de ces extensions soient déjà activées dans votre version de PHP, donc vous n'avez pas forcément besoin d'installer tous les paquets correspondants. - php-session @@ -36,25 +46,13 @@ Installation Sur un serveur dédié (méthode conseillée) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). - -Installation de Composer : - -:: - - curl -s http://getcomposer.org/installer | php - -Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__. - Pour installer wallabag, vous devez exécuter ces commandes : :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + ./install.sh Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : @@ -83,18 +81,18 @@ Exécutez cette commande pour télécharger et décompresser l'archive : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) +Vous trouverez `le hash md5 du dernier package sur notre site `_. Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``. Installation avec Docker ------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~ Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub `__ pour plus d'informations. Commande pour démarrer le containeur -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash -- cgit v1.2.3 From 5334381509990ea5a5351575abf163c3b6c9dc18 Mon Sep 17 00:00:00 2001 From: Strubbl Date: Sat, 8 Oct 2016 20:25:48 +0200 Subject: update German installation.rst --- docs/de/user/installation.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 263d53c0..615f5f28 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -63,7 +63,7 @@ Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installier php bin/console server:run --env=prod -Und wallabag unter http://deineserverip:8000 erreichen +und wallabag unter http://deineserverip:8000 erreichen. .. tip:: @@ -91,7 +91,7 @@ Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``. Installation mit Docker -~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub `__, um mehr Informationen zu erhalten. @@ -188,11 +188,10 @@ Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installie access_log /var/log/nginx/wallabag_access.log; } -Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http://domain.tld erreichen. +Nach dem Neuladen oder Neustarten von nginx solltest du nun wallabag unter http://domain.tld erreichen. .. tip:: - When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``. Konfiguration von lighttpd -- cgit v1.2.3 From 5112b3556b5a85c791cac6ec89c19939e0677904 Mon Sep 17 00:00:00 2001 From: Strubbl Date: Sat, 8 Oct 2016 20:28:18 +0200 Subject: update German installation.rst --- docs/de/user/installation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 615f5f28..dc2b8b4d 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -85,9 +85,9 @@ Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacke wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -You will find the `md5 hash of the latest package on our website `_. +Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website `_. -Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. +Jetzt lies die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``. Installation mit Docker -- 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/de/developer/testsuite.rst | 10 ++++++++++ docs/de/user/installation.rst | 3 +++ docs/en/developer/testsuite.rst | 10 ++++++++++ docs/en/user/installation.rst | 3 +++ docs/fr/developer/testsuite.rst | 10 ++++++++++ docs/fr/user/installation.rst | 3 +++ 6 files changed, 39 insertions(+) create mode 100644 docs/de/developer/testsuite.rst create mode 100644 docs/en/developer/testsuite.rst create mode 100644 docs/fr/developer/testsuite.rst (limited to 'docs') diff --git a/docs/de/developer/testsuite.rst b/docs/de/developer/testsuite.rst new file mode 100644 index 00000000..b2b16cdc --- /dev/null +++ b/docs/de/developer/testsuite.rst @@ -0,0 +1,10 @@ +Testsuite +========= + +To ensure wallabag development quality, we wrote tests with `PHPUnit `_. + +If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. + +To launch wallabag testsuite, you need to install `ant `_. + +Then, execute this command ``make test``. diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index dc2b8b4d..bee3249b 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -6,6 +6,9 @@ Voraussetzungen wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. +.. note:: +Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. + wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. Composer installieren: diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst new file mode 100644 index 00000000..b2b16cdc --- /dev/null +++ b/docs/en/developer/testsuite.rst @@ -0,0 +1,10 @@ +Testsuite +========= + +To ensure wallabag development quality, we wrote tests with `PHPUnit `_. + +If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. + +To launch wallabag testsuite, you need to install `ant `_. + +Then, execute this command ``make test``. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index a2f0d07b..0920b976 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -6,6 +6,9 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. +.. note:: +To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). Install Composer: 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``. diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index b47813be..55614d72 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -6,6 +6,9 @@ Pré-requis wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. +.. note:: +Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. + wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). Installation de Composer : -- cgit v1.2.3 From 7c1225347db8b516cc268709939f6b359bc283c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 10:20:32 +0200 Subject: Update documentation --- docs/de/user/installation.rst | 5 ++--- docs/en/user/installation.rst | 9 ++++----- docs/fr/user/installation.rst | 5 ++--- 3 files changed, 8 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index bee3249b..2bb86269 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -57,14 +57,13 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: :: - php bin/console server:run --env=prod + make run und wallabag unter http://deineserverip:8000 erreichen. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 0920b976..e08e0306 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -56,14 +56,13 @@ To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install To start PHP's build-in server and test if everything did install correctly, you can do: :: - php bin/console server:run --env=prod + make run And access wallabag at http://yourserverip:8000 @@ -240,12 +239,12 @@ Rights access to the folders of the project Test environment ~~~~~~~~~~~~~~~~ -When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. +When we just want to test wallabag, we just run the command ``make run`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. Production environment ~~~~~~~~~~~~~~~~~~~~~~ -As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. +As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``make run`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 55614d72..b32707f8 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -54,14 +54,13 @@ Pour installer wallabag, vous devez exécuter ces commandes : :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : :: - php bin/console server:run --env=prod + make run Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 -- cgit v1.2.3 From 7c1ce28342c85abb21dc79b9d22be35c0c09891b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 11:21:20 +0200 Subject: Update upgrade documentation --- docs/en/user/upgrade-2.0.x-2.0.y.rst | 35 ------------------- docs/en/user/upgrade-2.0.x-2.1.1.rst | 55 ++++++++++++++++++++++++++++++ docs/en/user/upgrade-2.0.x-2.1.y.rst | 65 ------------------------------------ docs/en/user/upgrade-2.1.x-2.1.y.rst | 35 +++++++++++++++++++ 4 files changed, 90 insertions(+), 100 deletions(-) delete mode 100644 docs/en/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.1.1.rst delete mode 100644 docs/en/user/upgrade-2.0.x-2.1.y.rst create mode 100644 docs/en/user/upgrade-2.1.x-2.1.y.rst (limited to 'docs') diff --git a/docs/en/user/upgrade-2.0.x-2.0.y.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst deleted file mode 100644 index 3391c2cd..00000000 --- a/docs/en/user/upgrade-2.0.x-2.0.y.rst +++ /dev/null @@ -1,35 +0,0 @@ -Upgrade from 2.0.x to 2.0.y -=========================== - -Upgrade on a dedicated web server ---------------------------------- - -The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.8`` by the last release number): - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod - -Upgrade on a shared hosting ---------------------------- - -Backup your ``app/config/parameters.yml`` file. - -Download the last release of wallabag: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``) - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst new file mode 100644 index 00000000..898b4ccc --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst @@ -0,0 +1,55 @@ +Upgrade from 2.0.x to 2.1.1 +=========================== + +.. warning:: +Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. + +Upgrade on a dedicated web server +--------------------------------- + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.1 --force + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Upgrade on a shared hosting +--------------------------- + +Backup your ``app/config/parameters.yml`` file. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.0.8.tar.gz + +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +Please check that your ``app/config/parameters.yml`` contains all the required parameters. Here is a default ``parameters.yml`` file. If you don't know which parameter you need to set, please leave the default one. + +.. code-block:: yml + + + + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. + +You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst deleted file mode 100644 index ec353a18..00000000 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ /dev/null @@ -1,65 +0,0 @@ -Upgrading from 2.0.x to 2.1.y -============================= - -.. warning:: -Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. - -Upgrade on a dedicated web server ---------------------------------- - -The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.1`` by the last release number): - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Upgrade on a shared hosting ---------------------------- - -Backup your ``app/config/parameters.yml`` file. - -Download the last release of wallabag: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) : - -.. code-block:: bash - - # RabbitMQ processing - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis processing - redis_host: localhost - redis_port: 6379 - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. - -You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/user/upgrade-2.1.x-2.1.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst new file mode 100644 index 00000000..575f4ba9 --- /dev/null +++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst @@ -0,0 +1,35 @@ +Upgrading from 2.1.x to 2.1.y +============================= + +Upgrade on a dedicated web server +--------------------------------- + +The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.2`` by the last release number): + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.2 --force + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Upgrade on a shared hosting +--------------------------- + +Backup your ``app/config/parameters.yml`` file. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. -- cgit v1.2.3 From eb54d338e8d013ed9323f619c960fa57369bd9a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 11:35:32 +0200 Subject: Typos in upgrade doc --- docs/en/user/upgrade-2.0.x-2.1.1.rst | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index 898b4ccc..2f08b7bd 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst @@ -14,6 +14,7 @@ Upgrade on a dedicated web server git fetch --tags git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod Upgrade on a shared hosting @@ -25,7 +26,7 @@ Download the last release of wallabag: .. code-block:: bash - wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.0.8.tar.gz + wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) @@ -35,8 +36,33 @@ Please check that your ``app/config/parameters.yml`` contains all the required p .. code-block:: yml - - + parameters: + database_driver: pdo_sqlite + database_host: 127.0.0.1 + database_port: null + database_name: symfony + database_user: root + database_password: null + database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' + database_table_prefix: wallabag_ + mailer_transport: smtp + mailer_host: 127.0.0.1 + mailer_user: null + mailer_password: null + locale: en + secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv + twofactor_auth: true + twofactor_sender: no-reply@wallabag.org + fosuser_registration: true + fosuser_confirmation: true + from_email: no-reply@wallabag.org + rss_limit: 50 + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + redis_host: localhost + redis_port: 6379 If you use SQLite, you must also copy your ``data/`` folder inside the new installation. -- cgit v1.2.3 From ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 13:01:14 +0200 Subject: Added page about parameters.yml --- docs/de/user/installation.rst | 2 +- docs/en/user/android.rst | 6 +++--- docs/en/user/parameters.rst | 48 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 52 insertions(+), 4 deletions(-) create mode 100644 docs/en/user/parameters.rst (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 2bb86269..0d082e41 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -7,7 +7,7 @@ Voraussetzungen wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. .. note:: -Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. +To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index eec130f6..ccbad264 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst @@ -35,7 +35,7 @@ After you have filled in your data, push the button Connection test and wait for :alt: Connection test with your wallabag data :align: center -The connection test shall finish with success. If not, you need to fix this first until you proceed. +The connection test should finish with success. If not, you need to fix this first until you proceed. .. image:: ../../img/user/android_configuration_connection_test_success.en.png :alt: Connection test successful @@ -65,10 +65,10 @@ After hitting the save button, you get the following screen. The app proposes to :alt: Settings saved the first time :align: center -Finally after the syncronisation finished successfully, you are presented the list of unread articles. +Finally after the synchronisation finished successfully, you are presented to the list of unread articles. .. image:: ../../img/user/android_unread_feed_synced.en.png - :alt: Filled article list cause feeds successfully syncronized + :alt: Filled article list cause feeds successfully synchronized :align: center diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst new file mode 100644 index 00000000..94eff689 --- /dev/null +++ b/docs/en/user/parameters.rst @@ -0,0 +1,48 @@ +What is the meaning of the parameters? +====================================== + +.. code-block:: yml + + # Database parameters + database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql + database_host: 127.0.0.1 + database_port: ~ + database_name: symfony + database_user: root + database_password: ~ + database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql) + database_table_prefix: wallabag_ + database_socket: null + + # Configuration to send emails from wallabag + mailer_transport: smtp + mailer_host: 127.0.0.1 + mailer_user: ~ + mailer_password: ~ + + locale: en # Default language of your wallabag instance + + secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security + + twofactor_auth: true # true to enable Two factor authentication + twofactor_sender: no-reply@wallabag.org + + fosuser_registration: true # true to enable public registration + fosuser_confirmation: true # true to send a confirmation by email for each registration + + from_email: no-reply@wallabag.org # email address used in From: field in each email + + rss_limit: 50 # limit for RSS feeds + + # RabbitMQ configuration + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + # Redis configuration + redis_scheme: tcp + redis_host: localhost + redis_port: 6379 + redis_path: null + -- cgit v1.2.3 From 035513b0257ca5147759432e463e81bc9000221e Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Mon, 10 Oct 2016 13:42:50 +0200 Subject: Use table for parameters.yml --- docs/en/user/parameters.rst | 94 +++++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 46 deletions(-) (limited to 'docs') diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst index 94eff689..79c50871 100644 --- a/docs/en/user/parameters.rst +++ b/docs/en/user/parameters.rst @@ -1,48 +1,50 @@ What is the meaning of the parameters? ====================================== - -.. code-block:: yml - - # Database parameters - database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql - database_host: 127.0.0.1 - database_port: ~ - database_name: symfony - database_user: root - database_password: ~ - database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql) - database_table_prefix: wallabag_ - database_socket: null - - # Configuration to send emails from wallabag - mailer_transport: smtp - mailer_host: 127.0.0.1 - mailer_user: ~ - mailer_password: ~ - - locale: en # Default language of your wallabag instance - - secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security - - twofactor_auth: true # true to enable Two factor authentication - twofactor_sender: no-reply@wallabag.org - - fosuser_registration: true # true to enable public registration - fosuser_confirmation: true # true to send a confirmation by email for each registration - - from_email: no-reply@wallabag.org # email address used in From: field in each email - - rss_limit: 50 # limit for RSS feeds - - # RabbitMQ configuration - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis configuration - redis_scheme: tcp - redis_host: localhost - redis_port: 6379 - redis_path: null - +.. csv-table:: Database parameters + :header: "name", "default", "description" + + "database_driver", "pdo_sqlite", "Should be pdo_sqlite or pdo_mysql or pdo_pgsql" + "database_host", "127.0.0.1", "host of your database (usually localhost or 127.0.0.1)" + "database_port", "~", "port of your database (you can leave ``~`` to use the default one)" + "database_name", "symfony", "name of your database" + "database_user", "root", "user that can write to this database" + "database_password", "~", "password of that user" + "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it for other database" + "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" + "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored" + +.. csv-table:: Configuration to send emails from wallabag + :header: "name", "default", "description" + + "mailer_transport", "smtp", "The exact transport method to use to deliver emails. Valid values are: smtp, gmail, mail, sendmail, null (which will disable the mailer)" + "mailer_host", "127.0.0.1", "The host to connect to when using smtp as the transport." + "mailer_user", "~", "The username when using smtp as the transport." + "mailer_password", "~", "The password when using smtp as the transport." + +.. csv-table:: Other wallabag's option + :header: "name", "default", "description" + + "locale", "en", "Default language of your wallabag instance (like en, fr, es, etc.)" + "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "This is a string that should be unique to your application and it's commonly used to add more entropy to security related operations." + "twofactor_auth", "true", "true to enable Two factor authentication" + "twofactor_sender", "no-reply@wallabag.org", "email of the email sender to receive the two factor code" + "fosuser_registration", "true", "true to enable public registration" + "fosuser_confirmation", "true", "true to send a confirmation by email for each registration" + "from_email", "no-reply@wallabag.org", "email address used in From: field in each email" + "rss_limit", "50", "limit for RSS feeds" + +.. csv-table:: RabbitMQ configuration + :header: "name", "default", "description" + + "rabbitmq_host", "localhost", "Host of your RabbitMQ" + "rabbitmq_port", "5672", "Port of your RabbitMQ" + "rabbitmq_user", "guest", "Usee that can read queues" + "rabbitmq_password", "guest", "Password of that user" + +.. csv-table:: Redis configuration + :header: "name", "default", "description" + + "redis_scheme", "tcp", "Specifies the protocol used to communicate with an instance of Redis. Valid values are: tcp, unix, http" + "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)" + "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)" + "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets" -- cgit v1.2.3 From c15f083896768ff7eb38be35003b7668bfaa7252 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 15:38:42 +0200 Subject: Fixed links on import page --- docs/en/user/import.rst | 4 ++-- docs/fr/user/import.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 758e3816..70f0187d 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -35,7 +35,7 @@ From Readability Export your Readability data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -On the tools (`https://www.readability.com/tools/`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). +On the tools (`https://www.readability.com/tools/ `_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -51,7 +51,7 @@ From Instapaper Export your Instapaper data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -On the settings (`https://www.instapaper.com/user`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). +On the settings (`https://www.instapaper.com/user `_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index 6f114dd6..2e6caafb 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst @@ -36,7 +36,7 @@ Depuis Readability Exportez vos données de Readability ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sur la page des outils (`https://www.readability.com/tools/`_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json. +Sur la page des outils (`https://www.readability.com/tools/ `_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json. Importez vos données dans wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -52,7 +52,7 @@ Depuis Instapaper Exportez vos données de Instapaper ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sur la page des paramètres (`https://www.instapaper.com/user`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). +Sur la page des paramètres (`https://www.instapaper.com/user `_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``). Importez vos données dans wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- 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/de/developer/rabbitmq.rst | 4 ++++ docs/de/developer/redis.rst | 4 ++++ docs/en/developer/rabbitmq.rst | 4 ++++ docs/en/developer/redis.rst | 4 ++++ docs/fr/developer/rabbitmq.rst | 4 ++++ docs/fr/developer/redis.rst | 4 ++++ 6 files changed, 24 insertions(+) (limited to 'docs') diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst index 37e9984b..f81e07e3 100644 --- a/docs/de/developer/rabbitmq.rst +++ b/docs/de/developer/rabbitmq.rst @@ -46,6 +46,10 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht rabbitmq_user: guest rabbitmq_password: guest +Enable RabbitMQ in wallabag +--------------------------- + +In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). Starte den RabbitMQ Consumer ---------------------------- diff --git a/docs/de/developer/redis.rst b/docs/de/developer/redis.rst index 46334cf0..57b41550 100644 --- a/docs/de/developer/redis.rst +++ b/docs/de/developer/redis.rst @@ -35,6 +35,10 @@ Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzuricht redis_host: localhost redis_port: 6379 +Enable Redis in wallabag +------------------------ + +In internal settings, in the **Import** section, enable Redis (with the value 1). Starte den Redis Consumer ------------------------- diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst index ca0b0f3a..673228e9 100644 --- a/docs/en/developer/rabbitmq.rst +++ b/docs/en/developer/rabbitmq.rst @@ -46,6 +46,10 @@ Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default on rabbitmq_user: guest rabbitmq_password: guest +Enable RabbitMQ in wallabag +--------------------------- + +In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). Launch RabbitMQ consumer ------------------------ diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 005d6e4f..67b6452e 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst @@ -35,6 +35,10 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s redis_host: localhost redis_port: 6379 +Enable Redos in wallabag +------------------------ + +In internal settings, in the **Import** section, enable Redis (with the value 1). Launch Redis consumer --------------------- 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 From 36ef9e2730cad290861cca6813370bc87b8f16c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 18:51:20 +0200 Subject: Fixed display for note in installation page --- docs/de/user/installation.rst | 3 ++- docs/en/user/installation.rst | 3 ++- docs/fr/user/installation.rst | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 0d082e41..35a30f52 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -7,7 +7,8 @@ Voraussetzungen wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. .. note:: -To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + + To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index e08e0306..248c1995 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -7,7 +7,8 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. .. note:: -To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + + To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index b32707f8..62e7d334 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -7,7 +7,8 @@ Pré-requis wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. .. note:: -Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. + + Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``. wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``). -- cgit v1.2.3 From 7e72b371bab76539708340f9c4305b745e591269 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 11 Oct 2016 14:59:32 +0200 Subject: Fix links on english documentation homepage --- docs/en/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/en/index.rst b/docs/en/index.rst index beb3816e..4e346ae6 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -30,8 +30,8 @@ The documentation is available in other languages: user/faq user/installation - user/upgrade-2.0.x-2.1.y - user/upgrade-2.0.x-2.0.y + user/upgrade-2.0.x-2.1.1 + user/upgrade-2.1.x-2.1.y user/migration user/import user/create_account -- cgit v1.2.3 From 18470d7c6a5c71e4503f7661e85120630541afb8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 12 Oct 2016 13:19:45 +0200 Subject: Added french documentation for parameters.yml --- docs/en/index.rst | 1 + docs/en/user/parameters.rst | 6 +++--- docs/fr/index.rst | 1 + docs/fr/user/parameters.rst | 50 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 55 insertions(+), 3 deletions(-) create mode 100644 docs/fr/user/parameters.rst (limited to 'docs') diff --git a/docs/en/index.rst b/docs/en/index.rst index 4e346ae6..6d85db2b 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -45,6 +45,7 @@ The documentation is available in other languages: user/filters user/tags user/android + user/parameters .. _dev-docs: diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst index 79c50871..6cbd5ae4 100644 --- a/docs/en/user/parameters.rst +++ b/docs/en/user/parameters.rst @@ -9,9 +9,9 @@ What is the meaning of the parameters? "database_name", "symfony", "name of your database" "database_user", "root", "user that can write to this database" "database_password", "~", "password of that user" - "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it for other database" + "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty for other database" "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" - "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored" + "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)" .. csv-table:: Configuration to send emails from wallabag :header: "name", "default", "description" @@ -38,7 +38,7 @@ What is the meaning of the parameters? "rabbitmq_host", "localhost", "Host of your RabbitMQ" "rabbitmq_port", "5672", "Port of your RabbitMQ" - "rabbitmq_user", "guest", "Usee that can read queues" + "rabbitmq_user", "guest", "User that can read queues" "rabbitmq_password", "guest", "Password of that user" .. csv-table:: Redis configuration diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 359b103c..082173e5 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -45,6 +45,7 @@ La documentation est disponible dans d'autres langues : user/share user/filters user/tags + user/parameters .. _dev-docs: diff --git a/docs/fr/user/parameters.rst b/docs/fr/user/parameters.rst new file mode 100644 index 00000000..ec8c8995 --- /dev/null +++ b/docs/fr/user/parameters.rst @@ -0,0 +1,50 @@ +À quoi servent les paramètres ? +=============================== +.. csv-table:: Paramètres de base de données + :header: "name", "default", "description" + + "database_driver", "pdo_sqlite", "Doit être pdo_sqlite ou pdo_mysql ou pdo_pgsql" + "database_host", "127.0.0.1", "Hôte de votre base de données (généralement localhost ou 127.0.0.1)" + "database_port", "~", "Port de votre base de données (vous pouvez laisser ``~`` pour utiliser celui par défaut)" + "database_name", "symfony", "Nom de votre base de données" + "database_user", "root", "Utilisateur de votre base de données" + "database_password", "~", "Mot de passe de cet utilisateur" + "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "Uniquement pour SQLite. Chemin du fichier de base de données. Laissez vide pour les autres bases de données." + "database_table_prefix", "wallabag_", "Toutes les tables de wallabag seront préfixées par cette chaine. Vous pouvez ajouter un ``_`` pour plus de clarté" + "database_socket", "null", "Si votre base de données utilise un socket plutôt que tcp, spécifiez le chemin du socket (les autres paramètres de connexion seront alors ignorés)" + +.. csv-table:: Configuration pour envoyer des emails depuis wallabag + :header: "name", "default", "description" + + "mailer_transport", "smtp", "Méthode de transport exacte utilisée pour envoyer des emails. Les valeurs correctes sont : smtp, gmail, mail, sendmail, null (ce qui désactivera l'envoi des emails)" + "mailer_host", "127.0.0.1", "Hôte sur lequel se connecter quand on utilise smtp comme transport." + "mailer_user", "~", "Utilisateur smtp." + "mailer_password", "~", "Mot de passe de cet utilisateur." + +.. csv-table:: Autres options de wallabag + :header: "name", "default", "description" + + "locale", "en", "Langue par défaut de votre instance wallabag (comme en, fr, es, etc.)" + "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "C'est une chaine qui doit être unique à votre application et qui est couramment utilisée pour ajouter plus d'entropie aux opérations relatives à la sécurité." + "twofactor_auth", "true", "true pour activer l'authentification à deux facteurs" + "twofactor_sender", "no-reply@wallabag.org", "Email de l'expéditeur du code de l'authentification à deux facteurs" + "fosuser_registration", "true", "true pour activer l'inscription publique" + "fosuser_confirmation", "true", "true pour envoyer un email de confirmation pour chaque création de compte" + "from_email", "no-reply@wallabag.org", "Email de l'expéditeur pour chaque email envoyé" + "rss_limit", "50", "Limite pour les flux RSS" + +.. csv-table:: Configuration RabbitMQ + :header: "name", "default", "description" + + "rabbitmq_host", "localhost", "Hôte de votre instance RabbitMQ" + "rabbitmq_port", "5672", "Port de votre instance RabbitMQ" + "rabbitmq_user", "guest", "Utilisateur de votre instance RabbitMQ" + "rabbitmq_password", "guest", "Mot de passe de cet utilisateur" + +.. csv-table:: Configuration Redis + :header: "name", "default", "description" + + "redis_scheme", "tcp", "Définit le protocole utilisé pour commuiquer avec l'instance Redis. Les valeurs correctes sont : tcp, unix, http" + "redis_host", "localhost", "IP ou hôte du serveur cible (ignoré pour un schéma unix)" + "redis_port", "6379", "Port TCP/IP du serveur cible (ignoré pour un schéma unix)" + "redis_path", "null", "Chemin du fichier de socket du domaine UNIX utilisé quand on se connecte à Redis en utilisant les sockets du domaine UNIX" -- cgit v1.2.3 From b09cafbb3fb928ccb0c6c7cc98e717133e0df560 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 12 Oct 2016 13:37:50 +0200 Subject: Added french documentation for upgrade --- docs/de/user/upgrade-2.0.x-2.1.1.rst | 65 ++++++++++++++++++++++++++++ docs/de/user/upgrade-2.0.x-2.1.y.rst | 65 ---------------------------- docs/en/user/upgrade-2.0.x-2.1.1.rst | 2 + docs/fr/user/installation.rst | 2 +- docs/fr/user/upgrade-2.0.x-2.0.y.rst | 35 --------------- docs/fr/user/upgrade-2.0.x-2.1.1.rst | 84 ++++++++++++++++++++++++++++++++++++ docs/fr/user/upgrade-2.0.x-2.1.y.rst | 66 ---------------------------- docs/fr/user/upgrade-2.1.x-2.1.y.rst | 35 +++++++++++++++ 8 files changed, 187 insertions(+), 167 deletions(-) create mode 100644 docs/de/user/upgrade-2.0.x-2.1.1.rst delete mode 100644 docs/de/user/upgrade-2.0.x-2.1.y.rst delete mode 100644 docs/fr/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/fr/user/upgrade-2.0.x-2.1.1.rst delete mode 100644 docs/fr/user/upgrade-2.0.x-2.1.y.rst create mode 100644 docs/fr/user/upgrade-2.1.x-2.1.y.rst (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.1.rst b/docs/de/user/upgrade-2.0.x-2.1.1.rst new file mode 100644 index 00000000..eee50fe4 --- /dev/null +++ b/docs/de/user/upgrade-2.0.x-2.1.1.rst @@ -0,0 +1,65 @@ +Wallabag updaten +================ + +.. warning:: +Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.1`` mit der neuesten Releasenummer): + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.1 --force + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``) + +Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): + +.. code-block:: bash + + # RabbitMQ processing + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + # Redis processing + redis_host: localhost + redis_port: 6379 + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. + +Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen in diesem Fall an, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank genutzt wird: + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/de/user/upgrade-2.0.x-2.1.y.rst b/docs/de/user/upgrade-2.0.x-2.1.y.rst deleted file mode 100644 index eee50fe4..00000000 --- a/docs/de/user/upgrade-2.0.x-2.1.y.rst +++ /dev/null @@ -1,65 +0,0 @@ -Wallabag updaten -================ - -.. warning:: -Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. - -Update auf einem dedizierten Webserver --------------------------------------- - -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.1`` mit der neuesten Releasenummer): - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Update auf einem Shared Webhosting ----------------------------------- - -Sichere deine ``app/config/parameters.yml`` Datei. - -Lade das neueste Release von wallabag herunter: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``) - -Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. - -Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): - -.. code-block:: bash - - # RabbitMQ processing - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis processing - redis_host: localhost - redis_port: 6379 - -Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. - -Leere den ``var/cache`` Ordner. - -Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen in diesem Fall an, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank genutzt wird: - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index 2f08b7bd..630d4b74 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst @@ -64,6 +64,8 @@ Please check that your ``app/config/parameters.yml`` contains all the required p redis_host: localhost redis_port: 6379 +You can find `here a documentation about parameters `_. + If you use SQLite, you must also copy your ``data/`` folder inside the new installation. Empty ``var/cache`` folder. diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 62e7d334..4f94d6c8 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -66,7 +66,7 @@ Pour démarrer le serveur interne à php et vérifier que tout s'est installé c Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 .. tip:: - Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire `documentation Symfony `__ pour en savoir plus. + Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire la `documentation Symfony `__ pour en savoir plus. Sur un serveur mutualisé ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/fr/user/upgrade-2.0.x-2.0.y.rst b/docs/fr/user/upgrade-2.0.x-2.0.y.rst deleted file mode 100644 index 8d8ad806..00000000 --- a/docs/fr/user/upgrade-2.0.x-2.0.y.rst +++ /dev/null @@ -1,35 +0,0 @@ -Mettre à jour de la 2.0.x à la 2.0.y -==================================== - -Mise à jour sur un serveur dédié --------------------------------- - -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) : - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod - -Mise à jour sur un hébergement mutualisé ----------------------------------------- - -Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. - -Téléchargez la dernière version de wallabag : - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``) - -Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. - -Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. - -Videz le répertoire ``var/cache``. diff --git a/docs/fr/user/upgrade-2.0.x-2.1.1.rst b/docs/fr/user/upgrade-2.0.x-2.1.1.rst new file mode 100644 index 00000000..ec883d10 --- /dev/null +++ b/docs/fr/user/upgrade-2.0.x-2.1.1.rst @@ -0,0 +1,84 @@ +Mettre à jour de la 2.0.x à la 2.1.1 +==================================== + +.. warning:: +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. + +Mise à jour sur un serveur dédié +-------------------------------- + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.1 --force + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console doctrine:migrations:migrate --env=prod + php bin/console cache:clear --env=prod + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz + +(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +Vérifiez que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. Voici un fichier ``parameters.yml`` par défaut. Si vous ne savez pas quelle valeur mettre à un paramètre, laissez la valeur par défaut. + +.. code-block:: yml + + parameters: + database_driver: pdo_sqlite + database_host: 127.0.0.1 + database_port: null + database_name: symfony + database_user: root + database_password: null + database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' + database_table_prefix: wallabag_ + mailer_transport: smtp + mailer_host: 127.0.0.1 + mailer_user: null + mailer_password: null + locale: en + secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv + twofactor_auth: true + twofactor_sender: no-reply@wallabag.org + fosuser_registration: true + fosuser_confirmation: true + from_email: no-reply@wallabag.org + rss_limit: 50 + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + redis_host: localhost + redis_port: 6379 + +Vous trouverez `ici une documentation détaillée concernant les paramètres `_. + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. + +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 : + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; + 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 deleted file mode 100644 index 952fa737..00000000 --- a/docs/fr/user/upgrade-2.0.x-2.1.y.rst +++ /dev/null @@ -1,66 +0,0 @@ -Mettre à jour de la 2.0.x à la 2.1.y -==================================== - -.. warning:: -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. - -Mise à jour sur un serveur dédié --------------------------------- - -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.1`` par le numéro de la dernière version) : - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Mise à jour sur un hébergement mutualisé ----------------------------------------- - -Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. - -Téléchargez la dernière version de wallabag : - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) - -Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. - -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) : - -.. code-block:: bash - - # RabbitMQ processing - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis processing - redis_host: localhost - redis_port: 6379 - -Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. - -Videz le répertoire ``var/cache``. - -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 : - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; - diff --git a/docs/fr/user/upgrade-2.1.x-2.1.y.rst b/docs/fr/user/upgrade-2.1.x-2.1.y.rst new file mode 100644 index 00000000..c048099f --- /dev/null +++ b/docs/fr/user/upgrade-2.1.x-2.1.y.rst @@ -0,0 +1,35 @@ +Mettre à jour de la 2.1.x à la 2.1.y +==================================== + +Mise à jour sur un serveur dédié +-------------------------------- + +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.2`` par le numéro de la dernière version) : + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.2 --force + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. -- cgit v1.2.3 From 75a1506c276a43f0d3ad65ac1436329e9d5c8c0f Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Wed, 12 Oct 2016 20:33:55 +0200 Subject: translate to German: user/parameters --- docs/de/index.rst | 1 + docs/de/user/parameters.rst | 50 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 docs/de/user/parameters.rst (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index b3cd33b0..9ad62013 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -44,6 +44,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar : user/filters user/tags user/android + user/parameters .. _dev-docs: diff --git a/docs/de/user/parameters.rst b/docs/de/user/parameters.rst new file mode 100644 index 00000000..4c68fe9e --- /dev/null +++ b/docs/de/user/parameters.rst @@ -0,0 +1,50 @@ +Was bedeuten die Parameter? +=========================== +.. csv-table:: Datenbankparameter + :header: "Name", "Standardwert", "Beschreibung" + + "database_driver", "pdo_sqlite", "Sollte pdo_sqlite oder pdo_mysql oder pdo_pgsql sein" + "database_host", "127.0.0.1", "Hostadresse deiner Datenbank (normalerweise localhost oder 127.0.0.1)" + "database_port", "~", "Port deiner Datenbank (Du kannst ``~`` stehen lassen, um den Standardport zu nutzen)" + "database_name", "symfony", "Benenne deine Datenbank" + "database_user", "root", "Benutzer, der Schreibrecht in der Datenbank hat" + "database_password", "~", "Passwort des Benutzers" + "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "nur für SQLite, definiere, wo die Datenbankdatei abgelegt werden soll. Lass den Parameter leer für andere Datenbanktypen." + "database_table_prefix", "wallabag_", "alle wallabag Tabellen erhalten diesen Präfix im Namen. Du kannst einen ``_`` dafür im Präfix nutzen, um das zu verdeutlichen." + "database_socket", "null", "Wenn deine Datenbank einen Socket statt TCP nutzt, schreibe hier den Pfad zum Socket hin (andere Verbindungsparameter werden dann ignoriert." + +.. csv-table:: Konfiguration, um mit wallabag E-Mails senden zu können + :header: "Name", "Standardwert", "Beschreibung" + + "mailer_transport", "smtp", "Die exakte Transportmethode, um E-Mails zuzustellen. Gültige Werte sind: smtp, gmail, mail, sendmail, null (was das Mailen deaktivert)" + "mailer_host", "127.0.0.1", "Der Host, zu dem sich verbunden wird, wenn SMTP als Transport genutzt wird." + "mailer_user", "~", "Der Benutzername, wenn SMTP als Transport genutzt wird." + "mailer_password", "~", "Das Passwort, wenn SMTP als Transport genutzt wird." + +.. csv-table:: Andere wallabag Optionen + :header: "Name", "Standardwert", "Beschreibung" + + "locale", "en", "Standardsprache deiner wallabag Instanz (wie z.B. en, fr, es, etc.)" + "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "Dieser String sollte einzigartig für deine Applikation sein und er wird genutzt, um sicherheitsrelevanten Operationen mehr Entropie hinzuzufügen." + "twofactor_auth", "true", "true, um Zwei-Faktor-Authentifizierung zu aktivieren" + "twofactor_sender", "no-reply@wallabag.org", "E-Mail-Adresse des Senders der Mails mit dem Code für die Zwei-Faktor-Authentifizierung" + "fosuser_registration", "true", "true, um die Registrierung für jedermann zu aktivieren" + "fosuser_confirmation", "true", "true, um eine Bestätigungsmail für jede Registrierung zu senden" + "from_email", "no-reply@wallabag.org", "E-Mail-Adresse, die im Absenderfeld jeder Mail genutzt wird" + "rss_limit", "50", "Artikellimit für RSS Feeds" + +.. csv-table:: RabbitMQ Konfiguration + :header: "Name", "Standardwert", "Beschreibung" + + "rabbitmq_host", "localhost", "Host deines RabbitMQ" + "rabbitmq_port", "5672", "Port deines RabbitMQ" + "rabbitmq_user", "guest", "Benutzer, der die Queue lesen kann" + "rabbitmq_password", "guest", "Passwort dieses Benutzers" + +.. csv-table:: Redis Konfiguration + :header: "Name", "Standardwert", "Beschreibung" + + "redis_scheme", "tcp", "Bestimmt das Protokoll, dass genutzt wird, um mit Redis zu kommunizieren. Gültige Werte sind: tcp, unix, http" + "redis_host", "localhost", "IP oder Hostname des Zielservers (ignoriert bei Unix Schema)" + "redis_port", "6379", "TCP/IP Port des Zielservers (ignoriert bei Unix Schema)" + "redis_path", "null", "Pfad zur Unix Domain Socket Datei, wenn Redis Unix Domain Sockets nutzt" -- cgit v1.2.3 From f68e351018287ab1998e803b7b1515235b734efc Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Wed, 12 Oct 2016 20:41:15 +0200 Subject: update German user/upgrade-2.0.x-2.1.1 --- docs/de/user/upgrade-2.0.x-2.1.1.rst | 48 +++++++++++++++++++++++++----------- 1 file changed, 34 insertions(+), 14 deletions(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.1.rst b/docs/de/user/upgrade-2.0.x-2.1.1.rst index eee50fe4..e603f596 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.1.rst @@ -1,5 +1,5 @@ -Wallabag updaten -================ +Wallabag von 2.0.x auf 2.1.1 updaten +==================================== .. warning:: Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen. @@ -30,23 +30,43 @@ Lade das neueste Release von wallabag herunter: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``) +(2.1.1 md5 Hashsumme: ``9584a3b60a2b2a4de87f536548caac93``) Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration): -.. code-block:: bash - - # RabbitMQ processing - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis processing - redis_host: localhost - redis_port: 6379 +.. code-block:: yml + + parameters: + database_driver: pdo_sqlite + database_host: 127.0.0.1 + database_port: null + database_name: symfony + database_user: root + database_password: null + database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' + database_table_prefix: wallabag_ + mailer_transport: smtp + mailer_host: 127.0.0.1 + mailer_user: null + mailer_password: null + locale: en + secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv + twofactor_auth: true + twofactor_sender: no-reply@wallabag.org + fosuser_registration: true + fosuser_confirmation: true + from_email: no-reply@wallabag.org + rss_limit: 50 + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + redis_host: localhost + redis_port: 6379 + +Du kannst `hier eine Dokumentation über die Parameter finden`_. Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. -- cgit v1.2.3 From 17064d3c54a26b7ba9ecf2b7fb854a3cf4178915 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Wed, 12 Oct 2016 20:44:22 +0200 Subject: update German user/upgrade-2.1.x-2.1.y.rst --- docs/de/user/upgrade-2.0.x-2.0.y.rst | 35 ----------------------------------- docs/de/user/upgrade-2.1.x-2.1.y.rst | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 35 deletions(-) delete mode 100644 docs/de/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/de/user/upgrade-2.1.x-2.1.y.rst (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.0.y.rst b/docs/de/user/upgrade-2.0.x-2.0.y.rst deleted file mode 100644 index 5820a0d2..00000000 --- a/docs/de/user/upgrade-2.0.x-2.0.y.rst +++ /dev/null @@ -1,35 +0,0 @@ -Wallabag updaten 2.0.x -> 2.1.x -=============================== - -Update auf einem dedizierten Webserver --------------------------------------- - -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer): - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod - -Update auf einem Shared Webhosting ----------------------------------- - -Sichere deine ``app/config/parameters.yml`` Datei. - -Lade das neueste Release von wallabag herunter: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``) - -Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. - -Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. - -Leere den ``var/cache`` Ordner. diff --git a/docs/de/user/upgrade-2.1.x-2.1.y.rst b/docs/de/user/upgrade-2.1.x-2.1.y.rst new file mode 100644 index 00000000..e638ea9b --- /dev/null +++ b/docs/de/user/upgrade-2.1.x-2.1.y.rst @@ -0,0 +1,35 @@ +Wallabag von 2.1.x auf 2.1.y updaten +==================================== + +Update auf einem dedizierten Webserver +-------------------------------------- + +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.2`` mit der neuesten Releasenummer): + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.2 --force + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Update auf einem Shared Webhosting +---------------------------------- + +Sichere deine ``app/config/parameters.yml`` Datei. + +Lade das neueste Release von wallabag herunter: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 Hashsumme von 2.1.1: ``9584a3b60a2b2a4de87f536548caac93``) + +Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. + +Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. + +Leere den ``var/cache`` Ordner. -- cgit v1.2.3 From a25377cb4c6308710f82f147e27c72e64cead752 Mon Sep 17 00:00:00 2001 From: zertrin Date: Wed, 12 Oct 2016 23:52:19 +0200 Subject: Minor fixes in the english documentation --- docs/en/developer/redis.rst | 2 +- docs/en/user/installation.rst | 10 +++++----- docs/en/user/upgrade-2.0.x-2.1.1.rst | 3 ++- 3 files changed, 8 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst index 67b6452e..2e2bbbea 100644 --- a/docs/en/developer/redis.rst +++ b/docs/en/developer/redis.rst @@ -35,7 +35,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s redis_host: localhost redis_port: 6379 -Enable Redos in wallabag +Enable Redis in wallabag ------------------------ In internal settings, in the **Import** section, enable Redis (with the value 1). diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 248c1995..45e14616 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -8,7 +8,7 @@ wallabag is compatible with PHP >= 5.5, including PHP 7. .. note:: - To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool. wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). @@ -95,7 +95,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t Installation with Docker ~~~~~~~~~~~~~~~~~~~~~~~~ -We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub `__ to have more information. +We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub `__ for more information. Command to launch container ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -194,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a .. tip:: - When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. + When you want to import large files into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. Configuration on lighttpd ~~~~~~~~~~~~~~~~~~~~~~~~~ -Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): +Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): :: @@ -249,7 +249,7 @@ As soon as we use Apache or Nginx to access to our wallabag instance, and not fr To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). -So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. +So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command: diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index 2f08b7bd..f5a48592 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst @@ -2,7 +2,8 @@ Upgrade from 2.0.x to 2.1.1 =========================== .. warning:: -Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. + + Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. Upgrade on a dedicated web server --------------------------------- -- cgit v1.2.3 From 83634bab228e2200e51a3c732645517a03bfb32d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 13 Oct 2016 16:56:03 +0200 Subject: Added missing space --- docs/de/user/upgrade-2.0.x-2.1.1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.0.x-2.1.1.rst b/docs/de/user/upgrade-2.0.x-2.1.1.rst index e603f596..db81a1be 100644 --- a/docs/de/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/de/user/upgrade-2.0.x-2.1.1.rst @@ -66,7 +66,7 @@ Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du redis_host: localhost redis_port: 6379 -Du kannst `hier eine Dokumentation über die Parameter finden`_. +Du kannst `hier eine Dokumentation über die Parameter finden `_. Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren. -- cgit v1.2.3 From eb7d1b4b308cfaeed7c598b2cba8670fb8ad39f0 Mon Sep 17 00:00:00 2001 From: Kaligule Date: Fri, 14 Oct 2016 09:09:28 +0200 Subject: Mention example instance Namely http://v2.wallabag.org/api/doc, so api methods can be looked up without installing wallabag first. --- docs/en/developer/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index 83f0bb8f..4828cddd 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst @@ -8,7 +8,7 @@ Requirements * wallabag freshly (or not) installed on http://localhost:8000 * ``httpie`` installed on your computer (`see project website `__). Note that you can also adapt the commands using curl or wget. -* all the API methods are documented here http://localhost:8000/api/doc +* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance `_ Creating a new API client ------------------------- -- cgit v1.2.3 From 8edb250caadbe00bcf3297f5318859e3862d428d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 14 Oct 2016 14:45:32 +0200 Subject: Added information about tagging rules in documentation Fix #2060 --- docs/de/user/configuration.rst | 2 +- docs/en/user/configuration.rst | 2 +- docs/fr/user/configuration.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst index 67695ff1..4fd6baea 100644 --- a/docs/de/user/configuration.rst +++ b/docs/de/user/configuration.rst @@ -102,7 +102,7 @@ Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen: +Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (be careful, for some values, you need to add quotes, for example ``language = "en"``): =========== ============================================== ======== ========== Variable Bedeutung Operator Bedeutung diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index f4c55dea..f74924df 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst @@ -100,7 +100,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r Which variables and operators can I use to write rules? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The following variables and operators can be used to create tagging rules: +The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``): =========== ============================================== ======== ========== Variable Meaning Operator Meaning diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst index 278f0022..8bfe66f5 100644 --- a/docs/fr/user/configuration.rst +++ b/docs/fr/user/configuration.rst @@ -102,7 +102,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r Quels variables et opérateurs puis-je utiliser pour écrire mes règles ? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles : +Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles (attention, pour certaines valeurs, vous devez ajouter des guillemets, par exemple ``language = "en"``) : =========== ============================================== ========== ========== Variable Sens Opérateur Sens -- cgit v1.2.3 From 68b8e75f9422fd63cde1c60a8ad13afbfc547f2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 14 Oct 2016 14:55:45 +0200 Subject: Fixed french and german doc homepages --- docs/de/index.rst | 4 ++-- docs/fr/index.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/de/index.rst b/docs/de/index.rst index 9ad62013..a380d7bd 100644 --- a/docs/de/index.rst +++ b/docs/de/index.rst @@ -30,8 +30,8 @@ Die Dokumentation ist in anderen Sprachen verfügbar : user/faq user/installation - user/upgrade-2.0.x-2.1.y - user/upgrade-2.0.x-2.0.y + user/upgrade-2.0.x-2.1.1 + user/upgrade-2.0.x-2.1.1 user/migration user/import user/create_account diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 082173e5..2a265ff3 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -31,8 +31,8 @@ La documentation est disponible dans d'autres langues : user/faq user/installation - user/upgrade-2.0.x-2.1.y - user/upgrade-2.0.x-2.0.y + user/upgrade-2.0.x-2.1.1 + user/upgrade-2.0.x-2.1.1 user/migration user/import user/create_account -- cgit v1.2.3 From 2752053f99420662fb1bf9e4f4ba1be1575ca764 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Fri, 14 Oct 2016 23:47:37 +0200 Subject: docs/de/user/configuration.rst: German fix for tagging rules docu --- docs/de/user/configuration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst index 4fd6baea..71627a52 100644 --- a/docs/de/user/configuration.rst +++ b/docs/de/user/configuration.rst @@ -102,7 +102,7 @@ Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (be careful, for some values, you need to add quotes, for example ``language = "en"``): +Die folgenden Variablen und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (sei vorsichtig, denn bei einigen Werten muss du Anführungszeichen hinzufügen, z.B. ``language = "de"``): =========== ============================================== ======== ========== Variable Bedeutung Operator Bedeutung -- cgit v1.2.3 From f878902e6a0ec7a92d6c765b5104efa907ead902 Mon Sep 17 00:00:00 2001 From: Sven Fischer Date: Fri, 14 Oct 2016 23:48:50 +0200 Subject: docs/de/user/configuration.rst: German fix for tagging rules docu --- docs/de/user/configuration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst index 71627a52..0b0793b1 100644 --- a/docs/de/user/configuration.rst +++ b/docs/de/user/configuration.rst @@ -102,7 +102,7 @@ Wenn *readingTime >= 5 AND domainName = "github.com"*, dann tagge als *lange zu Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Die folgenden Variablen und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (sei vorsichtig, denn bei einigen Werten muss du Anführungszeichen hinzufügen, z.B. ``language = "de"``): +Die folgenden Variablen und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (sei vorsichtig, denn bei einigen Werten musst du Anführungszeichen hinzufügen, z.B. ``language = "de"``): =========== ============================================== ======== ========== Variable Bedeutung Operator Bedeutung -- cgit v1.2.3 From 39c3dd30d2138c1a942911762376f4bddbec4cdb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 17 Oct 2016 11:35:42 +0200 Subject: Removed MD5 hash in documentation --- docs/de/user/upgrade-2.1.x-2.1.y.rst | 2 +- docs/en/user/upgrade-2.1.x-2.1.y.rst | 2 +- docs/fr/user/upgrade-2.1.x-2.1.y.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/de/user/upgrade-2.1.x-2.1.y.rst b/docs/de/user/upgrade-2.1.x-2.1.y.rst index e638ea9b..2f9b7791 100644 --- a/docs/de/user/upgrade-2.1.x-2.1.y.rst +++ b/docs/de/user/upgrade-2.1.x-2.1.y.rst @@ -26,7 +26,7 @@ Lade das neueste Release von wallabag herunter: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 Hashsumme von 2.1.1: ``9584a3b60a2b2a4de87f536548caac93``) +Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website `_. Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei. diff --git a/docs/en/user/upgrade-2.1.x-2.1.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst index 575f4ba9..62cb7dc0 100644 --- a/docs/en/user/upgrade-2.1.x-2.1.y.rst +++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst @@ -26,7 +26,7 @@ Download the last release of wallabag: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) +You will find the `md5 hash of the latest package on our website `_. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. diff --git a/docs/fr/user/upgrade-2.1.x-2.1.y.rst b/docs/fr/user/upgrade-2.1.x-2.1.y.rst index c048099f..b6f1a2d0 100644 --- a/docs/fr/user/upgrade-2.1.x-2.1.y.rst +++ b/docs/fr/user/upgrade-2.1.x-2.1.y.rst @@ -26,7 +26,7 @@ Téléchargez la dernière version de wallabag : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) +Vous trouverez `le hash md5 du dernier package sur notre site `_. Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. -- cgit v1.2.3