From 322c270b6590d0d0bf5025f4782ffe7cdea0f8b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 16 May 2017 13:09:40 +0200 Subject: Removed embedded documentation --- docs/fr/conf.py | 55 -- docs/fr/developer/api.rst | 271 --------- docs/fr/developer/asynchronous.rst | 160 ------ docs/fr/developer/console_commands.rst | 30 - docs/fr/developer/docker.rst | 50 -- docs/fr/developer/documentation.rst | 12 - docs/fr/developer/front-end.rst | 33 -- docs/fr/developer/paywall.rst | 65 --- docs/fr/developer/testsuite.rst | 10 - docs/fr/developer/translate.rst | 62 -- docs/fr/index.rst | 54 -- docs/fr/requirements.txt | 2 - docs/fr/user/android.rst | 96 ---- docs/fr/user/articles.rst | 124 ---- docs/fr/user/backup.rst | 26 - docs/fr/user/configuration.rst | 134 ----- docs/fr/user/configuring_mobile.rst | 12 - docs/fr/user/create_account.rst | 42 -- docs/fr/user/errors_during_fetching.rst | 37 -- docs/fr/user/faq.rst | 42 -- docs/fr/user/filters.rst | 55 -- docs/fr/user/import.rst | 155 ----- docs/fr/user/installation.rst | 316 ---------- docs/fr/user/parameters.rst | 95 --- docs/fr/user/query-upgrade-21-22.rst | 984 -------------------------------- docs/fr/user/tags.rst | 2 - docs/fr/user/upgrade.rst | 140 ----- 27 files changed, 3064 deletions(-) delete mode 100644 docs/fr/conf.py delete mode 100644 docs/fr/developer/api.rst delete mode 100644 docs/fr/developer/asynchronous.rst delete mode 100644 docs/fr/developer/console_commands.rst delete mode 100644 docs/fr/developer/docker.rst delete mode 100644 docs/fr/developer/documentation.rst delete mode 100644 docs/fr/developer/front-end.rst delete mode 100644 docs/fr/developer/paywall.rst delete mode 100644 docs/fr/developer/testsuite.rst delete mode 100644 docs/fr/developer/translate.rst delete mode 100644 docs/fr/index.rst delete mode 100644 docs/fr/requirements.txt delete mode 100644 docs/fr/user/android.rst delete mode 100644 docs/fr/user/articles.rst delete mode 100644 docs/fr/user/backup.rst delete mode 100644 docs/fr/user/configuration.rst delete mode 100644 docs/fr/user/configuring_mobile.rst delete mode 100644 docs/fr/user/create_account.rst delete mode 100644 docs/fr/user/errors_during_fetching.rst delete mode 100644 docs/fr/user/faq.rst delete mode 100644 docs/fr/user/filters.rst delete mode 100644 docs/fr/user/import.rst delete mode 100644 docs/fr/user/installation.rst delete mode 100644 docs/fr/user/parameters.rst delete mode 100644 docs/fr/user/query-upgrade-21-22.rst delete mode 100644 docs/fr/user/tags.rst delete mode 100644 docs/fr/user/upgrade.rst (limited to 'docs/fr') diff --git a/docs/fr/conf.py b/docs/fr/conf.py deleted file mode 100644 index 90489d83..00000000 --- a/docs/fr/conf.py +++ /dev/null @@ -1,55 +0,0 @@ -# -*- coding: utf-8 -*- -# -# wallabag documentation build configuration file, created by -# sphinx-quickstart on Fri Oct 16 06:47:23 2015. - -import sys -import os - -extensions = [] -templates_path = ['_templates'] -source_suffix = '.rst' -master_doc = 'index' -project = u'wallabag-fr' -copyright = u'2013-2017, Nicolas Lœuillet - MIT Licence' -version = '2.3.0' -release = version -exclude_patterns = ['_build'] -pygments_style = 'sphinx' -html_theme = 'default' -html_static_path = ['_static'] -htmlhelp_basename = 'wallabagfrdoc' - -latex_elements = { -} - -latex_documents = [ - ('index', 'wallabag-fr.tex', u'wallabag Documentation', - u'Nicolas Lœuillet', 'manual'), -] - -man_pages = [ - ('index', 'wallabagfr', u'wallabag Documentation', - [u'Nicolas Lœuillet'], 1) -] - -texinfo_documents = [ - ('index', 'wallabag', u'wallabag Documentation', - u'Nicolas Lœuillet', 'wallabag', 'wallabag is an opensource read-it-later.', - 'Miscellaneous'), -] - -##### Guzzle sphinx theme - -import guzzle_sphinx_theme -html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator' -html_theme_path = guzzle_sphinx_theme.html_theme_path() -html_theme = 'guzzle_sphinx_theme' - -# Custom sidebar templates, maps document names to template names. -html_sidebars = { - '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html'] -} - -# Register the theme as an extension to generate a sitemap.xml -extensions.append("guzzle_sphinx_theme") diff --git a/docs/fr/developer/api.rst b/docs/fr/developer/api.rst deleted file mode 100644 index e7bb264f..00000000 --- a/docs/fr/developer/api.rst +++ /dev/null @@ -1,271 +0,0 @@ -Documentation de l'API -====================== - -Grâce à cette documentation, nous allons voir comment interagir avec l'API de wallabag. - -Pré-requis ----------- - -* wallabag fraichement installé et disponible à http://localhost:8000 -* ``httpie`` installé sur votre ordinateur (`voir le site du projet `__). Vous pouvez également adapter les commandes en utilisant curl ou wget. -* toutes les méthodes de l'API documentées ici http://localhost:8000/api/doc - -Créer un nouveau client d'API ------------------------------ - -Depuis votre wallabag, vous pouvez créer un nouveau client d'API à cette URL http://localhost:8000/developer/client/create. - -Vous devez renseigner l'URL de redirection de votre application et créer votre client. Si votre application est une application desktop, renseignez l'URL que vous souhaitez. - -Vous obtiendrez les informations suivantes : - -:: - - Client ID: - - 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc - - Client secret: - - 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 - - -Créer un jeton --------------- - -Pour chaque appel d'API, vous aurez besoin d'un jeton. Créons-le avec la commande suivante (remplacez ``client_id``, ``client_secret``, ``username`` and ``password`` par leur valeur): - -:: - - http POST http://localhost:8000/oauth/v2/token \ - grant_type=password \ - client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ - client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ - username=wallabag \ - password=wallabag - -Vous obtiendrez : - -:: - - 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" - } - -Nous allons utiliser la valeur de ``access_token`` dans nos prochains appels. - -Exemple cURL : - -:: - - curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag" - -Récupérer les articles existants --------------------------------- - -Documentation pour cette méthode : http://localhost:8000/api/doc#get--api-entries.{_format} - -Comme nous venons tout juste d'installer wallabag, nous n'aurons aucun résultat avec cette commande : - -:: - - http GET http://localhost:8000/api/entries.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -retournera : - -:: - - 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 - } - -Le tableau ``items`` est vide. - -Exemple cURL : - -:: - - curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -Créer votre premier article ---------------------------- - -Documentation pour cette méthode : 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" - -retournera : - -:: - - 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" - } - -Maintenant, si vous exécutez la précédente commande (voir **Récupérer les articles existants**), vous obtiendrez quelque chose. - -Exemple cURL : - -:: - - 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" - -Supprimer un article --------------------- - -Documentation pour cette méthode : http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} - -:: - - http DELETE http://localhost:8000/api/entries/1.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -retournera : - -:: - - 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" - } - -Et si vous voulez voir la liste des articles existants (voir **Récupérer les articles existants**), le tableau sera vide. - -Exemple cURL : - -:: - - curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -Autres méthodes ---------------- - -Nous n'écrirons pas d'exemples pour toutes les méthodes de l'API. - -Jetez un œil à la liste complète ici http://localhost:8000/api/doc pour connaitre chaque méthode. - -Ressources tierces ------------------- - -Certaines applications ou bibliothèques utilisent notre API. En voici une liste non exhaustive : - -- `Java wrapper for the wallabag API `_ par Dmitriy Bogdanov. -- `.NET library for the wallabag v2 API `_ par Julian Oster. -- `Python API for wallabag `_ par FoxMaSk, pour son projet `Trigger Happy `_. -- `Un plugin `_ conçu pour `Tiny Tiny RSS `_ qui utilise l'API wallabag v2. Par Josh Panter. -- `Golang wrapper for the wallabag API `_ par Strubbl, pour son projets `wallabag-stats graphe `_ et l'outil de ligne de commande `wallabag-add-article `_. -- Tool to automatically download Wallabag articles into your local computer or Kobo ebook reader `wallabako `_ par anarcat. diff --git a/docs/fr/developer/asynchronous.rst b/docs/fr/developer/asynchronous.rst deleted file mode 100644 index ff22daea..00000000 --- a/docs/fr/developer/asynchronous.rst +++ /dev/null @@ -1,160 +0,0 @@ -Tâches asynchrones -================== - -Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ ou Redis. - -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 ``app/config/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 - rabbitmq_prefetch_count: 10 # lire http://www.rabbitmq.com/consumer-prefetch.html - -Activer RabbitMQ dans wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1). - -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 -e=prod import_pocket -w - - # for Readability import - bin/console rabbitmq:consumer -e=prod import_readability -w - - # for Instapaper import - bin/console rabbitmq:consumer -e=prod import_instapaper -w - - # for wallabag v1 import - bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w - - # for wallabag v2 import - bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w - - # for Firefox import - bin/console rabbitmq:consumer -e=prod import_firefox -w - - # for Chrome import - bin/console rabbitmq:consumer -e=prod import_chrome -w - -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 ``app/config/parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir : - -.. code:: yaml - - 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 -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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 -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log - - # for Readability import - 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 -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log - - # for wallabag v1 import - 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 -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log - - # for Firefox import - 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 -e=prod chrome -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 -e=prod pocket -vv --maxIterations=12 diff --git a/docs/fr/developer/console_commands.rst b/docs/fr/developer/console_commands.rst deleted file mode 100644 index 1b222b32..00000000 --- a/docs/fr/developer/console_commands.rst +++ /dev/null @@ -1,30 +0,0 @@ -Actions en ligne de commande -============================ - -wallabag a un certain nombre de commandes CLI pour effectuer des tâches. Vous pouvez lister toutes les commandes en exécutant `bin/console` dans le dossier d'installation de wallabag. - -Chaque commande a une aide correspondante accessible via `bin/console help %command%`. - -.. note:: - - Si vous êtes dans un environnement de production, souvenez-vous d'ajouter `-e prod` à chaque commande. - -Commandes notables ------------------- - -* `assets:install`: Peut-être utile si les *assets* sont manquants. -* `cache:clear`: doit être exécuté après chaque mise à jour (appelé dans `make update`). -* `doctrine:migrations:status`: Montre le statut de vos migrations de vos bases de données. -* `fos:user:activate`: Activer manuellement un utilisateur. -* `fos:user:change-password`: Changer le mot de passe pour un utilisateur. -* `fos:user:create`: Créer un utilisateur. -* `fos:user:deactivate`: Désactiver un utilisateur (non supprimé). -* `fos:user:demote`: Supprimer un rôle d'un utilisateur, typiquement les droits d'administration. -* `fos:user:promote`: Ajoute un rôle à un utilisateur, typiquement les droits d'administration. -* `rabbitmq:*`: Peut-être utile si vous utilisez RabbitMQ. -* `wallabag:clean-duplicates`: Supprime tous les articles dupliqués pour un utilisateur ou bien tous. -* `wallabag:export`: Exporte tous les articles pour un utilisateur. Vous pouvez choisir le chemin du fichier exporté. -* `wallabag:import`: Importe les articles en différents formats dans un compte utilisateur. -* `wallabag:import:redis-worker`: Utile si vous utilisez Redis. -* `wallabag:install`: (ré)Installer wallabag -* `wallabag:tag:all`: Tagger tous les articles pour un utilisateur ou une utilisatrice en utilisant ses règles de tags automatiques. diff --git a/docs/fr/developer/docker.rst b/docs/fr/developer/docker.rst deleted file mode 100644 index 84724ed3..00000000 --- a/docs/fr/developer/docker.rst +++ /dev/null @@ -1,50 +0,0 @@ -Exécuter wallabag avec docker-compose -===================================== - -Pour faire tourner votre propre instance de développement de wallabag, vous pouvez -utiliser les fichiers docker pré-configurés. - -Pré-requis ----------- - -Soyez sur d'avoir `Docker -`__ et `Docker -Compose `__ installés et à jour sur votre -système. - -Changer de SGBD ---------------- - -Par défaut, wallabag fonctionne avec une base de données SQLite. -Depuis que wallabag supporte Postgresql et MySQL, les conteneurs Docker sont -aussi disponibles pour ces SGBD. - -Dans ``docker-compose.yml``, en fonction de votre SGBD, décommentez : - -- la définition du conteneur (le block racine ``postgres`` ou ``mariadb``) -- le conteneur ``links`` dans le conteneur ``php`` -- le conteneur ``env_file`` dans le conteneur ``php`` - -Pour que les commandes Symfony (par exemple ``wallabag:install``) continuent de -fonctionner sur votre système, vous devez aussi : - -- charger le bon fichier d'environnement dans votre ligne de commandes (``source``), -pour que les variables comme ``SYMFONY__ENV__DATABASE_HOST`` existent. -- ajouter une ligne ``127.0.0.1 rdbms`` dans votre fichier ``hosts`` - -Exécuter wallabag ------------------ - -#. Forker et cloner le projet -#. Editer ``app/config/parameters.yml`` pour remplacer les propriétés ``database_*`` - par les lignes commentées (celles avec des valeurs préfixées par ``env.``) -#. ``composer install`` pour installer les dépendances -#. ``php bin/console wallabag:install`` pour créer le schéma de la BDD -#. ``docker-compose up`` pour démarrer les conteneurs -#. Enfin, se rendre sur http://localhost:8080/ pour accéder à une installation - tout propre de wallabag. - -Il est possible de rencontrer des problèmes de droits UNIX, de mauvais chemins -dans les fichiers de cache, etc… -Les opérations comme vider le cache ou restaurer les permissions des fichiers -peuvent être fréquemment nécessaires, n'ayez crainte ! diff --git a/docs/fr/developer/documentation.rst b/docs/fr/developer/documentation.rst deleted file mode 100644 index 0fbe5626..00000000 --- a/docs/fr/developer/documentation.rst +++ /dev/null @@ -1,12 +0,0 @@ -Contribuer à cette documentation -================================ - -Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs - -Nous utilisons `ReadTheDocs -`__ pour la générer. - -Les pages sont écrites au format `Restructured Text -`__. Vous pouvez utiliser des outils en ligne comme http://rst.aaroniles.net/ ou http://rst.ninjs.org/ pour prévisualiser vos articles. - -Si vous créez une nouvelle page, n'oubliez pas d'éditer le fichier `index.rst `__ pour ajouter un lien dans la barre latérale. \ No newline at end of file diff --git a/docs/fr/developer/front-end.rst b/docs/fr/developer/front-end.rst deleted file mode 100644 index 714df08b..00000000 --- a/docs/fr/developer/front-end.rst +++ /dev/null @@ -1,33 +0,0 @@ -Conseils pour développeurs front-end -==================================== - -Depuis la version 2.3, wallabag utilise webpack pour générer ses assets. - -Mode développeur ----------------- - -Si le serveur fonctionne en mode dev, vous devez lancer la commande ``yarn run build:dev`` pour générer les fichiers de sortie javascript pour chaque thème. Ils sont nommés ``%theme%.dev.js`` et sont ignorés par git. Vous devez relancer la commande ``yarn run build:dev`` pour chaque changement que vous effectuez dans les fichiers assets (js, css, images, polices,...). - -Live reload ------------ - -Webpack apporte le support pour la fonctionnalité de live reload, ce qui signifie que vous n'avez pas besoin de regénérer manuellement le fichier de sortie javascript ni de rafraichir la page dans votre navigateur. Les changements sont appliqués automatiquement. Vous avez juste besoin de mettre le paramètre ``use_webpack_dev_server`` à ``true`` dans ``app/config/config.yml`` et de lancer ``yarn run watch`` pour que cela soit actif. - -.. note:: - - N'oubliez pas de remettre ``use_webpack_dev_server`` à ``false`` lorsque vous n'utilisez pas la fonctionnalité de live reload. - -Production builds ------------------ - -Lorsque vous committez vos changements, vous devez les compiler dans un environnement de production en exécutant ``yarn run build:prod``. Cela compilera tous les assets nécessaires pour wallabag. Pour tester que cela fonctionne proprement, vous devrez avoir un serveur en mode de production, par exemple avec ``bin/console server:run -e=prod``. - -.. note:: - - N'oubliez pas de générer des fichiers en mode production avant de committer ! - - -Code style ----------- - -Le style de code est vérifié par deux outils : stylelint pour le (S)CSS et eslint pour le JS. La configuration ESlint config est basée sur le preset Airbnb base. diff --git a/docs/fr/developer/paywall.rst b/docs/fr/developer/paywall.rst deleted file mode 100644 index ddba839a..00000000 --- a/docs/fr/developer/paywall.rst +++ /dev/null @@ -1,65 +0,0 @@ -Articles derrière un paywall -============================ - -wallabag peut récupérer le contenu des articles des sites qui utilisent un système de paiement. - -Activer l'authentification pour les paywall -------------------------------------------- - -Dans les paramètres internes, en tant qu'administrateur de wallabag, section **Article**, activez l'authentification pour les articles derrière un paywall (avec la valeur 1). - -Configurer les accès dans wallabag ----------------------------------- - -Éditez le fichier ``app/config/parameters.yml`` pour modifier les accès aux sites avec paywall. Par exemple, sous Ubuntu : - -``sudo -u www-data nano /var/www/html/wallabag/app/config/parameters.yml`` - -Voici un exemple pour certains sites (attention, ne pas utiliser la touche "tab", seulement des espaces) : - -.. code:: yaml - - sites_credentials: - mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} - arretsurimages.net: {username: "myASILogin", password: "mypassword"} - -.. note:: - - Ces accès seront partagés entre chaque utilisateur de votre instance wallabag. - -Fichiers de configuration pour parser les articles --------------------------------------------------- - -.. note:: - - Lisez `cette documentation `_ pour en savoir plus sur ces fichiers de configuration, qui se trouvent dans le répertoire ``vendor/j0k3r/graby-site-config/``. Pour la majorité des sites, ce fichier est déjà configuré : les instructions qui suivent concernent seulement les sites non encore configurés. - -Chaque fichier de configuration doit être enrichi en ajoutant ``requires_login``, ``login_uri``, -``login_username_field``, ``login_password_field`` et ``not_logged_in_xpath``. - -Attention, le formulaire de connexion doit se trouver dans le contenu de la page lors du chargement de celle-ci. -Il sera impossible pour wallabag de se connecter à un site dont le formulaire de connexion est chargé après coup (en ajax par exemple). - -``login_uri`` correspond à l'URL à laquelle le formulaire est soumis (attribut ``action`` du formulaire). -``login_username_field`` correspond à l'attribut ``name`` du champ de l'identifiant. -``login_password_field`` correspond à l'attribut ``name`` du champ du mot de passe. - -Par exemple : - -.. code:: - - title://div[@id="titrage-contenu"]/h1[@class="title"] - body: //div[@class="contenu-html"]/div[@class="page-pane"] - - requires_login: yes - - login_uri: http://www.arretsurimages.net/forum/login.php - login_username_field: username - login_password_field: password - - not_logged_in_xpath: //body[@class="not-logged-in"] - -Dernière étape : nettoyer le cache ----------------------------------- - -Il est nécessaire de nettoyer le cache de wallabag avec la commande suivante (ici sous Ubuntu) : ``sudo -u www-data php /var/www/html/wallabag/bin/console cache:clear -e=prod`` diff --git a/docs/fr/developer/testsuite.rst b/docs/fr/developer/testsuite.rst deleted file mode 100644 index bd5c68c6..00000000 --- a/docs/fr/developer/testsuite.rst +++ /dev/null @@ -1,10 +0,0 @@ -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/developer/translate.rst b/docs/fr/developer/translate.rst deleted file mode 100644 index 870d1c20..00000000 --- a/docs/fr/developer/translate.rst +++ /dev/null @@ -1,62 +0,0 @@ -Traduire wallabag -================= - -L'application web ------------------ - -Fichiers de traductions -~~~~~~~~~~~~~~~~~~~~~~~ - -.. note:: - - Comme wallabag est principalement dévelopée par une équipe française, c'est - cette traduction qui est considérée comme la plus récente. Merci de vous baser - sur celle-ci pour créer votre traduction. - -Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations. - -Vous devez créer les fichiers ``messages.CODE.yml`` et ``validators.CODE.yml``, -où CODE est le code ISO 639-1 de votre langue (`cf wikipedia `__). - -Autres fichiers à traduire : - -- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. -- https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations. - -Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``. - -Fichier de configuration -~~~~~~~~~~~~~~~~~~~~~~~~ - -Vous devez éditer `app/config/config.yml -`__ pour -afficher votre langue dans la page Configuration de wallabag (pour permettre aux -utilisateurs de choisir cette nouvelle traduction). - -Dans la section ``wallabag_core.languages``, vous devez ajouter une nouvelle ligne -avec votre traduction. Par exemple : - -:: - - wallabag_core: - ... - languages: - en: 'English' - fr: 'Français' - - -Pour la première colonne (``en``, ``fr``, etc.), vous devez ajouter le code ISO 639-1 -de votre langue (voir ci-dessus). - -Pour la seconde colonne, c'est juste le nom de votre langue. - -Documentation de wallabag -------------------------- - -.. note:: - - Contrairement à l'application, la langue principale de la documentation est l'anglais - -Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/master/docs - -Vous devez respecter la structure du dossier ``en`` quand vous crééz votre traduction. diff --git a/docs/fr/index.rst b/docs/fr/index.rst deleted file mode 100644 index 99aaa35a..00000000 --- a/docs/fr/index.rst +++ /dev/null @@ -1,54 +0,0 @@ -Documentation de wallabag -========================= - -.. image:: ../img/wallabag.png - :alt: wallabag logo - :align: center - -**wallabag** est une application de lecture différée : elle permet -simplement d’archiver une page web en ne conservant que le contenu. Les -éléments superflus (menu, publicité, etc.) sont supprimés. - -La documentation principale de cette application est découpée en plusieurs sections : - -* :ref:`user-docs` -* :ref:`dev-docs` - -La documentation est disponible dans d'autres langues : - -* `Documentation in english `_ -* `Deutsch Dokumentation `_ - -.. _user-docs: - -.. toctree:: - :maxdepth: 2 - :caption: Documentation utilisateur - - user/installation - user/upgrade - user/configuration - user/import - user/create_account - user/articles - user/errors_during_fetching - user/filters - user/tags - user/configuring_mobile - user/android - user/parameters - user/backup - user/faq - -.. _dev-docs: - -.. toctree:: - :maxdepth: 2 - :caption: Documentation développeur - - developer/api - developer/docker - developer/paywall - developer/documentation - developer/translate - developer/asynchronous diff --git a/docs/fr/requirements.txt b/docs/fr/requirements.txt deleted file mode 100644 index 06fc8973..00000000 --- a/docs/fr/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -Sphinx>=1.3.0,<1.4.0 -guzzle_sphinx_theme>=0.7.0,<0.8.0 diff --git a/docs/fr/user/android.rst b/docs/fr/user/android.rst deleted file mode 100644 index 91501eea..00000000 --- a/docs/fr/user/android.rst +++ /dev/null @@ -1,96 +0,0 @@ -Application Android -=================== - -But de ce document ------------------- - -Ce document explique comment configurer votre application Android pour qu'elle fonctionne avec votre instance de wallabag. Il n'y a pas de différence dans cette procédure entre wallabag v1 et wallabag v2. - -Étapes pour configurer votre application ----------------------------------------- - -Quand vous démarrez l'application pour la première fois, vous voyez le message de bienvenue, où il vous est d'abord conseillé de configurer l'application avec votre instance de wallabag. - -.. image:: ../../img/user/android_welcome_screen.en.png - :alt: Écran de bienvenue - :align: center - -Vous devez confirmer le message et vous serez redirigé vers l'écran de configuration. - -.. image:: ../../img/user/android_configuration_screen.en.png - :alt: Écran de configuration - :align: center - -Saisissez vos données wallabag. Vous devez entrer l'adresse de votre instance de wallabag. **Il ne faut pas que cette adresse se termine par un slash**. Ajoutez également vos identifiants wallabag dans les champs correspondants. - -.. image:: ../../img/user/android_configuration_filled_in.en.png - :alt: Paramètres remplis - :align: center - -Après cet écran, appuyez sur le bouton de test de connexion et attendez que le test se termine. - -.. image:: ../../img/user/android_configuration_connection_test.en.png - :alt: Test de connexion - :align: center - -Le test de connexion devrait se terminer avec succès. Si ce n'est pas le cas, vous devez résoudre ça avant de continuer. - -.. image:: ../../img/user/android_configuration_connection_test_success.en.png - :alt: Test de connexion réussi - :align: center - -Après le test de connexion réussi, vous pouvez cliquer sur le bouton pour récupérer vos informations de flux (feed credentials). L'application essaie maintenant de se connecter à wallabag pour récupérer votre identifiant et votre jeton pour les flux RSS. - -.. image:: ../../img/user/android_configuration_get_feed_credentials.en.png - :alt: Récupération des informations de flux - :align: center - -Quand le processus est terminé avec succès, vous verrez une notification comme quoi l'identifiant et le jeton ont été remplis correctement. - -.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png - :alt: Récupération des informations correcte - :align: center - -Maintenant, vous devez naviguer jusqu'en bas de l'écran des paramètres. Bien sur, vous pouvez régler les paramètres comme vous le souhaitez. Enregistrez la configuration. - -.. image:: ../../img/user/android_configuration_scroll_bottom.en.png - :alt: Bottom of the settings screen - :align: center - -Après avoir enregistré les paramètres, vous vous retrouvez face à l'écran suivant. L'application vous propose de démarrer une synchronisation pour récupérer vos articles. Il est recommandé de confirmer cette action. - -.. image:: ../../img/user/android_configuration_saved_feed_update.en.png - :alt: Settings saved the first time - :align: center - -Une fois la synchronisation terminée avec succès, vous pouvez lire vos articles. - -.. image:: ../../img/user/android_unread_feed_synced.en.png - :alt: Filled article list cause feeds successfully synchronized - :align: center - -Limitations connues -------------------- - -Double authentification (2FA) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Actuellement, l'application Android ne supporte la double authentification. Vous devez la désactiver pour que l'application fonctionne correctement. - -Limiter le nombre d'articles avec wallabag v2 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Dans votre instance de wallabag, vous pouvez configurer combien d'articles se trouvent dans les flux RSS. Cette option n'existe pas dans wallabag v1, où tous les articles se retrouvent donc dans le flux RSS. 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. - -Cryptage SSL/TLS -~~~~~~~~~~~~~~~~ - -Si vous souhaitez accéder à votre instance de wallabag via HTTPS, vous devez le définir dans les paramètres. Surtout si votre URL HTTP redirige vers l'URL HTTPS. Actuellement, l'application ne gère pas cette redirection correctement. - -Références ----------- - -- `Code source de l'application Android `_ -- `Télécharger l'application Android sur F-Droid `_ -- `Télécharger l'application Android sur Google Play `_ - diff --git a/docs/fr/user/articles.rst b/docs/fr/user/articles.rst deleted file mode 100644 index cefc3c10..00000000 --- a/docs/fr/user/articles.rst +++ /dev/null @@ -1,124 +0,0 @@ -Articles -======== - -Sauvegardez votre premier article ---------------------------------- - -La fonctionnalité principale de wallabag est de sauvegarder des articles. -Vous avez plusieurs manières de le faire. - -.. note:: - - Un guide de démarrage s'affichera dans l'application jusqu'à ce que vous - enregistriez votre premier article. - -En utilisant le bookmarklet -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Sur la page ``Aide``, vous avez un onglet ``Bookmarklet``. Glissez/déposez le lien ``bag it!`` -dans votre barre de favoris de votre navigateur. - -Maintenant, à chaque fois que vous lisez un article et que vous souhaitez le sauvegarder, -cliquez sur le lien ``bag it!`` dans votre barre de favoris. L'article est enregistré. - -En utilisant le formulaire classique -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icône, -un signe plus, vous pouvez facilement ajouter un nouvel article. - -.. image:: ../../img/user/topbar.png - :alt: Barre supérieure - :align: center - -Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez -sur la touche ``Entrée``. L'article est enregistré. - -En utilisant l'extension de votre navigateur -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Firefox -""""""" - -Vous pouvez télécharger `l'extension Firefox ici `_. - -Chrome -"""""" - -Vous pouvez télécharger `l'extension Chrome ici `_. - -En utilisant l'application de votre smartphone -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Android -""""""" - -Vous pouvez télécharger `l'application Android ici `_ ou sur `F-Droid `_. - -Windows Phone -~~~~~~~~~~~~~ - -Vous pouvez télécharger `l'application Windows Phone ici `_. - -Téléchargez vos articles ------------------------- - -Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PDF, XML, JSON, CSV. - -Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale : - -.. image:: ../../img/user/download_article.png - :alt: Télécharger l'article - :align: center - -Vous pouvez aussi télécharger une catégorie (non lus, favoris, lus) dans ces formats. -Par exemple, dans la vue **Non lus**, cliquez sur cette icône dans la barre supérieure : - -.. image:: ../../img/user/download_articles.png - :alt: Télécharger l'article - :align: center - -Partagez vos 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 -- dans votre Scuttle -- avec un message dans Diaspora* -- sur Carrot -- avec un email - -Annotez vos articles --------------------- - -Sur chaque article que vous lisez, vous pouvez écrire des annotations. Puisqu'une image vaut mieux qu'un long discours, -voici ce que ça donne. - -Sélectionnez la zone du texte que vous souhaitez annoter et cliquez sur le crayon : - -.. image:: ../../img/user/annotations_1.png - :alt: Sélectionnez votre texte - :align: center - -Ensuite, écrivez votre annotation : - -.. image:: ../../img/user/annotations_2.png - :alt: Écrivez votre annotation - :align: center - -Le texte est maintenant surligné et vous pouvez lire le annotation en le survolant avec votre souris. - -.. image:: ../../img/user/annotations_3.png - :alt: Lisez votre annotation - :align: center - -Vous pouvez créer autant de annotations que vous le souhaitez. diff --git a/docs/fr/user/backup.rst b/docs/fr/user/backup.rst deleted file mode 100644 index f8cf87ee..00000000 --- a/docs/fr/user/backup.rst +++ /dev/null @@ -1,26 +0,0 @@ -Sauvegarde de wallabag -====================== - -Parce que des fois vous faites des erreurs avec votre installation de wallabag et vous perdez des données ou parce que vous souhaitez migrer votre installation sur un autre serveur, vous souhaitez faire une sauvegarde de vos données. -Cette documentation décrit ce que vous devez sauvegarder. - -Configuration -------------- -wallabag stocke quelques paramètres (comme la configuration SMTP ou les infos de bases de données) dans le fichier `app/config/parameters.yml`. - -Base de données ---------------- -Comme wallabag supporte différentes sortes de bases de données, la manière de sauvegarder dépend du type de base de données que vous utilisez, donc vous devez vous en référez à la documentation correspondante. - -Quelques exemples : - -- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html -- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html - -SQLite -~~~~~~ -Pour sauvegarder une base SQLite, vous devez juste copier le répertoire `data/db` de votre installation wallabag. - -Images ------- -Les images sauvegardées par wallabag sont stockées dans `web/assets/images` (le stockage des images sera implémenté dans wallabag 2.2). diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst deleted file mode 100644 index 0f5d4375..00000000 --- a/docs/fr/user/configuration.rst +++ /dev/null @@ -1,134 +0,0 @@ -Configuration -============= - -Maintenant que vous êtes connecté, il est temps de configurer votre compte. - -Cliquez sur le menu ``Configuration``. Vous avez accès à 5 onglets : -``Paramètres``, ``RSS``, ``Mon compte``, ``Mot de passe`` and ``Règles de tag automatiques``. - -Paramètres ----------- - -Thème -~~~~~ - -L'affichage de wallabag est personnalisable. C'est ici que vous choisissez le thème -que vous préférez. Le thème par défaut est ``Material``, c'est celui -qui est utilisé dans les captures d'écran de la documentation. - -Nombre d'articles par page -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Vous pouvez définir le nombre d'articles affichés sur chaque page. - -Vitesse de lecture -~~~~~~~~~~~~~~~~~~ - -wallabag calcule une durée de lecture pour chaque article. Vous pouvez définir ici, grâce à cette liste déroulante, si vous lisez plus ou moins vite. wallabag recalculera la durée de lecture de chaque article. - -Où souhaitez-vous être redirigé après avoir marqué un article comme lu ? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Chaque fois que vous ferez certaines actions (après avoir marqué un article comme lu / comme favori, -après avoir supprimé un article, après avoir retiré un tag d'un article), vous pouvez être redirigé : - -- sur la page d'accueil -- sur la page courante - -Langue -~~~~~~ - -Vous pouvez définir la langue de l'interface de wallabag. - -RSS ---- - -wallabag propose un flux RSS pour chaque statut d'article : non lus, favoris et lus. - -Tout d'abord, vous devez vous créer un jeton personnel : cliquez sur ``Créez votre jeton``. -Il est possible de regénérer votre jeton en cliquant sur ``Réinitialisez votre jeton``. - -Vous avez maintenant trois liens, un par statut : ajoutez-les dans votre agrégateur de flux RSS préféré. - -Vous pouvez aussi définir combien d'articles vous souhaitez dans vos flux RSS -(50 est la valeur par défaut). - -Une pagination est aussi disponible pour ces flux. Il suffit de rajouter ``?page=2`` pour aller à la seconde page, par exemple. -Cette pagination suit `la RFC `_, ce qui signifie que vous trouverez la page suivante (``next``), précédente (``previous``) et la dernière (``last``) dans la balise `` de chaque flux RSS. - -Mon compte ----------- - -Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double authentification``. - -Si l'instance de wallabag compte plus d'un utilisateur actif, vous pouvez supprimer ici votre compte. **Attention, nous supprimons toutes vos données**. - -Double authentification (2FA) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - L'authentification à deux facteurs (également appelée 2FA) est une technologie brevetée en 1984 - qui fournit l'identification des utilisateurs au moyen de la combinaison de deux composants différents . - - https://fr.wikipedia.org/wiki/Authentification_forte - -**Attention**: l'activation de la 2FA depuis l'interface de configuration n'est possible que si elle a au préalable été autorisée dans `app/config/parameters.yml` en passant la propriété *twofactor_auth* à `true` (n'oubliez pas d'exécuter `php bin/console cache:clear -e=prod` après modification). - -Si vous activez 2FA, à chaque tentative de connexion à wallabag, vous recevrez -un code par email. Vous devez renseigner ce code dans le formulaire suivant : - -.. image:: ../../img/user/2FA_form.png - :alt: Authentification à deux facteurs - :align: center - -Si vous ne souhaitez pas recevoir un code à chaque fois que vous vous connectez, -vous pouvez cocher la case ``Je suis sur un ordinateur de confiance`` : wallabag -se souviendra de vous pour 15 jours. - -Mot de passe ------------- - -Vous pouvez changer de mot de passe ici (8 caractères minimum). - -Règles de tag automatiques --------------------------- - -Si vous voulez automatiquement assigner un tag à de nouveaux articles en fonction de -certains critères, cette partie de la configuration est pour vous. - -Que veut dire « règles de tag automatiques » ? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Ce sont des règles utilisées par wallabag pour automatiquement assigner un tag -à un nouvel article. -À chaque fois que vous ajoutez un nouvel article, toutes les règles sont utilisées pour ajouter -les tags que vous avez configurés, vous épargnant ainsi la peine de classer manuellement vos articles. - -Comment les utiliser ? -~~~~~~~~~~~~~~~~~~~~~~ - -Admettons que vous voulez ajouter comme tag *« lecture rapide »* quand le temps de lecture -d'un article est inférieur à 3 minutes. -Dans ce cas, vous devez ajouter « readingTime <= 3 » dans le champ **Règle** et *« lecture rapide »* dans le champ **Tags**. -Plusieurs tags peuvent être ajoutés en même temps en les séparant par une virgule : *« lecture rapide, à lire »*. -Des règles complexes peuvent être écrites en utilisant les opérateurs pré-définis : -if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. - -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 (attention, pour certaines valeurs, vous devez ajouter des guillemets, par exemple ``language = "en"``) : - -=========== ============================================== ========== ========== -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 à … -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 -readingTime Le temps de lecture de l'article, en minutes AND Telle règle et telle règle -domainName Le nom de domaine de l'article matches Contient telle chaîne de caractère (insensible à la casse). Exemple : title matches "football" - notmaches Ne contient pas telle chaîne de caractère (insensible à la casse). Exemple : title notmatches "football" -=========== ============================================== ========== ========== diff --git a/docs/fr/user/configuring_mobile.rst b/docs/fr/user/configuring_mobile.rst deleted file mode 100644 index 4036c354..00000000 --- a/docs/fr/user/configuring_mobile.rst +++ /dev/null @@ -1,12 +0,0 @@ -Configurer les applications mobile pour wallabag -================================================ - -Étapes pour configurer les applications ---------------------------------------- - -- Tout d'abord, *créez un nouveau client* dans la section ``Gestion des clients API``. Le nom de votre application importe peu. Ce qui nous intéresse, ce sont l'``ID Client`` et la ``clé secrète``. Notez bien ces deux valeurs. -- Quand vous installez une application smartphone, on va vous demander de renseigner l'adresse de votre serveur de wallabag. Par exemple, pour wallabag.it, c'est ``https://app.wallabag.it``. -- Les deux valeurs notées précédemment vous seront également demandées. Insérez-les dans les champs correspondants. -- Enfin, vous devez renseigner votre ``nom d'utilisateur`` et votre ``mot de passe``. Ce sont les mêmes valeurs que lorsque vous vous connectez à wallabag. - -Vous pouvez également regarder du côté de la page `Android `_. Particulièrement la section sur les *limitations connues*. diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst deleted file mode 100644 index 9c18e094..00000000 --- a/docs/fr/user/create_account.rst +++ /dev/null @@ -1,42 +0,0 @@ -Se créer un compte et se connecter -================================== - -Se créer un compte ------------------- - -Sur la page de connexion, cliquez sur le bouton ``Créer un compte``. - -.. image:: ../../img/user/registration_form.png - :alt: Formulaire de création de compte - :align: center - -Vous devez renseigner le formulaire. Faites attention de bien renseigner une adresse -email valide, nous allons vous envoyer un email d'activation. - -.. image:: ../../img/user/sent_email.png - :alt: Un email a été envoyé pour activer votre compte - :align: center - -Vérifiez votre boite de réception, vous avez un nouvel email avec un lien comme celui-ci -``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. -Cliquez dessus pour activer votre compte. - -Votre compte est maintenant actif. - -.. image:: ../../img/user/activated_account.png - :alt: Bienvenue à bord ! - :align: center - -Se connecter ------------- - -Votre compte est maintenant actif, félicitations ! - -Pour vous connecter à wallabag, remplissez le formulaire de connexion. - -Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connecté -vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an. - -.. image:: ../../img/user/login_form.png - :alt: Formulaire de connexion - :align: center diff --git a/docs/fr/user/errors_during_fetching.rst b/docs/fr/user/errors_during_fetching.rst deleted file mode 100644 index 13cbde1d..00000000 --- a/docs/fr/user/errors_during_fetching.rst +++ /dev/null @@ -1,37 +0,0 @@ -Erreur durant la récupération des articles -========================================== - -Pourquoi la récupération des articles échoue ? ----------------------------------------------- - -Il peut y avoir plusieurs raisons : - -- problème de connexion internet -- wallabag ne peut pas récupérer le contenu à cause de la structure du site web - -Comment puis-je aider pour réparer ça ? ---------------------------------------- - -Vous pouvez 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). - -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). 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. - -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 ? ---------------------------------------------------- - -Si wallabag échoue en récupérant l'article, vous pouvez cliquer sur le bouton suivant -(le troisième sur l'image ci-dessous). - -.. image:: ../../img/user/refetch.png - :alt: Réessayer de récupérer le contenu - :align: center diff --git a/docs/fr/user/faq.rst b/docs/fr/user/faq.rst deleted file mode 100644 index 49aa94ba..00000000 --- a/docs/fr/user/faq.rst +++ /dev/null @@ -1,42 +0,0 @@ -Foire Aux Questions -=================== - -Durant l'installation, je rencontre cette erreur ``Error Output: sh: 1: @post-cmd: not found`` ----------------------------------------------------------------------------------------------- - -Il semblerait que vous ayiez un problème avec votre installation de ``composer``. Essayez de le désinstaller puis de le réinstaller. - -`Vous pouvez lire la documentation de composer pour savoir comment l'installer -`__. - -Je ne peux pas valider le formulaire de création de compte ----------------------------------------------------------- - -Soyez sur d'avoir bien renseigné tous les champs : - -* une adresse email valide -* le même mot de passe dans les deux champs - -Je n'ai pas reçu mon email d'activation ---------------------------------------- - -Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ? - -Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. ----------------------------------------------------------------------------------------------------------------------------------- - -Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte. - -J'ai oublié mon mot de passe ----------------------------- - -Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``, -sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur, -un email vous sera envoyé. - -J'ai l'erreur ``failed to load external entity`` quand j'essaie d'installer wallabag ------------------------------------------------------------------------------------- - -Comme décrit `ici `_, modifiez le fichier ``web/app.php`` et ajoutez la ligne ``libxml_disable_entity_loader(false);`` à la ligne 5. - -C'est un bug lié à PHP et Doctrine, nous ne pouvons rien faire de notre côté. diff --git a/docs/fr/user/filters.rst b/docs/fr/user/filters.rst deleted file mode 100644 index 5807bdbd..00000000 --- a/docs/fr/user/filters.rst +++ /dev/null @@ -1,55 +0,0 @@ -Retrouver des articles grâce aux filtres -======================================== - -Pour retrouver plus facilement vos articles, vous pouvez utiliser les filtres. -Cliquez sur la troisième icône de la barre supérieure. - -.. image:: ../../img/user/topbar.png - :alt: Barre supérieure - :align: center - -Tous ces filtres peuvent être combinés. - -.. image:: ../../img/user/filters.png - :alt: Combine all filters - :align: center - -Statut ------- - -Utilisez ces cases à cocher pour retrouver les articles lus ou mis en favori. - -Image de prévisualisation -------------------------- - -Cochez ce filtre si vous voulez retrouver les articles avec une image de prévisualisation. - -Langage -------- - -wallabag (via graby) peut détecter la langue dans laquelle l'article est écrit. -C'est ainsi facile pour vous de retrouver des articles écrits dans une langue spécifique. - -Statut HTTP ------------ - -Vous pouvez retrouver des articles en filtrant par leur code HTTP : 200, 404, 500, etc. - -Temps de lecture ----------------- - -wallabag estime combien de temps vous avez besoin pour lire un article. -Avec ce filtre, vous pouvez par exemple retrouver les articles qui ont une estimation -entre 2 et 5 minutes. - -Nom de domaine --------------- - -Grâce à ce filtre, vous pouvez retrouver les articles venant d'un même nom de domaine. -Par exemple, dans ce champ, saisissez ``lemonde.fr`` pour retrouver les articles de ce site. - -Date de création ----------------- - -Quand vous ajoutez un article, wallabag stocke la date courante. -C'est très pratique pour retrouver les articles ajoutés entre le 1er et le 31 janvier par exemple. diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst deleted file mode 100644 index 5317ee4b..00000000 --- a/docs/fr/user/import.rst +++ /dev/null @@ -1,155 +0,0 @@ -Migrer depuis ... -================= - -Dans wallabag 2.x, vous pouvez importer des données depuis : - -- `Pocket <#id1>`_ -- `Readability <#id2>`_ -- `Instapaper <#id4>`_ -- `wallabag 1.x <#id6>`_ -- `wallabag 2.x <#id7>`_ - -Nous avons aussi développé `un script pour exécuter des migrations via la ligne de commande <#import-via-la-ligne-de-commande-cli>`_. - -Puisque les imports peuvent gourmands en ressource, nous avons mis en place un système de tâche asynchrone. `Vous trouverez la documentation ici `_ (niveau expert). - -Pocket ------- - -Créer une nouvelle application dans Pocket -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Pour importer vos données depuis Pocket, nous utilisons l'API de Pocket. -Vous devez créer une nouvelle application sur leur site dédié aux développeurs pour continuer. - -* Créez une nouvelle application `sur leur site Développeurs `_ -* Remplissez les champs requis : nom de l'application, description de l'application, - permissions (seulement **retrieve**), la plateforme (**web**), acceptez les - termes d'utilisation du service et soumettez votre application - -Pocket vous fournira une **Consumer Key** (par exemple, `49961-985e4b92fe21fe4c78d682c1`). -Vous devez configurer la ``pocket_consumer_key`` dans le menu ``Configuration``. - -Maintenant, tout est bien configuré pour migrer depuis Pocket. - -Importez vos données dans wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans -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. - -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. - -Depuis Pinboard ---------------- - -Exportez vos données de Pinboard -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sur la page « Backup » (`https://pinboard.in/settings/backup `_), cliquez sur « JSON » dans la section « Bookmarks ». Un fichier json (sans extension) sera téléchargé (``pinboard_export``). - -Importez vos données dans wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans -la section Pinboard 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. - -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``). - -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. - -wallabag 1.x ------------- - -Si vous utilisiez wallabag v1.x, vous devez exporter vos données avant de migrer à wallabag v2.x, à cause du changement complet de l'application et de sa base de données. Sur votre ancienne instance de wallabag v1, vous pouvez exporter vos données en allant sur la page de configuration de l'application. - -.. image:: ../../img/user/export_v1.png - :alt: Export depuis wallabag v1 - :align: center - -.. note:: - Si vous avez plusieurs comptes sur la même instance de wallabag, chaque utilisateur doit exporter ses données depuis wallabag v1 et les importer dans la v2. - -.. note:: - S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide `_. - -Une fois que vous avez récupéré le fichier json contenant vos données, vous pouvez installer wallabag v2 si c'est nécessaire en suivant `la procédure standard `_. - -Une fois que vous avez créé un compte utilisateur sur votre nouvelle instance de wallabag v2, rendez-vous dans la section `Import`. Vous devez choisir l'import depuis wallabag v1 puis sélectionner votre fichier json récupéré précédemment. - -.. image:: ../../img/user/import_wallabagv1.png - :alt: Import depuis wallabag v1 - :align: center - -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 la ligne de commande (CLI) --------------------------------------= 5.6**, 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 : - -:: - - curl -s https://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 -- 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 -- 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 : - -- pdo_mysql -- pdo_sqlite -- pdo_pgsql - -Installation ------------- - -Sur un serveur dédié (méthode conseillée) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Pour installer wallabag, vous devez exécuter ces commandes : - -:: - - git clone https://github.com/wallabag/wallabag.git - cd wallabag && make install - -Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : - -:: - - make run - -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 la `documentation Symfony `__ pour en savoir plus. - -Sur un serveur mutualisé -~~~~~~~~~~~~~~~~~~~~~~~~ - -Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur. -La configuration par défaut utilise SQLite pour la base de données. Si vous souhaitez changer ces paramètres, vous devez modifier le fichier ``app/config/parameters.yml``. - -Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``. - -.. caution:: Avec cette archive, wallabag ne vérifie pas si les extensions obligatoires sont présentes sur votre serveur pour bien fonctionner (ces vérifications sont faites durant le ``composer install`` quand vous avez un serveur dédié, voir ci-dessus). - -Exécutez cette commande pour télécharger et décompresser l'archive : - -.. code-block:: bash - - wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -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 - - docker pull wallabag/wallabag - -Installation sur Cloudron -~~~~~~~~~~~~~~~~~~~~~~~~ - -Cloudron permet d'installer des applications web sur votre serveur -wallabag est proposé en tant qu'application Cloudron et est disponible directement depuis le store. - -`Installer wallabag sur Cloudron `__ - -Virtual hosts -------------- - -Configuration avec Apache -~~~~~~~~~~~~~~~~~~~~~~~~~ - -N'oubliez pas d'activer le mod *rewrite* de Apache - -.. code-block:: bash - - a2enmod rewrite && systemctl reload apache2 - -En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag`` et que vous utilisiez PHP comme un module Apache, voici un vhost pour 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 - - -.. tip:: Pour Apache 2.4, dans la section `` vous devez remplacer les directives suivantes : - -:: - - AllowOverride None - Order Allow,Deny - Allow from All - - -par - -:: - - Require All granted - - - - -Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. - -Configuration avec Nginx -~~~~~~~~~~~~~~~~~~~~~~~~ - -En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour 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; - } - - # return 404 for all other php files not matching the front controller - # this prevents access to other php files you don't want to be accessible. - location ~ \.php$ { - return 404; - } - - error_log /var/log/nginx/wallabag_error.log; - access_log /var/log/nginx/wallabag_access.log; - } - -Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. - -.. tip:: - - Si vous voulez importer un fichier important dans wallabag, vous devez ajouter cette ligne dans votre configuration nginx ``client_max_body_size XM; # allows file uploads up to X megabytes``. - -Configuration avec lighttpd -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration pour wallabag (éditez votre fichier ``lighttpd.conf`` collez-y cette configuration) : - -:: - - 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", - ) - -Droits d'accès aux dossiers du projet -------------------------------------- - -Environnement de test -~~~~~~~~~~~~~~~~~~~~~ - -Quand nous souhaitons juste tester wallabag, nous lançons simplement la commande ``php bin/console server:run --env=prod`` pour démarrer l'instance wallabag et tout se passe correctement car l'utilisateur qui a démarré le projet a accès naturellement au repertoire courant, tout va bien. - -Environnement de production -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Dès lors que nous utilisons Apache ou Nginx pour accéder à notre instance wallabag, et non plus la commande ``php bin/console server:run --env=prod`` pour la démarrer, il faut prendre garde à octroyer les bons droits aux bons dossiers afin de préserver la sécurité de l'ensemble des fichiers fournis par le projet. - -Aussi, le dossier, connu sous le nom de ``DocumentRoot`` (pour apache) ou ``root`` (pour Nginx), doit être impérativement accessible par l'utilisateur de Apache ou Nginx. Le nom de cet utilisateur est généralement ``www-data``, ``apache`` ou ``nobody`` (selon les systèmes linux utilisés). - -Donc le dossier ``/var/www/wallabag/web`` doit être accessible par ce dernier. Mais cela ne suffira pas si nous nous contentons de ce dossier, et nous pourrions avoir, au mieux une page blanche en accédant à la page d'accueil du projet, au pire une erreur 500. - -Cela est dû au fait qu'il faut aussi octroyer les mêmes droits d'accès au dossier ``/var/www/wallabag/var`` que ceux octroyés au dossier ``/var/www/wallabag/web``. Ainsi, on règle le problème par la commande suivante : - -.. code-block:: bash - - chown -R www-data:www-data /var/www/wallabag/var - -Il en est de même pour les dossiers suivants : - -* /var/www/wallabag/bin/ -* /var/www/wallabag/app/config/ -* /var/www/wallabag/vendor/ - -en tapant - -.. 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 - -sinon lors de la mise à jour vous finirez par rencontrer les erreurs suivantes : - - -.. 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 diff --git a/docs/fr/user/parameters.rst b/docs/fr/user/parameters.rst deleted file mode 100644 index b2e33524..00000000 --- a/docs/fr/user/parameters.rst +++ /dev/null @@ -1,95 +0,0 @@ -À quoi servent les paramètres ? -=============================== - -Fichier `parameters.yml` par défaut ------------------------------------ - -Voici la dernière version par défaut du fichier `app/config/parameters.yml`. Soyez sur que le votre respecte celui-ci. -Si vous ne savez pas quelle valeur vous devez mettre, laissez celle 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_ - database_socket: null - 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_scheme: tcp - redis_host: localhost - redis_port: 6379 - redis_path: null - redis_password: null - -Meaning of each parameter -------------------------- - -.. 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" - "redis_password", "null", "Mot de passe défini dans la configuration serveur de Redis (paramètre `requirepass` dans `redis.conf`)" diff --git a/docs/fr/user/query-upgrade-21-22.rst b/docs/fr/user/query-upgrade-21-22.rst deleted file mode 100644 index fa9835a8..00000000 --- a/docs/fr/user/query-upgrade-21-22.rst +++ /dev/null @@ -1,984 +0,0 @@ -Migration 20161001072726 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry_tag DROP FOREIGN KEY FK_C9F0DD7CBA364942 - ALTER TABLE wallabag_entry_tag DROP FOREIGN KEY FK_C9F0DD7CBAD26311 - ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE - ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_tag FOREIGN KEY (tag_id) REFERENCES wallabag_tag (id) ON DELETE CASCADE - ALTER TABLE wallabag_annotation DROP FOREIGN KEY FK_A7AED006BA364942 - ALTER TABLE wallabag_annotation ADD CONSTRAINT FK_annotation_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE - -Migration down -"""""""""""""" - -We didn't write down migration for ``20161001072726``. - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry_tag DROP CONSTRAINT fk_c9f0dd7cba364942 - ALTER TABLE wallabag_entry_tag DROP CONSTRAINT fk_c9f0dd7cbad26311 - ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE - ALTER TABLE wallabag_entry_tag ADD CONSTRAINT FK_entry_tag_tag FOREIGN KEY (tag_id) REFERENCES wallabag_tag (id) ON DELETE CASCADE - ALTER TABLE wallabag_annotation DROP CONSTRAINT fk_a7aed006ba364942 - ALTER TABLE wallabag_annotation ADD CONSTRAINT FK_annotation_entry FOREIGN KEY (entry_id) REFERENCES wallabag_entry (id) ON DELETE CASCADE - -Migration down -"""""""""""""" - -We didn't write down migration for ``20161001072726``. - -SQLite -^^^^^^ - -This migration can only be executed safely on MySQL or PostgreSQL. - -Migration 20161022134138 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER DATABASE wallabag CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci; - ALTER TABLE wallabag_user CHANGE confirmation_token confirmation_token VARCHAR(180) DEFAULT NULL; - ALTER TABLE wallabag_user CHANGE salt salt VARCHAR(180) NOT NULL; - ALTER TABLE wallabag_user CHANGE password password VARCHAR(180) NOT NULL; - ALTER TABLE wallabag_annotation CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_entry CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_tag CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_user CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_annotation CHANGE `text` `text` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_annotation CHANGE `quote` `quote` VARCHAR(191) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_entry CHANGE `title` `title` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_entry CHANGE `content` `content` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_tag CHANGE `label` `label` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - ALTER TABLE wallabag_user CHANGE `name` `name` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER DATABASE wallabag CHARACTER SET = utf8 COLLATE = utf8_unicode_ci; - ALTER TABLE wallabag_annotation CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_entry CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_tag CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_user CONVERT TO CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_annotation CHANGE `text` `text` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_annotation CHANGE `quote` `quote` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_entry CHANGE `title` `title` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_entry CHANGE `content` `content` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_tag CHANGE `label` `label` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci; - ALTER TABLE wallabag_user CHANGE `name` `name` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci; - -PostgreSQL and SQLite -^^^^^^^^^^^^^^^^^^^^^ - -This migration only apply to MySQL. - -Migration 20161024212538 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_oauth2_clients ADD user_id INT NOT NULL - ALTER TABLE wallabag_oauth2_clients ADD CONSTRAINT IDX_user_oauth_client FOREIGN KEY (user_id) REFERENCES wallabag_user (id) ON DELETE CASCADE - CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id) - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_oauth2_clients DROP FOREIGN KEY IDX_user_oauth_client - ALTER TABLE wallabag_oauth2_clients DROP user_id - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_oauth2_clients ADD user_id INT DEFAULT NULL - ALTER TABLE wallabag_oauth2_clients ADD CONSTRAINT IDX_user_oauth_client FOREIGN KEY (user_id) REFERENCES wallabag_user (id) ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE - CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id) - - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_oauth2_clients DROP CONSTRAINT idx_user_oauth_client - ALTER TABLE wallabag_oauth2_clients DROP user_id - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - CREATE TEMPORARY TABLE __temp__wallabag_oauth2_clients AS SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM wallabag_oauth2_clients - DROP TABLE wallabag_oauth2_clients - CREATE TABLE wallabag_oauth2_clients (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, random_id VARCHAR(255) NOT NULL COLLATE BINARY, redirect_uris CLOB NOT NULL COLLATE BINARY, secret VARCHAR(255) NOT NULL COLLATE BINARY, allowed_grant_types CLOB NOT NULL COLLATE BINARY, name CLOB DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id), CONSTRAINT IDX_user_oauth_client FOREIGN KEY (user_id) REFERENCES wallabag_user (id) ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE) - INSERT INTO wallabag_oauth2_clients (id, random_id, redirect_uris, secret, allowed_grant_types, name) SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM __temp__wallabag_oauth2_clients - DROP TABLE __temp__wallabag_oauth2_clients - CREATE INDEX IDX_635D765EA76ED395 ON wallabag_oauth2_clients (user_id) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_635D765EA76ED395 - CREATE TEMPORARY TABLE __temp__wallabag_oauth2_clients AS SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM wallabag_oauth2_clients - DROP TABLE wallabag_oauth2_clients - CREATE TABLE wallabag_oauth2_clients (id INTEGER NOT NULL, random_id VARCHAR(255) NOT NULL COLLATE BINARY, redirect_uris CLOB NOT NULL COLLATE BINARY, secret VARCHAR(255) NOT NULL COLLATE BINARY, allowed_grant_types CLOB NOT NULL COLLATE BINARY, name CLOB DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id)) - INSERT INTO wallabag_oauth2_clients (id, random_id, redirect_uris, secret, allowed_grant_types, name) SELECT id, random_id, redirect_uris, secret, allowed_grant_types, name FROM __temp__wallabag_oauth2_clients - DROP TABLE __temp__wallabag_oauth2_clients - -Migration 20161031132655 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled'; - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled'; - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('download_images_enabled', 0, 'misc') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'download_images_enabled'; - -Migration 20161104073720 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_entry_created_at ON wallabag_entry - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX idx_entry_created_at - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - DROP INDEX created_at_idx - DROP INDEX IDX_F4D18282A76ED395 - CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry - DROP TABLE wallabag_entry - CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uuid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id)) - INSERT INTO wallabag_entry (id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry - DROP TABLE __temp__wallabag_entry - CREATE INDEX created_at_idx ON wallabag_entry (created_at) - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - CREATE INDEX IDX_entry_created_at ON wallabag_entry (created_at) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_entry_created_at - DROP INDEX IDX_F4D18282A76ED395 - DROP INDEX created_at_idx - CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry - DROP TABLE wallabag_entry - CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uuid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id)) - INSERT INTO wallabag_entry (id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry - DROP TABLE __temp__wallabag_entry - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - CREATE INDEX created_at_idx ON wallabag_entry (created_at) - -Migration 20161106113822 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config ADD action_mark_as_read INT DEFAULT 0 - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config DROP action_mark_as_read - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config ADD action_mark_as_read INT DEFAULT 0 - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config DROP action_mark_as_read - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config ADD COLUMN action_mark_as_read INTEGER DEFAULT 0 - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX UNIQ_87E64C53A76ED395 - CREATE TEMPORARY TABLE __temp__wallabag_config AS SELECT id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key FROM wallabag_config - DROP TABLE wallabag_config - CREATE TABLE wallabag_config (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, theme VARCHAR(255) NOT NULL COLLATE BINARY, items_per_page INTEGER NOT NULL, language VARCHAR(255) NOT NULL COLLATE BINARY, rss_token VARCHAR(255) DEFAULT NULL COLLATE BINARY, rss_limit INTEGER DEFAULT NULL, reading_speed DOUBLE PRECISION DEFAULT NULL, pocket_consumer_key VARCHAR(255) DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id)) - INSERT INTO wallabag_config (id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key) SELECT id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key FROM __temp__wallabag_config - DROP TABLE __temp__wallabag_config - CREATE UNIQUE INDEX UNIQ_87E64C53A76ED395 ON wallabag_config (user_id) - -Migration 20161117071626 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry') - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark'; - DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url'; - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry') - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark'; - DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url'; - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('share_unmark', 0, 'entry') - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('unmark_url', 'https://unmark.it', 'entry') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'share_unmark'; - DELETE FROM wallabag_craue_config_setting WHERE name = 'unmark_url'; - -Migration 20161118134328 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry ADD http_status VARCHAR(3) DEFAULT NULL - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry DROP http_status - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry ADD http_status VARCHAR(3) DEFAULT NULL - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry DROP http_status - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry ADD COLUMN http_status VARCHAR(3) DEFAULT NULL - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX created_at_idx - DROP INDEX IDX_F4D18282A76ED395 - CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry - DROP TABLE wallabag_entry - CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uuid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id)) - INSERT INTO wallabag_entry (id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uuid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry - DROP TABLE __temp__wallabag_entry - CREATE INDEX created_at_idx ON wallabag_entry (created_at) - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - -Migration 20161122144743 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access'; - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access'; - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - INSERT INTO wallabag_craue_config_setting (name, value, section) VALUES ('restricted_access', 0, 'entry') - -Migration down -"""""""""""""" - -.. code-block:: sql - - DELETE FROM wallabag_craue_config_setting WHERE name = 'restricted_access'; - -Migration 20161122203647 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user DROP expired, DROP credentials_expired - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user ADD expired SMALLINT DEFAULT NULL, ADD credentials_expired SMALLINT DEFAULT NULL - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user DROP expired - ALTER TABLE wallabag_user DROP credentials_expired - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user ADD expired SMALLINT DEFAULT NULL - ALTER TABLE wallabag_user ADD credentials_expired SMALLINT DEFAULT NULL - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - DROP INDEX UNIQ_1D63E7E5C05FB297 - DROP INDEX UNIQ_1D63E7E5A0D96FBF - DROP INDEX UNIQ_1D63E7E592FC23A8 - CREATE TEMPORARY TABLE __temp__wallabag_user AS SELECT id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, locked, expires_at, confirmation_token, password_requested_at, roles, credentials_expire_at, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted FROM wallabag_user - DROP TABLE wallabag_user - CREATE TABLE wallabag_user (id INTEGER NOT NULL, username VARCHAR(180) NOT NULL COLLATE BINARY, username_canonical VARCHAR(180) NOT NULL COLLATE BINARY, email VARCHAR(180) NOT NULL COLLATE BINARY, email_canonical VARCHAR(180) NOT NULL COLLATE BINARY, enabled BOOLEAN NOT NULL, salt VARCHAR(255) NOT NULL COLLATE BINARY, password VARCHAR(255) NOT NULL COLLATE BINARY, last_login DATETIME DEFAULT NULL, locked BOOLEAN NOT NULL, expires_at DATETIME DEFAULT NULL, confirmation_token VARCHAR(180) DEFAULT NULL COLLATE BINARY, password_requested_at DATETIME DEFAULT NULL, roles CLOB NOT NULL COLLATE BINARY, credentials_expire_at DATETIME DEFAULT NULL, name CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, authCode INTEGER DEFAULT NULL, twoFactorAuthentication BOOLEAN NOT NULL, trusted CLOB DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id)) - INSERT INTO wallabag_user (id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, locked, expires_at, confirmation_token, password_requested_at, roles, credentials_expire_at, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted) SELECT id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, locked, expires_at, confirmation_token, password_requested_at, roles, credentials_expire_at, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted FROM __temp__wallabag_user - DROP TABLE __temp__wallabag_user - CREATE UNIQUE INDEX UNIQ_1D63E7E5C05FB297 ON wallabag_user (confirmation_token) - CREATE UNIQUE INDEX UNIQ_1D63E7E5A0D96FBF ON wallabag_user (email_canonical) - CREATE UNIQUE INDEX UNIQ_1D63E7E592FC23A8 ON wallabag_user (username_canonical) - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user ADD COLUMN expired SMALLINT DEFAULT NULL - ALTER TABLE wallabag_user ADD COLUMN credentials_expired SMALLINT DEFAULT NULL - -Migration 20161128084725 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config ADD list_mode INT DEFAULT NULL - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config DROP list_mode - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config ADD list_mode INT DEFAULT NULL - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config DROP list_mode - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_config ADD COLUMN list_mode INTEGER DEFAULT NULL - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX UNIQ_87E64C53A76ED395 - CREATE TEMPORARY TABLE __temp__wallabag_config AS SELECT id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key FROM wallabag_config - DROP TABLE wallabag_config - CREATE TABLE wallabag_config (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, theme VARCHAR(255) NOT NULL COLLATE BINARY, items_per_page INTEGER NOT NULL, language VARCHAR(255) NOT NULL COLLATE BINARY, rss_token VARCHAR(255) DEFAULT NULL COLLATE BINARY, rss_limit INTEGER DEFAULT NULL, reading_speed DOUBLE PRECISION DEFAULT NULL, pocket_consumer_key VARCHAR(255) DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id)) - INSERT INTO wallabag_config (id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key) SELECT id, user_id, theme, items_per_page, language, rss_token, rss_limit, reading_speed, pocket_consumer_key FROM __temp__wallabag_config - DROP TABLE __temp__wallabag_config - CREATE UNIQUE INDEX UNIQ_87E64C53A76ED395 ON wallabag_config (user_id) - -Migration 20161128131503 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user DROP locked, DROP credentials_expire_at, DROP expires_at - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user ADD locked SMALLINT DEFAULT NULL, ADD credentials_expire_at DATETIME DEFAULT NULL, ADD expires_at DATETIME DEFAULT NULL - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user DROP locked - ALTER TABLE wallabag_user DROP credentials_expire_at - ALTER TABLE wallabag_user DROP expires_at - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user ADD locked SMALLINT DEFAULT NULL - ALTER TABLE wallabag_user ADD credentials_expire_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL - ALTER TABLE wallabag_user ADD expires_at TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_user ADD COLUMN locked SMALLINT DEFAULT NULL - ALTER TABLE wallabag_user ADD COLUMN credentials_expire_at DATETIME DEFAULT NULL - ALTER TABLE wallabag_user ADD COLUMN expires_at DATETIME DEFAULT NULL - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX UNIQ_1D63E7E592FC23A8 - DROP INDEX UNIQ_1D63E7E5A0D96FBF - DROP INDEX UNIQ_1D63E7E5C05FB297 - CREATE TEMPORARY TABLE __temp__wallabag_user AS SELECT id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, confirmation_token, password_requested_at, roles, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted, expired, credentials_expired FROM wallabag_user - DROP TABLE wallabag_user - CREATE TABLE wallabag_user (id INTEGER NOT NULL, username VARCHAR(180) NOT NULL COLLATE BINARY, username_canonical VARCHAR(180) NOT NULL COLLATE BINARY, email VARCHAR(180) NOT NULL COLLATE BINARY, email_canonical VARCHAR(180) NOT NULL COLLATE BINARY, enabled BOOLEAN NOT NULL, salt VARCHAR(255) NOT NULL COLLATE BINARY, password VARCHAR(255) NOT NULL COLLATE BINARY, last_login DATETIME DEFAULT NULL, confirmation_token VARCHAR(180) DEFAULT NULL COLLATE BINARY, password_requested_at DATETIME DEFAULT NULL, roles CLOB NOT NULL COLLATE BINARY, name CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, authCode INTEGER DEFAULT NULL, twoFactorAuthentication BOOLEAN NOT NULL, trusted CLOB DEFAULT NULL COLLATE BINARY, expired SMALLINT DEFAULT NULL, credentials_expired SMALLINT DEFAULT NULL, PRIMARY KEY(id)) - INSERT INTO wallabag_user (id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, confirmation_token, password_requested_at, roles, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted, expired, credentials_expired) SELECT id, username, username_canonical, email, email_canonical, enabled, salt, password, last_login, confirmation_token, password_requested_at, roles, name, created_at, updated_at, authCode, twoFactorAuthentication, trusted, expired, credentials_expired FROM __temp__wallabag_user - DROP TABLE __temp__wallabag_user - CREATE UNIQUE INDEX UNIQ_1D63E7E592FC23A8 ON wallabag_user (username_canonical) - CREATE UNIQUE INDEX UNIQ_1D63E7E5A0D96FBF ON wallabag_user (email_canonical) - CREATE UNIQUE INDEX UNIQ_1D63E7E5C05FB297 ON wallabag_user (confirmation_token) - -Migration 20161214094402 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry CHANGE uuid uid VARCHAR(23) - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry CHANGE uid uuid VARCHAR(23) - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry RENAME uuid TO uid - -Migration down -"""""""""""""" - -.. code-block:: sql - - ALTER TABLE wallabag_entry RENAME uid TO uuid - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - CREATE TABLE __temp__wallabag_entry ( - id INTEGER NOT NULL, - user_id INTEGER DEFAULT NULL, - uid VARCHAR(23) DEFAULT NULL, - title CLOB DEFAULT NULL, - url CLOB DEFAULT NULL, - is_archived BOOLEAN NOT NULL, - is_starred BOOLEAN NOT NULL, - content CLOB DEFAULT NULL, - created_at DATETIME NOT NULL, - updated_at DATETIME NOT NULL, - mimetype CLOB DEFAULT NULL, - language CLOB DEFAULT NULL, - reading_time INTEGER DEFAULT NULL, - domain_name CLOB DEFAULT NULL, - preview_picture CLOB DEFAULT NULL, - is_public BOOLEAN DEFAULT '0', - http_status VARCHAR(3) DEFAULT NULL, - PRIMARY KEY(id) - ); - INSERT INTO __temp__wallabag_entry SELECT id,user_id,uuid,title,url,is_archived,is_starred,content,created_at,updated_at,mimetype,language,reading_time,domain_name,preview_picture,is_public,http_status FROM wallabag_entry; - DROP TABLE wallabag_entry; - ALTER TABLE __temp__wallabag_entry RENAME TO wallabag_entry - CREATE INDEX uid ON wallabag_entry (uid) - CREATE INDEX created_at ON wallabag_entry (created_at) - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - - -Migration down -"""""""""""""" - -.. code-block:: sql - - CREATE TABLE __temp__wallabag_entry ( - id INTEGER NOT NULL, - user_id INTEGER DEFAULT NULL, - uuid VARCHAR(23) DEFAULT NULL, - title CLOB DEFAULT NULL, - url CLOB DEFAULT NULL, - is_archived BOOLEAN NOT NULL, - is_starred BOOLEAN NOT NULL, - content CLOB DEFAULT NULL, - created_at DATETIME NOT NULL, - updated_at DATETIME NOT NULL, - mimetype CLOB DEFAULT NULL, - language CLOB DEFAULT NULL, - reading_time INTEGER DEFAULT NULL, - domain_name CLOB DEFAULT NULL, - preview_picture CLOB DEFAULT NULL, - is_public BOOLEAN DEFAULT '0', - http_status VARCHAR(3) DEFAULT NULL, - PRIMARY KEY(id) - ); - INSERT INTO __temp__wallabag_entry SELECT id,user_id,uid,title,url,is_archived,is_starred,content,created_at,updated_at,mimetype,language,reading_time,domain_name,preview_picture,is_public,http_status FROM wallabag_entry; - DROP TABLE wallabag_entry; - ALTER TABLE __temp__wallabag_entry RENAME TO wallabag_entry - CREATE INDEX uid ON wallabag_entry (uid) - CREATE INDEX created_at ON wallabag_entry (created_at) - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - -Migration 20161214094403 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - CREATE INDEX IDX_entry_uid ON wallabag_entry (uid) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_entry_uid ON wallabag_entry - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - CREATE INDEX IDX_entry_uid ON wallabag_entry (uid) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX idx_entry_uid - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_F4D18282A76ED395 - DROP INDEX created_at_idx - CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry - DROP TABLE wallabag_entry - CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id)) - INSERT INTO wallabag_entry (id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry - DROP TABLE __temp__wallabag_entry - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - CREATE INDEX created_at_idx ON wallabag_entry (created_at) - CREATE INDEX IDX_entry_uid ON wallabag_entry (uid) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_entry_uid - DROP INDEX created_at_idx - DROP INDEX IDX_F4D18282A76ED395 - CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM wallabag_entry - DROP TABLE wallabag_entry - CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uid CLOB DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', PRIMARY KEY(id)) - INSERT INTO wallabag_entry (id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public) SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public FROM __temp__wallabag_entry - DROP TABLE __temp__wallabag_entry - CREATE INDEX created_at_idx ON wallabag_entry (created_at) - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - -Migration 20170127093841 ------------------------- - -MySQL -^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - CREATE INDEX IDX_entry_starred ON wallabag_entry (is_starred) - CREATE INDEX IDX_entry_archived ON wallabag_entry (is_archived) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_entry_starred ON wallabag_entry - DROP INDEX IDX_entry_archived ON wallabag_entry - -PostgreSQL -^^^^^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - CREATE INDEX IDX_entry_starred ON wallabag_entry (is_starred) - CREATE INDEX IDX_entry_archived ON wallabag_entry (is_archived) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_entry_starred - DROP INDEX IDX_entry_archived - -SQLite -^^^^^^ - -Migration up -"""""""""""" - -.. code-block:: sql - - DROP INDEX uid - DROP INDEX created_at - DROP INDEX IDX_F4D18282A76ED395 - CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public, http_status FROM wallabag_entry - DROP TABLE wallabag_entry - CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uid VARCHAR(23) DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', http_status VARCHAR(3) DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id)) - INSERT INTO wallabag_entry (id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public, http_status) SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public, http_status FROM __temp__wallabag_entry - DROP TABLE __temp__wallabag_entry - CREATE INDEX uid ON wallabag_entry (uid) - CREATE INDEX created_at ON wallabag_entry (created_at) - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - CREATE INDEX IDX_entry_starred ON wallabag_entry (is_starred) - CREATE INDEX IDX_entry_archived ON wallabag_entry (is_archived) - -Migration down -"""""""""""""" - -.. code-block:: sql - - DROP INDEX IDX_entry_archived - DROP INDEX IDX_entry_starred - DROP INDEX IDX_F4D18282A76ED395 - DROP INDEX created_at - DROP INDEX uid - CREATE TEMPORARY TABLE __temp__wallabag_entry AS SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public, http_status FROM wallabag_entry - DROP TABLE wallabag_entry - CREATE TABLE wallabag_entry (id INTEGER NOT NULL, user_id INTEGER DEFAULT NULL, uid VARCHAR(23) DEFAULT NULL COLLATE BINARY, title CLOB DEFAULT NULL COLLATE BINARY, url CLOB DEFAULT NULL COLLATE BINARY, is_archived BOOLEAN NOT NULL, is_starred BOOLEAN NOT NULL, content CLOB DEFAULT NULL COLLATE BINARY, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, mimetype CLOB DEFAULT NULL COLLATE BINARY, language CLOB DEFAULT NULL COLLATE BINARY, reading_time INTEGER DEFAULT NULL, domain_name CLOB DEFAULT NULL COLLATE BINARY, preview_picture CLOB DEFAULT NULL COLLATE BINARY, is_public BOOLEAN DEFAULT '0', http_status VARCHAR(3) DEFAULT NULL COLLATE BINARY, PRIMARY KEY(id)) - INSERT INTO wallabag_entry (id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public, http_status) SELECT id, user_id, uid, title, url, is_archived, is_starred, content, created_at, updated_at, mimetype, language, reading_time, domain_name, preview_picture, is_public, http_status FROM __temp__wallabag_entry - DROP TABLE __temp__wallabag_entry - CREATE INDEX IDX_F4D18282A76ED395 ON wallabag_entry (user_id) - CREATE INDEX created_at ON wallabag_entry (created_at) - CREATE INDEX uid ON wallabag_entry (uid) diff --git a/docs/fr/user/tags.rst b/docs/fr/user/tags.rst deleted file mode 100644 index 8ddc0f40..00000000 --- a/docs/fr/user/tags.rst +++ /dev/null @@ -1,2 +0,0 @@ -Tags -==== \ No newline at end of file diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst deleted file mode 100644 index af198006..00000000 --- a/docs/fr/user/upgrade.rst +++ /dev/null @@ -1,140 +0,0 @@ -Mettre à jour votre installation de wallabag -============================================ - -Vous trouverez ici différentes manières de mettre à jour wallabag : - -- `de la 2.1.x à la 2.2.x <#mettre-a-jour-de-la-2-1-x-a-la-2-2-x>`_ -- `de la 2.0.x à la 2.1.1 <#mettre-a-jour-de-la-2-0-x-a-la-2-1-1>`_ -- `de la 1.x à la 2.x <#depuis-wallabag-1-x>`_ - -Mettre à jour de la 2.1.x à la 2.2.x ------------------------------------- - -Mise à jour sur un serveur dédié -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -**Depuis 2.1.x:** - -:: - - make update - php bin/console doctrine:migrations:migrate --no-interaction -e=prod - -**Depuis 2.2.0:** - -:: - - make update - -Explications à propos des migrations de base de données -""""""""""""""""""""""""""""""""""""""""""""""""""""""" - -Durant la mise à jour, nous exécutons des migrations de base de données. - -Toutes les migrations de base de données sont stockées dans le dossier ``app/DoctrineMigrations``. Vous pouvez exécuter chaque migration individuellement : -``bin/console doctrine:migrations:execute 20161001072726 --env=prod``. - -Voici la liste des migrations de la 2.1.x à la 2.2.0 : - -* ``20161001072726``: ajout de clés étrangères pour la réinitialisation de compte -* ``20161022134138``: conversion de la base de données à l'encodage ``utf8mb4`` (pour MySQL uniquement) -* ``20161024212538``: ajout de la colonne ``user_id`` sur la table ``oauth2_clients`` pour empêcher les utilisateurs de supprimer des clients API d'autres utilisateurs -* ``20161031132655``: ajout du paramètre interne pour activer/désactiver le téléchargement des images -* ``20161104073720``: ajout de l'index ``created_at`` sur la table ``entry`` -* ``20161106113822``: ajout du champ ``action_mark_as_read`` sur la table ``config`` -* ``20161117071626``: ajout du paramètre interne pour partager ses articles vers unmark.it -* ``20161118134328``: ajout du champ ``http_status`` sur la table ``entry`` -* ``20161122144743``: ajout du paramètre interne pour activer/désactiver la récupération d'articles derrière un paywall -* ``20161122203647``: suppression des champs ``expired`` et ``credentials_expired`` sur la table ``user`` -* ``20161128084725``: ajout du champ ``list_mode`` sur la table ``config`` -* ``20161128131503``: suppression des champs ``locked``, ``credentials_expire_at`` et ``expires_at`` sur la table ``user`` -* ``20161214094402``: renommage du champ ``uuid`` en ``uid`` sur la table ``entry`` -* ``20161214094403``: ajout de l'index ``uid`` sur la table ``entry`` -* ``20170127093841``: ajout des index ``is_starred`` et ``is_archived`` sur la table ``entry`` - -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 https://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -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. - -Merci de vérifier que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. 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_``. - -`Vous trouverez toutes les requêtes à exécuter ici `_. - - -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 version 2.1.1 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. - -Merci de vérifier que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. 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'; - -Depuis wallabag 1.x -------------------- - -Il n'y a pas de script automatique pour mettre à jour wallabag 1.x en wallabag 2.x. Vous devez : - -- exportez vos données -- installer wallabag 2.x (`lisez la documentation d'installation `_ ) -- importer vos données dans votre installation toute propre (`lisez la documentation d'import `_ ) -- cgit v1.2.3