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/en/conf.py | 55 -- docs/en/developer/api.rst | 271 --------- docs/en/developer/asynchronous.rst | 160 ------ docs/en/developer/console_commands.rst | 30 - docs/en/developer/docker.rst | 51 -- docs/en/developer/documentation.rst | 12 - docs/en/developer/front_end.rst | 33 -- docs/en/developer/paywall.rst | 65 --- docs/en/developer/testsuite.rst | 10 - docs/en/developer/translate.rst | 60 -- docs/en/index.rst | 53 -- docs/en/requirements.txt | 2 - docs/en/user/android.rst | 95 --- docs/en/user/articles.rst | 117 ---- docs/en/user/backup.rst | 26 - docs/en/user/configuration.rst | 132 ----- docs/en/user/configuring_mobile.rst | 13 - docs/en/user/create_account.rst | 42 -- docs/en/user/errors_during_fetching.rst | 37 -- docs/en/user/faq.rst | 55 -- docs/en/user/filters.rst | 54 -- docs/en/user/import.rst | 159 ------ docs/en/user/installation.rst | 365 ------------ docs/en/user/parameters.rst | 96 ---- docs/en/user/query-upgrade-21-22.rst | 984 -------------------------------- docs/en/user/tags.rst | 2 - docs/en/user/upgrade.rst | 148 ----- 27 files changed, 3127 deletions(-) delete mode 100644 docs/en/conf.py delete mode 100644 docs/en/developer/api.rst delete mode 100644 docs/en/developer/asynchronous.rst delete mode 100644 docs/en/developer/console_commands.rst delete mode 100644 docs/en/developer/docker.rst delete mode 100644 docs/en/developer/documentation.rst delete mode 100644 docs/en/developer/front_end.rst delete mode 100644 docs/en/developer/paywall.rst delete mode 100644 docs/en/developer/testsuite.rst delete mode 100644 docs/en/developer/translate.rst delete mode 100644 docs/en/index.rst delete mode 100644 docs/en/requirements.txt delete mode 100644 docs/en/user/android.rst delete mode 100644 docs/en/user/articles.rst delete mode 100644 docs/en/user/backup.rst delete mode 100644 docs/en/user/configuration.rst delete mode 100644 docs/en/user/configuring_mobile.rst delete mode 100644 docs/en/user/create_account.rst delete mode 100644 docs/en/user/errors_during_fetching.rst delete mode 100644 docs/en/user/faq.rst delete mode 100644 docs/en/user/filters.rst delete mode 100644 docs/en/user/import.rst delete mode 100644 docs/en/user/installation.rst delete mode 100644 docs/en/user/parameters.rst delete mode 100644 docs/en/user/query-upgrade-21-22.rst delete mode 100644 docs/en/user/tags.rst delete mode 100644 docs/en/user/upgrade.rst (limited to 'docs/en') diff --git a/docs/en/conf.py b/docs/en/conf.py deleted file mode 100644 index 5926f8c9..00000000 --- a/docs/en/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' -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 = 'wallabagdoc' -latex_elements = { - -} - -latex_documents = [ - ('index', 'wallabag.tex', u'wallabag Documentation', - u'Nicolas Lœuillet', 'manual'), -] - -man_pages = [ - ('index', 'wallabag', 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/en/developer/api.rst b/docs/en/developer/api.rst deleted file mode 100644 index 80c96025..00000000 --- a/docs/en/developer/api.rst +++ /dev/null @@ -1,271 +0,0 @@ -API documentation -================= - -Thanks to this documentation, we'll see how to interact with the wallabag API. - -Requirements ------------- - -* wallabag freshly (or not) installed on http://localhost:8000 -* ``httpie`` installed on your computer (`see project website `__). Note that you can also adapt the commands using curl or wget. -* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance `_ - -Creating a new API client -------------------------- - -In your wallabag account, you can create a new API client at this URL http://localhost:8000/developer/client/create. - -Just give the redirect URL of your application and create your client. If your application is a desktop one, put whatever URL suits you the most. - -You get information like this: - -:: - - Client ID: - - 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc - - Client secret: - - 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 - - -Obtaining a refresh token -------------------------- - -For each API call, you'll need a token. Let's create it with this command (replace ``client_id``, ``client_secret``, ``username`` and ``password`` with their values): - -:: - - http POST http://localhost:8000/oauth/v2/token \ - grant_type=password \ - client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ - client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ - username=wallabag \ - password=wallabag - -You'll have this in return: - -:: - - 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" - } - -We'll work with the ``access_token`` value in our next calls. - -cURL example: - -:: - - curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag" - -Getting existing entries ------------------------- - -Documentation for this method: http://localhost:8000/api/doc#get--api-entries.{_format} - -As we work on a fresh wallabag installation, we'll have no result with this command: - -:: - - http GET http://localhost:8000/api/entries.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -returns: - -:: - - 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 - } - -The ``items`` array is empty. - -cURL example: - -:: - - curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -Adding your first entry ------------------------ - -Documentation for this method: 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" - -returns - -:: - - 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" - } - -Now, if you execute the previous command (see **Get existing entries**), you'll have data. - -cURL example: - -:: - - 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" - -Deleting an entry ------------------ - -Documentation for this method: http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} - -:: - - http DELETE http://localhost:8000/api/entries/1.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -returns - -:: - - 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" - } - -And if you want to list the existing entries (see **Get existing entries**), the array is empty. - -cURL example: - -:: - - curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -Other methods -------------- - -We won't write samples for each API method. - -Have a look on the listing here: http://localhost:8000/api/doc to know each method. - -Third party resources ---------------- - -Some applications or libraries use our API. Here is a non-exhaustive list of them: - -- `Java wrapper for the wallabag API `_ by Dmitriy Bogdanov. -- `.NET library for the wallabag v2 API `_ by Julian Oster. -- `Python API for wallabag `_ by FoxMaSk, for his project `Trigger Happy `_. -- `A plugin `_ designed for `Tiny Tiny RSS `_ that makes use of the wallabag v2 API. By Josh Panter. -- `Golang wrapper for the wallabag API `_ by Strubbl, for his projects `wallabag-stats graph `_ and the command line tool `wallabag-add-article `_. -- Tool to automatically download Wallabag articles into your local computer or Kobo ebook reader `wallabako `_ by anarcat. diff --git a/docs/en/developer/asynchronous.rst b/docs/en/developer/asynchronous.rst deleted file mode 100644 index 2e409e4a..00000000 --- a/docs/en/developer/asynchronous.rst +++ /dev/null @@ -1,160 +0,0 @@ -Asynchronous tasks -================== - -In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ or Redis. - -Install RabbitMQ for asynchronous tasks ---------------------------------------- - -Requirements -^^^^^^^^^^^^ - -You need to have RabbitMQ installed on your server. - -Installation -^^^^^^^^^^^^ - -.. code:: bash - - wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc - apt-key add rabbitmq-signing-key-public.asc - apt-get update - apt-get install rabbitmq-server - -Configuration and launch -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code:: bash - - rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) - rabbitmq-server -detached - -Stop RabbitMQ -^^^^^^^^^^^^^ - -.. code:: bash - - rabbitmqctl stop - - -Configure RabbitMQ in wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok: - -.. code:: yaml - - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - rabbitmq_prefetch_count: 10 # read http://www.rabbitmq.com/consumer-prefetch.html - -Enable RabbitMQ in wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). - -Launch RabbitMQ consumer -^^^^^^^^^^^^^^^^^^^^^^^^ - -Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: - -.. code:: bash - - # for Pocket import - bin/console 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 - -Install Redis for asynchronous tasks ------------------------------------- - -In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. - -Requirements -^^^^^^^^^^^^ - -You need to have Redis installed on your server. - -Installation -^^^^^^^^^^^^ - -.. code:: bash - - apt-get install redis-server - -Launch -^^^^^^ - -The server might be already running after installing, if not you can launch it using: - -.. code:: bash - - redis-server - - -Configure Redis in wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Edit your ``app/config/parameters.yml`` file to edit Redis configuration. The default one should be ok: - -.. code:: yaml - - redis_host: localhost - redis_port: 6379 - -Enable Redis in wallabag -^^^^^^^^^^^^^^^^^^^^^^^^ - -In internal settings, in the **Import** section, enable Redis (with the value 1). - -Launch Redis consumer -^^^^^^^^^^^^^^^^^^^^^ - -Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job: - -.. code:: bash - - # for Pocket import - bin/console wallabag:import:redis-worker -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 - -If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : - -.. code:: bash - - bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 diff --git a/docs/en/developer/console_commands.rst b/docs/en/developer/console_commands.rst deleted file mode 100644 index 85a8a092..00000000 --- a/docs/en/developer/console_commands.rst +++ /dev/null @@ -1,30 +0,0 @@ -Console Commands -================ - -wallabag has a number of CLI commands to manage a number of tasks. You can list all the commands by executing `bin/console` in the wallabag folder. - -Each command has a help accessible through `bin/console help %command%`. - -.. note:: - - If you're in a production environment, remember to add `-e prod` to each command. - -Notable commands ----------------- - -* `assets:install`: May be helpful if assets are missing. -* `cache:clear`: should be run after each update (included in `make update`). -* `doctrine:migrations:status`: Output the status of your database migrations. -* `fos:user:activate`: Manually activate an user. -* `fos:user:change-password`: Change a password for an user. -* `fos:user:create`: Create an user. -* `fos:user:deactivate`: Deactivate an user (not deleted). -* `fos:user:demote`: Removes a role from an user, typically admin rights. -* `fos:user:promote`: Adds a role to an user, typically admin rights. -* `rabbitmq:*`: May be useful if you're using RabbitMQ. -* `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users -* `wallabag:export`: Exports all entries for an user. You can choose the output path of the file. -* `wallabag:import`: Import entries to different formats to an user account. -* `wallabag:import:redis-worker`: Useful if you use Redis. -* `wallabag:install`: (re)Install wallabag -* `wallabag:tag:all`: Tag all entries for an user using his/her tagging rules. diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst deleted file mode 100644 index 5e4f2ce6..00000000 --- a/docs/en/developer/docker.rst +++ /dev/null @@ -1,51 +0,0 @@ -Run wallabag in docker-compose -============================== - -In order to run your own development instance of wallabag, you may -want to use the pre-configured docker compose files. - -Requirements ------------- - -Make sure to have `Docker -`__ and `Docker -Compose `__ availables on -your system and up to date. - -Switch DBMS ------------ - -By default, wallabag will start with a SQLite database. -Since wallabag provides support for Postgresql and MySQL, docker -containers are also available for these ones. - -In ``docker-compose.yml``, for the chosen DBMS uncomment: - -- the container definition (``postgres`` or ``mariadb`` root level - block) -- the container link in the ``php`` container -- the container env file in the ``php`` container - -In order to keep running Symfony commands on your host (such as -``wallabag:install``), you also should: - -- source the proper env files on your command line, so variables - like ``SYMFONY__ENV__DATABASE_HOST`` will exist. -- create a ``127.0.0.1 rdbms`` on your system ``hosts`` file - -Run wallabag ------------- - -#. Fork and clone the project -#. Edit ``app/config/parameters.yml`` to replace ``database_*`` - properties with commented ones (with values prefixed by ``env.``) -#. ``composer install`` the project dependencies -#. ``php bin/console wallabag:install`` to create the schema -#. ``docker-compose up`` to run the containers -#. Finally, browse to http://localhost:8080/ to find your freshly - installed wallabag. - -At various step, you'll probably run into UNIX permission problems, -bad paths in generated cache, etc… -Operations like removing cache files or changing files owners might -be frequently required, so don't be afraid ! diff --git a/docs/en/developer/documentation.rst b/docs/en/developer/documentation.rst deleted file mode 100644 index ab206479..00000000 --- a/docs/en/developer/documentation.rst +++ /dev/null @@ -1,12 +0,0 @@ -Contribute to this documentation -================================ - -Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs - -We use `ReadTheDocs -`__ to generate it. - -Pages are written in `Restructured Text -`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles. - -If you create a new page, don't forget to edit the `index.rst `__ file to add a link in the sidebar. \ No newline at end of file diff --git a/docs/en/developer/front_end.rst b/docs/en/developer/front_end.rst deleted file mode 100644 index 40f18a42..00000000 --- a/docs/en/developer/front_end.rst +++ /dev/null @@ -1,33 +0,0 @@ -Tips for front-end developers -============================= - -Starting from version 2.3, wallabag uses webpack to bundle its assets. - -Dev mode --------- - -If the server runs in dev mode, you need to run ``yarn run build:dev`` to generate the outputted javascript files for each theme. These are named ``%theme%.dev.js`` and are ignored by git. You need to relaunch ``yarn run build:dev`` for each change made to one of the assets files (js, css, pictures, fonts,...). - -Live reload ------------ - -Webpack brings support for live reload, which means you don't need to regenerate the assets file for each change neither reload the page manually. Changes are applied automatically in the web page. Just set the ``use_webpack_dev_server`` setting to ``true`` in ``app/config/config.yml`` and run ``yarn run watch`` and you're good to go. - -.. note:: - - Don't forget to put back ``use_webpack_dev_server`` to ``false`` when not using the live reload feature. - -Production builds ------------------ - -When you want to commit your changes, build them in production environment by using ``yarn run build:prod``. This will build all the assets needed for wallabag. To test that it properly works, you'll need to have a server in production mode, for instance with ``bin/console server:run -e=prod``. - -.. note:: - - Don't forget to generate production builds before committing ! - - -Code style ----------- - -Code style is checked by two tools : stylelint for (S)CSS and eslint for JS. ESlint config is based on the Airbnb base preset. diff --git a/docs/en/developer/paywall.rst b/docs/en/developer/paywall.rst deleted file mode 100644 index 153afa6f..00000000 --- a/docs/en/developer/paywall.rst +++ /dev/null @@ -1,65 +0,0 @@ -Articles behind a paywall -========================= - -wallabag can fetch articles from websites which use a paywall system. - -Enable paywall authentication ------------------------------ - -In internal settings, as a wallabag administrator, in the **Article** section, enable authentication for websites with paywall (with the value 1). - -Configure credentials in wallabag ---------------------------------- - -Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. For example, under Ubuntu: - -``sudo -u www-data nano /var/www/html/wallabag/app/config/parameters.yml`` - -Here is an example for some french websites (be careful: don't use the "tab" key, only spaces): - -.. code:: yaml - - sites_credentials: - mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} - arretsurimages.net: {username: "myASILogin", password: "mypassword"} - -.. note:: - - These credentials will be shared between each user of your wallabag instance. - -Parsing configuration files ---------------------------- - -.. note:: - - Read `this part of the documentation `_ to understand the configuration files, which are located under ``vendor/j0k3r/graby-site-config/``. For most of the websites, this file is already configured: the following instructions are only for the websites that are not configured yet. - -Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, -``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. - -Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated -on a website where the login form is loaded after the page (by ajax for example). - -``login_uri`` is the action URL of the form (``action`` attribute in the form). -``login_username_field`` is the ``name`` attribute of the login field. -``login_password_field`` is the ``name`` attribute of the password field. - -For example: - -.. 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"] - -Last step: clear the cache --------------------------- - -It's necessary to clear the wallabag cache with the following command (here under Ubuntu): ``sudo -u www-data php /var/www/html/wallabag/bin/console cache:clear -e=prod`` diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst deleted file mode 100644 index b2b16cdc..00000000 --- a/docs/en/developer/testsuite.rst +++ /dev/null @@ -1,10 +0,0 @@ -Testsuite -========= - -To ensure wallabag development quality, we wrote tests with `PHPUnit `_. - -If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. - -To launch wallabag testsuite, you need to install `ant `_. - -Then, execute this command ``make test``. diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst deleted file mode 100644 index 1e5d5009..00000000 --- a/docs/en/developer/translate.rst +++ /dev/null @@ -1,60 +0,0 @@ -Translate wallabag -================== - -wallabag web application ------------------------- - -Translation files -~~~~~~~~~~~~~~~~~ - -.. note:: - - As wallabag is mainly developed by a French team, please consider that french - translation is the most updated one and please copy it to create your own translation. - -You can find translation files here: https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations. - -You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE -is the ISO 639-1 code of your language (`see wikipedia `__). - -Other files to translate: - -- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. -- https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations. - -You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. - -Configuration file -~~~~~~~~~~~~~~~~~~ - -You have to edit `app/config/config.yml -`__ to display -your language on Configuration page of wallabag (to allow users to switch to this new translation). - -Under the ``wallabag_core.languages`` section, you have to add a new line with -your translation. For example: - -:: - - wallabag_core: - ... - languages: - en: 'English' - fr: 'Français' - - -For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code -of your language (see above). - -For the second column, it's the name of your language. Just that. - -wallabag documentation ----------------------- - -.. note:: - - Contrary to the web application, the main language for documentation is english. - -Documentation files are stored here: https://github.com/wallabag/wallabag/tree/master/docs - -You need to respect the ``en`` folder structure when you create your own translation. diff --git a/docs/en/index.rst b/docs/en/index.rst deleted file mode 100644 index 89f61d6d..00000000 --- a/docs/en/index.rst +++ /dev/null @@ -1,53 +0,0 @@ -wallabag documentation -====================== - -.. image:: ../img/wallabag.png - :alt: wallabag logo - :align: center - -**wallabag** is a read-it-later application: it saves a web page by -keeping content only. Elements like navigation or ads are deleted. - -The main documentation for this application is organized into a couple sections: - -* :ref:`user-docs` -* :ref:`dev-docs` - -The documentation is available in other languages: - -* `Documentation en français `_ -* `Dokumentation in Deutsch `_ - -.. _user-docs: - -.. toctree:: - :maxdepth: 2 - :caption: User documentation - - 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: Developer documentation - - developer/api - developer/docker - developer/paywall - developer/documentation - developer/translate - developer/asynchronous diff --git a/docs/en/requirements.txt b/docs/en/requirements.txt deleted file mode 100644 index 06fc8973..00000000 --- a/docs/en/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/en/user/android.rst b/docs/en/user/android.rst deleted file mode 100644 index e286bb3b..00000000 --- a/docs/en/user/android.rst +++ /dev/null @@ -1,95 +0,0 @@ -Android application -=================== - -Purpose of this document ------------------------- - -This document describes how you can setup your Android application to work with your wallabag instance. There is no difference in this procedure for wallabag v1 or v2. - -Steps to configure your app ---------------------------- - -When you first start the app, you see the welcome screen, where you are adviced to configure the app for your wallabag instance at first. - -.. image:: ../../img/user/android_welcome_screen.en.png - :alt: Welcome screen - :align: center - -Just confirm that message and you get redirected to the settings screen. - -.. image:: ../../img/user/android_configuration_screen.en.png - :alt: Settings screen - :align: center - -Fill in your wallabag data. You need to enter your wallabag address. **It is important that this URL does not end with a slash**. Also add your wallabag credentials to the user name and password field. - -.. image:: ../../img/user/android_configuration_filled_in.en.png - :alt: Filled in settings - :align: center - -After you have filled in your data, push the button Connection test and wait for the test to finish. - -.. image:: ../../img/user/android_configuration_connection_test.en.png - :alt: Connection test with your wallabag data - :align: center - -The connection test should finish with success. If not, you need to fix this first until you proceed. - -.. image:: ../../img/user/android_configuration_connection_test_success.en.png - :alt: Connection test successful - :align: center - -After the connection test was successful, you can push the button to get your feed credentials. The app now tries to login to your wallabag instance and get the user id and the corresponding token for the feeds. - -.. image:: ../../img/user/android_configuration_get_feed_credentials.en.png - :alt: Getting the feed credentials - :align: center - -When the process of getting your feed credentials finishes with success you see a toast message that the user id and the token were automatically filled in to the form. - -.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png - :alt: Getting feed credentials successful - :align: center - -Now you need to scroll to the bottom of the settings menu. Of course you can adjust the given settings to your needs. Finish the configuration of your app with pushing the save button. - -.. image:: ../../img/user/android_configuration_scroll_bottom.en.png - :alt: Bottom of the settings screen - :align: center - -After hitting the save button, you get the following screen. The app proposes to initiate a synchronization process to update your feeds of articles. It is recommended to acknowledge this action and press Yes. - -.. image:: ../../img/user/android_configuration_saved_feed_update.en.png - :alt: Settings saved the first time - :align: center - -Finally after the synchronization finished successfully, you are presented to the list of unread articles. - -.. image:: ../../img/user/android_unread_feed_synced.en.png - :alt: Filled article list cause feeds successfully synchronized - :align: center - -Known limitations ------------------ - -Two factor authentication (2FA) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Currently the Android application does not support two-factor authentication. You should disable that to get the application working. - -Limited amount of articles with wallabag v2 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. - -SSL/TLS encryption -~~~~~~~~~~~~~~~~~~ - -If you can reach your wallabag web instance via HTTPS, you should use that. Especially if your HTTP URL redirects you to the HTTPS one. Currently, the app cannot handle that redirect properly. - -References ----------- - -- `Source code of the Android application `_ -- `Android Application on F-Droid `_ -- `Android Application on Google Play `_ diff --git a/docs/en/user/articles.rst b/docs/en/user/articles.rst deleted file mode 100644 index 862bba3e..00000000 --- a/docs/en/user/articles.rst +++ /dev/null @@ -1,117 +0,0 @@ -Articles -======== - -Save your first article ------------------------ - -The main purpose of wallabag is to save web articles. You have many ways to do it. If you think that the article is wrong displayed, `you can read this documentation `_. - -By using a bookmarklet -^^^^^^^^^^^^^^^^^^^^^^ - -On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` -link to your bookmarks bar of your browser. - -Now, each time you're reading an article on the web and you want to save it, -click on the ``bag it!`` link in your bookmarks bar. The article is saved. - -By using the classic form -^^^^^^^^^^^^^^^^^^^^^^^^^ - -In the top bar of your screen, you have 3 icons. With the first one, a plus sign, -you can easily save a new article. - -.. image:: ../../img/user/topbar.png - :alt: Top bar - :align: center - -Click on it to display a new field, paste the article URL inside and press your -``Return`` key. The article is saved. - -By using a browser add-on -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Firefox -""""""" - -You can download the `Firefox addon here `_. - -Chrome -"""""" - -You can download the `Chrome addon here `_. - -By using your smartphone application -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Android -""""""" - -You can download the `Android application here `_ or on `F-Droid `_. - -Windows Phone -""""""""""""" - -You can downlaod the `Windows Phone application here `_. - -Download your articles ----------------------- - -You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV. - -On the article view, click on this icon, in the sidebar: - -.. image:: ../../img/user/download_article.png - :alt: download article - :align: center - -You can also download a full category (unread, starred, archive) in these formats. -For example, on **Unread** view, click on this icon in the top bar: - -.. image:: ../../img/user/download_articles.png - :alt: download articles - :align: center - -Share your articles -------------------- - -When you're reading an article, you can share it. Just click on the share button: - -.. image:: ../../img/user/share.png - :alt: share article - :align: center - -Now, you can share the article: - -- with a public URL (you'll have a light view of the article) -- with a tweet -- into your Shaarli -- into your Scuttle -- with a post in Diaspora* -- to Carrot -- with an email - -Annotate your articles ----------------------- - -In each article you read, you can write annotations. It's easier to understand with some pictures. - -Select the part of the article that you want to annotate and click on the pencil: - -.. image:: ../../img/user/annotations_1.png - :alt: Select your text - :align: center - -Then, write your annotation: - -.. image:: ../../img/user/annotations_2.png - :alt: Write your annotation - :align: center - -The text is now highlighted and you can read your annotation if you move the mouse cursor over it. - -.. image:: ../../img/user/annotations_3.png - :alt: Read your annotation - :align: center - -You can create as many annotations as you wish. diff --git a/docs/en/user/backup.rst b/docs/en/user/backup.rst deleted file mode 100644 index f8b480a3..00000000 --- a/docs/en/user/backup.rst +++ /dev/null @@ -1,26 +0,0 @@ -Backup wallabag -=============== - -Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data. -This articles describes what you need to backup. - -Basic settings --------------- -wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`. - -Database --------- -As wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation. - -Here's some examples: - -- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html -- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html - -SQLite -~~~~~~ -To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory. - -Images ------- -The images retrieved by wallabag are stored under `web/assets/images` (the images storage will be implemented in wallabag 2.2). diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst deleted file mode 100644 index 0f3ac38f..00000000 --- a/docs/en/user/configuration.rst +++ /dev/null @@ -1,132 +0,0 @@ -Configuration -============= - -Now you're logged in, it's time to configure your account as you want. - -Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, -``User information``, ``Password`` and ``Tagging rules``. - -Settings --------- - -Theme -~~~~~ - -wallabag is customizable. You can choose your prefered theme here. The default theme is -``Material``, it's the theme used in the documentation screenshots. - -Items per page -~~~~~~~~~~~~~~ - -You can change the number of articles displayed on each page. - -Reading speed -~~~~~~~~~~~~~ - -wallabag calculates a reading time for each article. You can define here, thanks to this list, if you are -a fast or a slow reader. wallabag will recalculate the reading time for each article. - -Where do you want to be redirected after mark an article as read? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Each time you'll do some actions (after marking an article as read/favorite, -after deleting an article, after removing a tag from an entry), you can be redirected: - -- To the homepage -- To the current page - -Language -~~~~~~~~ - -You can change the language of wallabag interface. - -RSS ---- - -wallabag provides RSS feeds for each article status: unread, starred and archive. - -Firstly, you need to create a personal token: click on ``Create your token``. -It's possible to change your token by clicking on ``Reset your token``. - -Now you have three links, one for each status: add them into your favourite RSS reader. - -You can also define how many articles you want in each RSS feed (default value: 50). - -There is also a pagination available for these feeds. You can add ``?page=2`` to jump to the second page. -The pagination follow `the RFC `_ about that, which means you'll find the ``next``, ``previous`` & ``last`` page link inside the `` tag of each RSS feed. - -User information ----------------- - -You can change your name, your email address and enable ``Two factor authentication``. - -If the wallabag instance has more than one enabled user, you can delete your account here. **Take care, we delete all your data**. - -Two factor authentication (2FA) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Two-factor authentication (also known as 2FA) is a technology patented in 1984 - that provides identification of users by means of the combination of two different components. - - https://en.wikipedia.org/wiki/Two-factor_authentication - -**Warning**: enabling 2FA from the configuration interface is only possible if it has been authorized before in `app/config/parameters.yml` by setting the *twofactor_auth* property to `true` (do not forget to run `php bin/console cache:clear -e=prod` after modification). - -If you enable 2FA, each time you want to login to wallabag, you'll receive -a code by email. You have to put this code on the following form. - -.. image:: ../../img/user/2FA_form.png - :alt: Two factor authentication - :align: center - -If you don't want to receive a code each time you want to login, you can check -the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days. - -Password --------- - -You can change your password here (8 characters minimum). - -Tagging rules -------------- - -If you want to automatically assign a tag to new articles, this part -of the configuration is for you. - -What does « tagging rules » mean? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -They are rules used by wallabag to automatically tag new entries. -Each time a new entry is added, all the tagging rules will be used to add -the tags you configured, thus saving you the trouble to manually classify your entries. - -How do I use them? -~~~~~~~~~~~~~~~~~~ - -Let assume you want to tag new entries as *« short reading »* when -the reading time is inferior to 3 minutes. -In that case, you should put « readingTime <= 3 » in the **Rule** field -and *« short reading »* in the **Tags** field. -Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*. -Complex rules can be written by using predefined operators: -if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. - -Which variables and operators can I use to write rules? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``): - -=========== ============================================== ========== ========== -Variable Meaning Operator Meaning ------------ ---------------------------------------------- ---------- ---------- -title Title of the entry <= Less than… -url URL of the entry < Strictly less than… -isArchived Whether the entry is archived or not => Greater than… -isStarred Whether the entry is starred or not > Strictly greater than… -content The entry's content = Equal to… -language The entry's language != Not equal to… -mimetype The entry's mime-type OR One rule or another -readingTime The estimated entry's reading time, in minutes AND One rule and another -domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" - notmatches Tests that a subject is not matches a search (case-insensitive). Example: title notmatches "football" -=========== ============================================== ========== ========== diff --git a/docs/en/user/configuring_mobile.rst b/docs/en/user/configuring_mobile.rst deleted file mode 100644 index 7229aed6..00000000 --- a/docs/en/user/configuring_mobile.rst +++ /dev/null @@ -1,13 +0,0 @@ -Configuring mobile apps to work with wallabag -============================================= - -Steps to configure the app --------------------------- - -- First *create a new client* in the ``API clients management`` section. The name of your app doesn't matter as much as the ``Client ID`` and the ``Client secret``. Write these two values down. -- When you download a mobile app, it's going to ask for the server address of the hosted wallabag instance. For example, with wallabag.it that is: ``https://app.wallabag.it``. -- It's also going to ask for the aforementioned ``Client ID`` and ``secret``. Please insert those in the text fields, when asked. -- Lastly you need to provide your ``username`` and ``password``. These are the same credentials you use to login in to wallabag. - -Please also have a look at `Android `_ page. Especially the section on *known limitations*. - diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst deleted file mode 100644 index 8c43867d..00000000 --- a/docs/en/user/create_account.rst +++ /dev/null @@ -1,42 +0,0 @@ -Create an account and authentication -==================================== - -Register --------- - -On the login page, click on ``Register`` button. - -.. image:: ../../img/user/registration_form.png - :alt: Registration form - :align: center - -You have to fill the form. Please sure to type a valid email address, -we'll send you an activation email. - -.. image:: ../../img/user/sent_email.png - :alt: Email was sent to activate account - :align: center - -Check your inbox, you now have a new mail with a link like this -``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. -Click on it to activate your account. - -Your account is now activated. - -.. image:: ../../img/user/activated_account.png - :alt: Welcome on board! - :align: center - -Login ------ - -Your account is now enabled, congratulations! - -To login to wallabag, fill the form on login page. - -If you are on your personal computer and you want to stay connected, -you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year. - -.. image:: ../../img/user/login_form.png - :alt: Login form - :align: center diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst deleted file mode 100644 index c5e18d3b..00000000 --- a/docs/en/user/errors_during_fetching.rst +++ /dev/null @@ -1,37 +0,0 @@ -Errors during fetching articles -=============================== - -Why does the fetch of an article fail? --------------------------------------- - -There may be several reasons: - -- network problem -- wallabag can't fetch content due to the website structure - -How can I help to fix that? ---------------------------- - -You can try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ). - -You can try to see if it works here: `http://f43.me/feed/test `_ (it uses almost the same system as wallabag to retrieve content). - -If it works here and not on wallabag, it means there is something internally in wallabag that breaks the parser (hard to fix: please open an issue about it). - -If it doesn't works, try to extract a site config using: `http://siteconfig.fivefilters.org/ `_ (select which part of the content is actually the content). You can `read this documentation before `_. - -You can test it on **f43.me** website: click on **Want to try a custom siteconfig?** and put the generated file from siteconfig.fivefilters.org. - -Repeat until you have something ok. - -Then you can submit a pull request to `https://github.com/fivefilters/ftr-site-config `_ which is the global repo for siteconfig files. - -How can I try to re-fetch this article? ---------------------------------------- - -If wallabag failed when fetching an article, you can click on the reload button -(the third on the below picture). - -.. image:: ../../img/user/refetch.png - :alt: Refetch content - :align: center diff --git a/docs/en/user/faq.rst b/docs/en/user/faq.rst deleted file mode 100644 index 0f995ce5..00000000 --- a/docs/en/user/faq.rst +++ /dev/null @@ -1,55 +0,0 @@ -Frequently Asked Questions -========================== - -During the installation, I got the error ``Error Output: sh: 1: @post-cmd: not found`` --------------------------------------------------------------------------------------- - -It seems you have a problem with your ``composer`` installation. Try to uninstall and reinstall it. - -`Read the documentation about composer to know how to install it -`__. - -I can't validate the registration form --------------------------------------- - -Ensure that all fields are properly filled: - -* valid email address -* same passwords in two fields - -I'm not receiving my activation email -------------------------------------- - -Are you sure your email address was correct? Did you check your spam folder? - -If you still don't see the activation email, please ensure that you have -installed and properly configured a mail transfer agent. Be sure to include a -firewall rule for SMTP. E.g., if using firewalld: - -:: - - firewall-cmd --permanent --add-service=smtp - firewall-cmd --reload - -Lastly, if you have SELinux enabled, set the following rule: - -``setsebool -P httpd_can_sendmail 1`` - -When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. ----------------------------------------------------------------------------------------------------------------------------------- - -You already enabled your account or the URL of the activation email is wrong. - -I forgot my password --------------------- - -You can reset your password by clicking on ``Forgot your password?`` link, -on the login page. Then, fill the form with your email address or your username, -you'll receive an email to reset your password. - -I've got the ``failed to load external entity`` error when I try to install wallabag ------------------------------------------------------------------------------------- - -As described `here `_, please edit your ``web/app.php`` file and add this line: ``libxml_disable_entity_loader(false);`` on line 5. - -This is a Doctrine / PHP bug, nothing we can do about it. diff --git a/docs/en/user/filters.rst b/docs/en/user/filters.rst deleted file mode 100644 index aae8a749..00000000 --- a/docs/en/user/filters.rst +++ /dev/null @@ -1,54 +0,0 @@ -Retrieve your articles thanks to filters -======================================== - -To retrieve articles easily, you can use filters. -Click on the third icon in the top bar. - -.. image:: ../../img/user/topbar.png - :alt: Top bar - :align: center - -All these filters can be combined. - -.. image:: ../../img/user/filters.png - :alt: Combine all filters - :align: center - -Status ------- - -Use these checkboxes to find archived or starred articles. - -Preview picture ---------------- - -Check this filter if you want to retrieve articles with a preview picture. - -Language --------- - -wallabag (via graby) can detect article language. It's easy to you to retrieve articles -written in a specific language. - -HTTP status ------------ - -You can retrieve the articles by filtering by their HTTP status code: 200, 404, 500, etc. - -Reading time ------------- - -wallabag estimates how many time you need to read an article. With this filter, -you can for example find the articles with a reading time between 2 and 5 minutes. - -Domain name ------------ - -Thanks to this filter, you can retrieve the articles from the same domain name. -For example, in this field, type ``bbc.co.uk`` to retrieve the articles of this website. - -Creation date -------------- - -When you save an article, wallabag stored the current date. So handful to retrieve articles written -between 1st and 31th January for example. diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst deleted file mode 100644 index f6aaa373..00000000 --- a/docs/en/user/import.rst +++ /dev/null @@ -1,159 +0,0 @@ -Migrate from ... -================ - -In wallabag 2.x, you can import data from: - -- `Pocket <#id1>`_ -- `Readability <#id2>`_ -- `Instapaper <#id4>`_ -- `wallabag 1.x <#id6>`_ -- `wallabag 2.x <#id7>`_ - -We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_. - -Because imports can take ages, we developed an asynchronous tasks system. `You can read the documentation here `_ (for experts). - -Pocket ------- - -Create a new application on Pocket -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To import your data from Pocket, we use the Pocket API. You need to create -a new application on their developer website to continue. - -* Create a new application `on the developer website `_ -* Fill in the required fields: application name, application description, - permissions (only **retrieve**), platform (**web**), accept the terms of service - and submit your new application - -Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). -You need to configure the ``pocket_consumer_key`` in the ``Config`` menu. - -Now, all is fine to migrate from Pocket. - -Import your data into wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section -and then on ``Connect to Pocket and import data``. - -You need to authorize wallabag to interact with your Pocket account. -Your data will be imported. Data import can be a demanding process for your server. - -Readability ------------ - -Export your Readability data -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -On the tools (`https://www.readability.com/tools/ `_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). - -Import your data into wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Click on ``Import`` link in the menu, on ``Import contents`` in Readability section -and then select your json file and upload it. - -Your data will be imported. Data import can be a demanding process for your server. - -From Pinboard -------------- - -Export your Pinboard data -~~~~~~~~~~~~~~~~~~~~~~~~~ - -On the backup (`https://pinboard.in/settings/backup `_) page, click on "JSON" in the "Bookmarks" section. A JSON file will be downloaded (like ``pinboard_export``). - -Import your data into wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Click on ``Import`` link in the menu, on ``Import contents`` in Pinboard section -and then select your json file and upload it. - -Your data will be imported. Data import can be a demanding process for your server. - -From Instapaper ---------------- - -Export your Instapaper data -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -On the settings (`https://www.instapaper.com/user `_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). - -Import your data into wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Click on ``Import`` link in the menu, on ``Import contents`` in Instapaper section -and then select your CSV file and upload it. - -Your data will be imported. Data import can be a demanding process for your server. - -wallabag 1.x ------------- - -If you were using wallabag v1.x, you need to export your data before migrating to wallabag v2.x, because the application and its database changed a lot. In your old wallabag installation, you can export your data, which can be done on the Config page of your old wallabag installation. - -.. image:: ../../img/user/export_v1.png - :alt: Exporting from wallabag v1 - :align: center - -.. note:: - If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data. - -.. note:: - If you encounter issues during the export or the import, don't hesitate to `ask for support `__. - -When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure `__. - -After creating an user account on your new wallabag v2 instance, you must head over to the `Import` section and select `Import from wallabag v1`. Select your json file and upload it. - -.. image:: ../../img/user/import_wallabagv1.png - :alt: Import from wallabag v1 - :align: center - -wallabag 2.x ------------- - -From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json. - -.. image:: ../../img/user/export_v2.png - :alt: Export depuis wallabag v2 - :align: center - -From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. - -.. note:: - If you encounter issues during the export or the import, don't hesitate to `ask for support `__. - -Import via command-line interface (CLI) ---------------------------------------- - -If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export: - -:: - - bin/console wallabag:import username ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod - -Please replace values: - -* ``username`` is the user's username -* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export - -.. note:: - If you want to mark all these entries as read, you can add the ``--markAsRead`` option. - -.. note:: - To import a wallabag v2 file, you need to add the option ``--importer=v2``. - -.. note:: - If you want to pass the user id of the user instead of it's username, add the option ``--useUserId=true``. - -You'll have this in return: - -:: - - Start : 05-04-2016 11:36:07 --- - 403 imported - 0 already saved - End : 05-04-2016 11:36:09 --- diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst deleted file mode 100644 index f1146b49..00000000 --- a/docs/en/user/installation.rst +++ /dev/null @@ -1,365 +0,0 @@ -Install wallabag -================ - -Requirements ------------- - -wallabag is compatible with **PHP >= 5.6**, including PHP 7. - -.. note:: - - To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool. - -wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). - -Install Composer: - -:: - - curl -s https://getcomposer.org/installer | php - -You can find specific instructions `here `__. - -You'll also need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages. - -- php-session -- php-ctype -- 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 uses PDO to connect to the database, so you'll need one of the following: - -- pdo_mysql -- pdo_sqlite -- pdo_pgsql - -and its corresponding database server. - -Installation ------------- - -On a dedicated web server (recommended way) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To install wallabag itself, you must run the following commands: - -:: - - git clone https://github.com/wallabag/wallabag.git - cd wallabag && make install - -To start PHP's build-in server and test if everything did install correctly, you can do: - -:: - - make run - -And access wallabag at http://yourserverip:8000 - -.. tip:: - - To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look at `Symfony documentation `__. - -On a shared hosting -~~~~~~~~~~~~~~~~~~~ - -We provide a package with all dependencies inside. -The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``. - -We already created a user: login and password are ``wallabag``. - -.. caution:: With this package, wallabag doesn't check for mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above). - -Execute this command to download and extract the latest package: - -.. code-block:: bash - - wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -You will find the `md5 hash of the latest package on our website `_. - -Now, read the following documentation to create your virtual host, then access your wallabag. -If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. - -Installation with Docker -~~~~~~~~~~~~~~~~~~~~~~~~ - -We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub `__ for more information. - -Command to launch container -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: bash - - docker pull wallabag/wallabag - -Installation on Cloudron -~~~~~~~~~~~~~~~~~~~~~~~~ - -Cloudron provides an easy way to install webapps on your server with a focus on sysadmin automation and keeping apps updated. -wallabag is packaged as a Cloudron app and available to install directly from the store. - -`Install wallabag on your Cloudron `__ - -Virtual hosts -------------- - -Configuration on Apache -~~~~~~~~~~~~~~~~~~~~~~~ - -Do not forget to active the *rewrite* mod of Apache - -.. code-block:: bash - - a2enmod rewrite && systemctl reload apache2 - -Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for 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:: Note for Apache 2.4, in the section `` you have to replace the directives : - -:: - - AllowOverride None - Order Allow,Deny - Allow from All - - -by - -:: - - Require All granted - - -After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. - -Configuration on Nginx -~~~~~~~~~~~~~~~~~~~~~~ - -Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the recipe for 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; - } - -After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld. - -.. tip:: - - When you want to import large files into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. - -Configuration on lighttpd -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): - -:: - - 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", - ) - -Rights access to the folders of the project -------------------------------------------- - -Test environment -~~~~~~~~~~~~~~~~ - -When we just want to test wallabag, we just run the command ``make run`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. - -Production environment -~~~~~~~~~~~~~~~~~~~~~~ - -As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``make run`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. - -To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). - -So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project. - -This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command: - -.. code-block:: bash - - chown -R www-data:www-data /var/www/wallabag/var - -It has to be the same for the following folders - -* /var/www/wallabag/bin/ -* /var/www/wallabag/app/config/ -* /var/www/wallabag/vendor/ -* /var/www/wallabag/data/ - -by entering - -.. code-block:: bash - - chown -R www-data:www-data /var/www/wallabag/bin - chown -R www-data:www-data /var/www/wallabag/app/config - chown -R www-data:www-data /var/www/wallabag/vendor - chown -R www-data:www-data /var/www/wallabag/data/ - -otherwise, sooner or later you will see these error messages: - -.. 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 - -Additional rules for SELinux -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If SELinux is enabled on your system, you will need to configure additional contexts in order for wallabag to function properly. To check if SELinux is enabled, simply enter the following: - -``getenforce`` - -This will return ``Enforcing`` if SELinux is enabled. Creating a new context involves the following syntax: - -``semanage fcontext -a -t `` - -For example: - -``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"`` - -This will recursively apply the httpd_sys_content_t context to the wallabag directory and all underlying files and folders. The following rules are needed: - -+-----------------------------------+----------------------------+ -| Full path | Context | -+===================================+============================+ -| /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` | -+-----------------------------------+----------------------------+ -| /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` | -+-----------------------------------+----------------------------+ -| /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` | -+-----------------------------------+----------------------------+ -| /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` | -+-----------------------------------+----------------------------+ - -After creating these contexts, enter the following in order to apply your rules: - -``restorecon -R -v /var/www/wallabag`` - -You can check contexts in a directory by typing ``ls -lZ`` and you can see all of your current rules with ``semanage fcontext -l -C``. - -If you're installing the preconfigured latest-v2-package, then an additional rule is needed during the initial setup: - -``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"`` - -After you successfully access your wallabag and complete the initial setup, this context can be removed: - -:: - - semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var" - retorecon -R -v /var/www/wallabag/var diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst deleted file mode 100644 index d8a209e7..00000000 --- a/docs/en/user/parameters.rst +++ /dev/null @@ -1,96 +0,0 @@ -What is the meaning of the parameters? -====================================== - -Default `parameters.yml` file ------------------------------ - -Here is the last version of the default `app/config/parameters.yml` file. Be sure that yours respects this one. -If you don't know which value you need to set, please leave the default one. - -.. 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:: Database parameters - :header: "name", "default", "description" - - "database_driver", "pdo_sqlite", "Should be pdo_sqlite or pdo_mysql or pdo_pgsql" - "database_host", "127.0.0.1", "host of your database (usually localhost or 127.0.0.1)" - "database_port", "~", "port of your database (you can leave ``~`` to use the default one)" - "database_name", "symfony", "name of your database" - "database_user", "root", "user that can write to this database" - "database_password", "~", "password of that user" - "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty for other database" - "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" - "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)" - "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji" - -.. csv-table:: Configuration to send emails from wallabag - :header: "name", "default", "description" - - "mailer_transport", "smtp", "The exact transport method to use to deliver emails. Valid values are: smtp, gmail, mail, sendmail, null (which will disable the mailer)" - "mailer_host", "127.0.0.1", "The host to connect to when using smtp as the transport." - "mailer_user", "~", "The username when using smtp as the transport." - "mailer_password", "~", "The password when using smtp as the transport." - -.. csv-table:: Other wallabag's option - :header: "name", "default", "description" - - "locale", "en", "Default language of your wallabag instance (like en, fr, es, etc.)" - "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "This is a string that should be unique to your application and it's commonly used to add more entropy to security related operations." - "twofactor_auth", "true", "true to enable Two factor authentication" - "twofactor_sender", "no-reply@wallabag.org", "email of the email sender to receive the two factor code" - "fosuser_registration", "true", "true to enable public registration" - "fosuser_confirmation", "true", "true to send a confirmation by email for each registration" - "from_email", "no-reply@wallabag.org", "email address used in From: field in each email" - "rss_limit", "50", "limit for RSS feeds" - -.. csv-table:: RabbitMQ configuration - :header: "name", "default", "description" - - "rabbitmq_host", "localhost", "Host of your RabbitMQ" - "rabbitmq_port", "5672", "Port of your RabbitMQ" - "rabbitmq_user", "guest", "User that can read queues" - "rabbitmq_password", "guest", "Password of that user" - -.. csv-table:: Redis configuration - :header: "name", "default", "description" - - "redis_scheme", "tcp", "Specifies the protocol used to communicate with an instance of Redis. Valid values are: tcp, unix, http" - "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)" - "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)" - "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets" - "redis_password", "null", "Password defined in the Redis server configuration (parameter `requirepass` in `redis.conf`)" diff --git a/docs/en/user/query-upgrade-21-22.rst b/docs/en/user/query-upgrade-21-22.rst deleted file mode 100644 index fa9835a8..00000000 --- a/docs/en/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/en/user/tags.rst b/docs/en/user/tags.rst deleted file mode 100644 index 8ddc0f40..00000000 --- a/docs/en/user/tags.rst +++ /dev/null @@ -1,2 +0,0 @@ -Tags -==== \ No newline at end of file diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst deleted file mode 100644 index 3157684c..00000000 --- a/docs/en/user/upgrade.rst +++ /dev/null @@ -1,148 +0,0 @@ -================================== -Upgrade your wallabag installation -================================== - -You will find here different ways to upgrade your wallabag: - -- `from 2.1.x to 2.2.x <#upgrading-from-2-1-x-to-2-2-x>`_ -- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_ -- `from 1.x to 2.x <#from-wallabag-1-x>`_ - -***************************** -Upgrading from 2.1.x to 2.2.x -***************************** - -Upgrade on a dedicated web server -================================= - -**From 2.1.x:** - -:: - - make update - php bin/console doctrine:migrations:migrate --no-interaction -e=prod - -**From 2.2.0:** - -:: - - make update - -Explanations about database migrations --------------------------------------- - -During the update, we execute database migrations. - -All the database migrations are stored in ``app/DoctrineMigrations``. You can execute each migration individually: -``bin/console doctrine:migrations:execute 20161001072726 --env=prod``. - -You can also cancel each migration individually: ``bin/console doctrine:migrations:execute 20161001072726 --down --env=prod``. - -Here is the migrations list for 2.1.x to 2.2.0 release: - -* ``20161001072726``: added foreign keys for account resetting -* ``20161022134138``: converted database to ``utf8mb4`` encoding (for MySQL only) -* ``20161024212538``: added ``user_id`` column on ``oauth2_clients`` to prevent users to delete API clients from other users -* ``20161031132655``: added the internal setting to enable/disable downloading pictures -* ``20161104073720``: added ``created_at`` index on ``entry`` table -* ``20161106113822``: added ``action_mark_as_read`` field on ``config`` table -* ``20161117071626``: added the internal setting to share articles to unmark.it -* ``20161118134328``: added ``http_status`` field on ``entry`` table -* ``20161122144743``: added the internal setting to enable/disable fetching articles with paywall -* ``20161122203647``: dropped ``expired`` and ``credentials_expired`` fields on ``user`` table -* ``20161128084725``: added ``list_mode`` field on ``config`` table -* ``20161128131503``: dropped ``locked``, ``credentials_expire_at`` and ``expires_at`` fields on ``user`` table -* ``20161214094402``: renamed ``uuid`` to ``uid`` on ``entry`` table -* ``20161214094403``: added ``uid`` index on ``entry`` table -* ``20170127093841``: added ``is_starred`` and ``is_archived`` indexes on ``entry`` table - -Upgrade on a shared hosting -=========================== - -Backup your ``app/config/parameters.yml`` file. - -Download the last release of wallabag: - -.. code-block:: bash - - wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -You will find the `md5 hash of the latest package on our website `_. - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters `_. - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. - -You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_``. Don't forgete to backup your database before migrating. - -You may encounter issues with indexes names: if so, please change queries with the correct index name. - -`You can find all the queries here `_. - -*************************** -Upgrade from 2.0.x to 2.1.1 -*************************** - -.. warning:: - - Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. - -Upgrade on a dedicated web server -================================= - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Upgrade on a shared hosting -=========================== - -Backup your ``app/config/parameters.yml`` file. - -Download the 2.1.1 release of wallabag: - -.. code-block:: bash - - wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz - -(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters `_. - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. - -You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; - -***************** -From wallabag 1.x -***************** - -There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to: - -- export your data -- install wallabag 2.x (`read the installation documentation `_ ) -- import data in this fresh installation (`read the import documentation `_ ) -- cgit v1.2.3