mirror of
https://github.com/wallabag/wallabag.git
synced 2024-12-23 08:06:33 +00:00
Reordered 🇫🇷 documentation
This commit is contained in:
Nicolas Lœuillet
Julian Oster
parent
2e389b0b90
commit
bb624c0269
27 changed files with 654 additions and 547 deletions
|
|
@ -8,10 +8,6 @@ wallabag Dokumentation
|
|||
**wallabag** ist eine Read-it-later Applikation: es speichert Websites,
|
||||
indem es nur den Inhalt behält. Elemente wie Navigation oder Werbung werden gelöscht.
|
||||
|
||||
.. tip::
|
||||
|
||||
Diese Dokumentation ist über wallabag v2. Wenn du die Dokumentation für wallabag v1 lesen willst, `siehe dir bitte das hier an <https://github.com/wallabag/documentation>`__.
|
||||
|
||||
Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organisiert:
|
||||
|
||||
* :ref:`user-docs`
|
||||
|
|
@ -28,24 +24,19 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
|
|||
:maxdepth: 2
|
||||
:caption: Nutzerdokumentation
|
||||
|
||||
user/faq
|
||||
user/installation
|
||||
user/upgrade-2.0.x-2.1.1
|
||||
user/upgrade-2.0.x-2.1.1
|
||||
user/migration
|
||||
user/upgrade
|
||||
user/configuration
|
||||
user/import
|
||||
user/create_account
|
||||
user/login
|
||||
user/configuration
|
||||
user/first_article
|
||||
user/articles
|
||||
user/errors_during_fetching
|
||||
user/annotations
|
||||
user/download_articles
|
||||
user/filters
|
||||
user/tags
|
||||
user/android
|
||||
user/parameters
|
||||
user/backup
|
||||
user/faq
|
||||
|
||||
.. _dev-docs:
|
||||
|
||||
|
|
@ -58,5 +49,4 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
|
|||
developer/documentation
|
||||
developer/translate
|
||||
developer/maintenance
|
||||
developer/redis
|
||||
developer/rabbitmq
|
||||
developer/asynchronous
|
||||
|
|
|
|||
|
|
@ -26,9 +26,9 @@ The documentation is available in other languages:
|
|||
|
||||
user/installation
|
||||
user/upgrade
|
||||
user/configuration
|
||||
user/import
|
||||
user/create_account
|
||||
user/configuration
|
||||
user/articles
|
||||
user/errors_during_fetching
|
||||
user/filters
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Just confirm that message and you get redirected to the settings screen.
|
|||
: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.
|
||||
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
|
||||
|
|
@ -57,13 +57,13 @@ Now you need to scroll to the bottom of the settings menu. Of course you can adj
|
|||
:alt: Bottom of the settings screen
|
||||
:align: center
|
||||
|
||||
After hitting the save button, you get the following screen. The app proposes to initiate a syncronisation process to update your feeds of articles. It is recommended to acknowledge this action and press Yes.
|
||||
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 synchronisation finished successfully, you are presented to the list of unread articles.
|
||||
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
|
||||
|
|
@ -72,8 +72,8 @@ Finally after the synchronisation finished successfully, you are presented to th
|
|||
Known limitations
|
||||
-----------------
|
||||
|
||||
2FA
|
||||
~~~
|
||||
Two factor authentication (2FA)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Currently the Android application does not support two-factor authentication. You should disable that to get the application working.
|
||||
|
||||
|
|
@ -90,11 +90,6 @@ If you can reach your wallabag web instance via HTTPS, you should use that. Espe
|
|||
References
|
||||
----------
|
||||
|
||||
`Source code of the Android application <https://github.com/wallabag/android-app>`_
|
||||
|
||||
`Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
|
||||
|
||||
`Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
|
||||
|
||||
`Support chat <https://gitter.im/wallabag/wallabag>`_
|
||||
|
||||
- `Source code of the Android application <https://github.com/wallabag/android-app>`_
|
||||
- `Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
|
||||
- `Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
|
||||
|
|
|
|||
|
|
@ -48,8 +48,8 @@ User information
|
|||
|
||||
You can change your name, your email address and enable ``Two factor authentication``.
|
||||
|
||||
Two factor authentication
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -5,12 +5,14 @@ In wallabag 2.x, you can import data from:
|
|||
|
||||
- `Pocket <#id1>`_
|
||||
- `Readability <#id2>`_
|
||||
- `Instapaper <#instapaper>`_
|
||||
- `wallabag 1.x <#wallabag-1-x>`_
|
||||
- `wallabag 2.x <#wallabag-2-x>`_
|
||||
- `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 <http://doc.wallabag.org/fr/master/developer/asynchronous.html>`_ (for experts).
|
||||
|
||||
Pocket
|
||||
------
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ 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 parameter you need to set, please leave the default one.
|
||||
If you don't know which value you need to set, please leave the default one.
|
||||
|
||||
.. code-block:: yml
|
||||
|
||||
|
|
|
|||
159
docs/fr/developer/asynchronous.rst
Normal file
159
docs/fr/developer/asynchronous.rst
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
Tâches asynchrones
|
||||
==================
|
||||
|
||||
Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ ou Redis.
|
||||
|
||||
Installer RabbitMQ pour des tâches asynchrones
|
||||
----------------------------------------------
|
||||
|
||||
Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ.
|
||||
|
||||
Pré-requis
|
||||
^^^^^^^^^^
|
||||
|
||||
Vous devez installer RabbitMQ sur votre serveur.
|
||||
|
||||
Installation
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. code:: bash
|
||||
|
||||
wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
|
||||
apt-key add rabbitmq-signing-key-public.asc
|
||||
apt-get update
|
||||
apt-get install rabbitmq-server
|
||||
|
||||
Configuration et démarrage
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code:: bash
|
||||
|
||||
rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
|
||||
rabbitmq-server -detached
|
||||
|
||||
Arrêter RabbitMQ
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code:: bash
|
||||
|
||||
rabbitmqctl stop
|
||||
|
||||
Configurer RabbitMQ dans wallabag
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir :
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
rabbitmq_host: localhost
|
||||
rabbitmq_port: 5672
|
||||
rabbitmq_user: guest
|
||||
rabbitmq_password: guest
|
||||
|
||||
Activer RabbitMQ dans wallabag
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1).
|
||||
|
||||
Démarrer les clients RabbitMQ
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# for Pocket import
|
||||
bin/console rabbitmq:consumer -e=prod import_pocket -w
|
||||
|
||||
# for Readability import
|
||||
bin/console rabbitmq:consumer -e=prod import_readability -w
|
||||
|
||||
# for Instapaper import
|
||||
bin/console rabbitmq:consumer -e=prod import_instapaper -w
|
||||
|
||||
# for wallabag v1 import
|
||||
bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
|
||||
|
||||
# for wallabag v2 import
|
||||
bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
|
||||
|
||||
# for Firefox import
|
||||
bin/console rabbitmq:consumer -e=prod import_firefox -w
|
||||
|
||||
# for Chrome import
|
||||
bin/console rabbitmq:consumer -e=prod import_chrome -w
|
||||
|
||||
Installer Redis pour des tâches asynchrones
|
||||
-------------------------------------------
|
||||
|
||||
Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis.
|
||||
|
||||
Pré-requis
|
||||
^^^^^^^^^^
|
||||
|
||||
Vous devez installer Redis sur votre serveur.
|
||||
|
||||
Installation
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. code:: bash
|
||||
|
||||
apt-get install redis-server
|
||||
|
||||
Démarrage
|
||||
^^^^^^^^^
|
||||
|
||||
Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas le cas, vous pouvez le démarrer ainsi :
|
||||
|
||||
.. code:: bash
|
||||
|
||||
redis-server
|
||||
|
||||
Configurer Redis dans wallabag
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir :
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
redis_host: localhost
|
||||
redis_port: 6379
|
||||
|
||||
Activer Redis dans wallabag
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1).
|
||||
|
||||
Démarrer les clients Redis
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# for Pocket import
|
||||
bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
|
||||
|
||||
# for Readability import
|
||||
bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
|
||||
|
||||
# for Instapaper import
|
||||
bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
|
||||
|
||||
# for wallabag v1 import
|
||||
bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
|
||||
|
||||
# for wallabag v2 import
|
||||
bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
|
||||
|
||||
# for Firefox import
|
||||
bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
|
||||
|
||||
# for Chrome import
|
||||
bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
|
||||
|
||||
Si vous souhaitez démarrer l'import pour quelques messages uniquement, vous pouvez spécifier cette valeur en paramètre (ici 12) et le client va s'arrêter après le 12ème message :
|
||||
|
||||
.. code:: bash
|
||||
|
||||
bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
|
||||
|
|
@ -1,80 +0,0 @@
|
|||
Installer RabbitMQ pour des tâches asynchrones
|
||||
==============================================
|
||||
|
||||
Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ.
|
||||
|
||||
Pré-requis
|
||||
----------
|
||||
|
||||
Vous devez installer RabbitMQ sur votre serveur.
|
||||
|
||||
Installation
|
||||
~~~~~~~~~~~~
|
||||
|
||||
.. code:: bash
|
||||
|
||||
wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
|
||||
apt-key add rabbitmq-signing-key-public.asc
|
||||
apt-get update
|
||||
apt-get install rabbitmq-server
|
||||
|
||||
Configuration et démarrage
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code:: bash
|
||||
|
||||
rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
|
||||
rabbitmq-server -detached
|
||||
|
||||
Arrêter RabbitMQ
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code:: bash
|
||||
|
||||
rabbitmqctl stop
|
||||
|
||||
|
||||
Configurer RabbitMQ dans wallabag
|
||||
---------------------------------
|
||||
|
||||
Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir :
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
rabbitmq_host: localhost
|
||||
rabbitmq_port: 5672
|
||||
rabbitmq_user: guest
|
||||
rabbitmq_password: guest
|
||||
|
||||
Activer RabbitMQ dans wallabag
|
||||
------------------------------
|
||||
|
||||
Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1).
|
||||
|
||||
Démarrer les clients RabbitMQ
|
||||
-----------------------------
|
||||
|
||||
En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# for Pocket import
|
||||
bin/console rabbitmq:consumer -e=prod import_pocket -w
|
||||
|
||||
# for Readability import
|
||||
bin/console rabbitmq:consumer -e=prod import_readability -w
|
||||
|
||||
# for Instapaper import
|
||||
bin/console rabbitmq:consumer -e=prod import_instapaper -w
|
||||
|
||||
# for wallabag v1 import
|
||||
bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
|
||||
|
||||
# for wallabag v2 import
|
||||
bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
|
||||
|
||||
# for Firefox import
|
||||
bin/console rabbitmq:consumer -e=prod import_firefox -w
|
||||
|
||||
# for Chrome import
|
||||
bin/console rabbitmq:consumer -e=prod import_chrome -w
|
||||
|
|
@ -1,75 +0,0 @@
|
|||
Installer Redis pour des tâches asynchrones
|
||||
===========================================
|
||||
|
||||
Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis.
|
||||
|
||||
Pré-requis
|
||||
----------
|
||||
|
||||
Vous devez installer Redis sur votre serveur.
|
||||
|
||||
Installation
|
||||
~~~~~~~~~~~~
|
||||
|
||||
.. code:: bash
|
||||
|
||||
apt-get install redis-server
|
||||
|
||||
Démarrage
|
||||
~~~~~~~~~
|
||||
|
||||
Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas le cas, vous pouvez le démarrer ainsi :
|
||||
|
||||
.. code:: bash
|
||||
|
||||
redis-server
|
||||
|
||||
|
||||
Configurer Redis dans wallabag
|
||||
-------------------------------
|
||||
|
||||
Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir :
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
redis_host: localhost
|
||||
redis_port: 6379
|
||||
|
||||
Activer Redis dans wallabag
|
||||
---------------------------
|
||||
|
||||
Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1).
|
||||
|
||||
Démarrer les clients Redis
|
||||
--------------------------
|
||||
|
||||
En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
|
||||
|
||||
.. code:: bash
|
||||
|
||||
# for Pocket import
|
||||
bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
|
||||
|
||||
# for Readability import
|
||||
bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
|
||||
|
||||
# for Instapaper import
|
||||
bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
|
||||
|
||||
# for wallabag v1 import
|
||||
bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
|
||||
|
||||
# for wallabag v2 import
|
||||
bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
|
||||
|
||||
# for Firefox import
|
||||
bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
|
||||
|
||||
# for Chrome import
|
||||
bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
|
||||
|
||||
Si vous souhaitez démarrer l'import pour quelques messages uniquement, vous pouvez spécifier cette valeur en paramètre (ici 12) et le client va s'arrêter après le 12ème message :
|
||||
|
||||
.. code:: bash
|
||||
|
||||
bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
|
||||
|
|
@ -9,10 +9,6 @@ Documentation de wallabag
|
|||
simplement d’archiver une page web en ne conservant que le contenu. Les
|
||||
éléments superflus (menu, publicité, etc.) sont supprimés.
|
||||
|
||||
.. tip::
|
||||
|
||||
Vous vous trouvez sur la documentation de wallabag v2. Si vous voulez lire la documentation de wallabag v1, `vous pouvez jeter un œil ici <https://github.com/wallabag/documentation>`__.
|
||||
|
||||
La documentation principale de cette application est découpée en plusieurs sections :
|
||||
|
||||
* :ref:`user-docs`
|
||||
|
|
@ -29,24 +25,19 @@ La documentation est disponible dans d'autres langues :
|
|||
:maxdepth: 2
|
||||
:caption: Documentation utilisateur
|
||||
|
||||
user/faq
|
||||
user/installation
|
||||
user/upgrade-2.0.x-2.1.1
|
||||
user/upgrade-2.0.x-2.1.1
|
||||
user/migration
|
||||
user/upgrade
|
||||
user/configuration
|
||||
user/import
|
||||
user/create_account
|
||||
user/login
|
||||
user/configuration
|
||||
user/first_article
|
||||
user/articles
|
||||
user/errors_during_fetching
|
||||
user/annotations
|
||||
user/download_articles
|
||||
user/share
|
||||
user/filters
|
||||
user/tags
|
||||
user/android
|
||||
user/parameters
|
||||
user/backup
|
||||
user/faq
|
||||
|
||||
.. _dev-docs:
|
||||
|
||||
|
|
@ -59,5 +50,4 @@ La documentation est disponible dans d'autres langues :
|
|||
developer/documentation
|
||||
developer/translate
|
||||
developer/maintenance
|
||||
developer/redis
|
||||
developer/rabbitmq
|
||||
developer/asynchronous
|
||||
|
|
|
|||
96
docs/fr/user/android.rst
Normal file
96
docs/fr/user/android.rst
Normal file
|
|
@ -0,0 +1,96 @@
|
|||
Application Android
|
||||
===================
|
||||
|
||||
But de ce document
|
||||
------------------
|
||||
|
||||
Ce document explique comment configurer votre application Android pour qu'elle fonctionne avec votre instance de wallabag. Il n'y a pas de différence dans cette procédure entre wallabag v1 et wallabag v2.
|
||||
|
||||
Étapes pour configurer votre application
|
||||
----------------------------------------
|
||||
|
||||
Quand vous démarrez l'application pour la première fois, vous voyez le message de bienvenue, où il vous est d'abord conseillé de configurer l'application avec votre instance de wallabag.
|
||||
|
||||
.. image:: ../../img/user/android_welcome_screen.en.png
|
||||
:alt: Écran de bienvenue
|
||||
:align: center
|
||||
|
||||
Vous devez confirmer le message et vous serez redirigé vers l'écran de configuration.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_screen.en.png
|
||||
:alt: Écran de configuration
|
||||
:align: center
|
||||
|
||||
Saisissez vos données wallabag. Vous devez entrer l'adresse de votre instance de wallabag. **Il ne faut pas que cette adresse se termine par un slash**. Ajoutez également vos identifiants wallabag dans les champs correspondants.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_filled_in.en.png
|
||||
:alt: Paramètres remplis
|
||||
:align: center
|
||||
|
||||
Après cet écran, appuyez sur le bouton de test de connexion et attendez que le test se termine.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_connection_test.en.png
|
||||
:alt: Test de connexion
|
||||
:align: center
|
||||
|
||||
Le test de connexion devrait se terminer avec succès. Si ce n'est pas le cas, vous devez résoudre ça avant de continuer.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_connection_test_success.en.png
|
||||
:alt: Test de connexion réussi
|
||||
:align: center
|
||||
|
||||
Après le test de connexion réussi, vous pouvez cliquer sur le bouton pour récupérer vos informations de flux (feed credentials). L'application essaie maintenant de se connecter à wallabag pour récupérer votre identifiant et votre jeton pour les flux RSS.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_get_feed_credentials.en.png
|
||||
:alt: Récupération des informations de flux
|
||||
:align: center
|
||||
|
||||
Quand le processus est terminé avec succès, vous verrez une notification comme quoi l'identifiant et le jeton ont été remplis correctement.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png
|
||||
:alt: Récupération des informations correcte
|
||||
:align: center
|
||||
|
||||
Maintenant, vous devez naviguer jusqu'en bas de l'écran des paramètres. Bien sur, vous pouvez régler les paramètres comme vous le souhaitez. Enregistrez la configuration.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_scroll_bottom.en.png
|
||||
:alt: Bottom of the settings screen
|
||||
:align: center
|
||||
|
||||
Après avoir enregistré les paramètres, vous vous retrouvez face à l'écran suivant. L'application vous propose de démarrer une synchronisation pour récupérer vos articles. Il est recommandé de confirmer cette action.
|
||||
|
||||
.. image:: ../../img/user/android_configuration_saved_feed_update.en.png
|
||||
:alt: Settings saved the first time
|
||||
:align: center
|
||||
|
||||
Une fois la synchronisation terminée avec succès, vous pouvez lire vos articles.
|
||||
|
||||
.. image:: ../../img/user/android_unread_feed_synced.en.png
|
||||
:alt: Filled article list cause feeds successfully synchronized
|
||||
:align: center
|
||||
|
||||
Limitations connues
|
||||
-------------------
|
||||
|
||||
Double authentification (2FA)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Actuellement, l'application Android ne supporte la double authentification. Vous devez la désactiver pour que l'application fonctionne correctement.
|
||||
|
||||
Limiter le nombre d'articles avec wallabag v2
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Dans votre instance de wallabag, vous pouvez configurer combien d'articles se trouvent dans les flux RSS. Cette option n'existe pas dans wallabag v1, où tous les articles se retrouvent donc dans le flux RSS. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed.
|
||||
|
||||
Cryptage SSL/TLS
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Si vous souhaitez accéder à votre instance de wallabag via HTTPS, vous devez le définir dans les paramètres. Surtout si votre URL HTTP redirige vers l'URL HTTPS. Actuellement, l'application ne gère pas cette redirection correctement.
|
||||
|
||||
Références
|
||||
----------
|
||||
|
||||
- `Code source de l'application Android <https://github.com/wallabag/android-app>`_
|
||||
- `Télécharger l'application Android sur F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
|
||||
- `Télécharger l'application Android sur Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
|
||||
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
Annotations
|
||||
===========
|
||||
|
||||
Sur chaque article que vous lisez, vous pouvez écrire des annotations. Puisqu'une image vaut mieux qu'un long discours,
|
||||
voici ce que ça donne.
|
||||
|
||||
Sélectionnez la zone du texte que vous souhaitez annoter et cliquez sur le crayon :
|
||||
|
||||
.. image:: ../../img/user/annotations_1.png
|
||||
:alt: Sélectionnez votre texte
|
||||
:align: center
|
||||
|
||||
Ensuite, écrivez votre annotation :
|
||||
|
||||
.. image:: ../../img/user/annotations_2.png
|
||||
:alt: Écrivez votre annotation
|
||||
:align: center
|
||||
|
||||
Le texte est maintenant surligné et vous pouvez lire le annotation en le survolant avec votre souris.
|
||||
|
||||
.. image:: ../../img/user/annotations_3.png
|
||||
:alt: Lisez votre annotation
|
||||
:align: center
|
||||
|
||||
Vous pouvez créer autant de annotations que vous le souhaitez.
|
||||
123
docs/fr/user/articles.rst
Normal file
123
docs/fr/user/articles.rst
Normal file
|
|
@ -0,0 +1,123 @@
|
|||
Articles
|
||||
========
|
||||
|
||||
Sauvegardez votre premier article
|
||||
---------------------------------
|
||||
|
||||
La fonctionnalité principale de wallabag est de sauvegarder des articles.
|
||||
Vous avez plusieurs manières de le faire.
|
||||
|
||||
.. note::
|
||||
|
||||
Un guide de démarrage s'affichera dans l'application jusqu'à ce que vous
|
||||
enregistriez votre premier article.
|
||||
|
||||
En utilisant le bookmarklet
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Sur la page ``Aide``, vous avez un onglet ``Bookmarklet``. Glissez/déposez le lien ``bag it!``
|
||||
dans votre barre de favoris de votre navigateur.
|
||||
|
||||
Maintennat, à chaque fois que vous lisez un article et que vous souhaitez le sauvegarder,
|
||||
cliquez sur le lien ``bag it!`` dans votre barre de favoris. L'article est enregistré.
|
||||
|
||||
En utilisant le formulaire classique
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icône,
|
||||
un signe plus, vous pouvez facilement ajouter un nouvel article.
|
||||
|
||||
.. image:: ../../img/user/topbar.png
|
||||
:alt: Barre supérieure
|
||||
:align: center
|
||||
|
||||
Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez
|
||||
sur la touche ``Entrée``. L'article est enregistré.
|
||||
|
||||
En utilisant l'extension de votre navigateur
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Firefox
|
||||
"""""""
|
||||
|
||||
Vous pouvez télécharger `l'extension Firefox ici <https://addons.mozilla.org/firefox/addon/wallabag-v2/>`_.
|
||||
|
||||
Chrome
|
||||
""""""
|
||||
|
||||
Vous pouvez télécharger `l'extension Chrome ici <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_.
|
||||
|
||||
En utilisant l'application de votre smartphone
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Android
|
||||
"""""""
|
||||
|
||||
Vous pouvez télécharger `l'application Android ici <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_.
|
||||
|
||||
Windows Phone
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Vous pouvez télécharger `l'application Windows Phone ici <https://www.microsoft.com/store/apps/9nblggh5x3p6>`_.
|
||||
|
||||
Téléchargez vos articles
|
||||
------------------------
|
||||
|
||||
Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PDF, XML, JSON, CSV.
|
||||
|
||||
Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale :
|
||||
|
||||
.. image:: ../../img/user/download_article.png
|
||||
:alt: Télécharger l'article
|
||||
:align: center
|
||||
|
||||
Vous pouvez aussi télécharger une catégorie (non lus, favoris, lus) dans ces formats.
|
||||
Par exemple, dans la vue **Non lus**, cliquez sur cette icône dans la barre supérieure :
|
||||
|
||||
.. image:: ../../img/user/download_articles.png
|
||||
:alt: Télécharger l'article
|
||||
:align: center
|
||||
|
||||
Partagez vos articles
|
||||
---------------------
|
||||
|
||||
Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage :
|
||||
|
||||
.. image:: ../../img/user/share.png
|
||||
:alt: partager un article
|
||||
:align: center
|
||||
|
||||
Vous pouvez maintenant le partager :
|
||||
|
||||
- avec une URL publique (vous obtiendrez une vue allégée de l'article)
|
||||
- avec un tweet
|
||||
- dans votre Shaarli
|
||||
- avec un message dans Diaspora*
|
||||
- sur Carrot
|
||||
- avec un email
|
||||
|
||||
Annotez vos articles
|
||||
--------------------
|
||||
|
||||
Sur chaque article que vous lisez, vous pouvez écrire des annotations. Puisqu'une image vaut mieux qu'un long discours,
|
||||
voici ce que ça donne.
|
||||
|
||||
Sélectionnez la zone du texte que vous souhaitez annoter et cliquez sur le crayon :
|
||||
|
||||
.. image:: ../../img/user/annotations_1.png
|
||||
:alt: Sélectionnez votre texte
|
||||
:align: center
|
||||
|
||||
Ensuite, écrivez votre annotation :
|
||||
|
||||
.. image:: ../../img/user/annotations_2.png
|
||||
:alt: Écrivez votre annotation
|
||||
:align: center
|
||||
|
||||
Le texte est maintenant surligné et vous pouvez lire le annotation en le survolant avec votre souris.
|
||||
|
||||
.. image:: ../../img/user/annotations_3.png
|
||||
:alt: Lisez votre annotation
|
||||
:align: center
|
||||
|
||||
Vous pouvez créer autant de annotations que vous le souhaitez.
|
||||
|
|
@ -23,4 +23,4 @@ Pour sauvegarder une base SQLite, vous devez juste copier le répertoire `data/d
|
|||
|
||||
Images
|
||||
------
|
||||
Les images sauvegardées par wallabag sont stockées dans `data/assets/images` (le stockage des images sera implémenté dans wallabag 2.2).
|
||||
Les images sauvegardées par wallabag sont stockées dans `web/assets/images` (le stockage des images sera implémenté dans wallabag 2.2).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
Se créer un compte et se connecter
|
||||
==================================
|
||||
|
||||
Se créer un compte
|
||||
==================
|
||||
------------------
|
||||
|
||||
Sur la page de connexion, cliquez sur le bouton ``Créer un compte``.
|
||||
|
||||
|
|
@ -23,3 +26,17 @@ Votre compte est maintenant actif.
|
|||
.. image:: ../../img/user/activated_account.png
|
||||
:alt: Bienvenue à bord !
|
||||
:align: center
|
||||
|
||||
Se connecter
|
||||
------------
|
||||
|
||||
Votre compte est maintenant actif, félicitations !
|
||||
|
||||
Pour vous connecter à wallabag, remplissez le formulaire de connexion.
|
||||
|
||||
Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connecté
|
||||
vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an.
|
||||
|
||||
.. image:: ../../img/user/login_form.png
|
||||
:alt: Formulaire de connexion
|
||||
:align: center
|
||||
|
|
|
|||
|
|
@ -1,17 +0,0 @@
|
|||
Télécharger des articles
|
||||
========================
|
||||
|
||||
Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PDF, XML, JSON, CSV.
|
||||
|
||||
Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale :
|
||||
|
||||
.. image:: ../../img/user/download_article.png
|
||||
:alt: Télécharger l'article
|
||||
:align: center
|
||||
|
||||
Vous pouvez aussi télécharger une catégorie (non lus, favoris, lus) dans ces formats.
|
||||
Par exemple, dans la vue **Non lus**, cliquez sur cette icône dans la barre supérieure :
|
||||
|
||||
.. image:: ../../img/user/download_articles.png
|
||||
:alt: Télécharger l'article
|
||||
:align: center
|
||||
|
|
@ -12,9 +12,7 @@ Il peut y avoir plusieurs raisons :
|
|||
Comment puis-je aider pour réparer ça ?
|
||||
---------------------------------------
|
||||
|
||||
Vous pouvez `nous envoyer un email avec l'URL de l'article <mailto:hello@wallabag.org>`_.
|
||||
|
||||
Ou vous pouvez aussi essayer de résoudre ce problème vous même (comme ça, nous restons concentrés pour améliorer wallabag au lieu d'écrire ces fichiers de configuration :) ).
|
||||
Vous pouvez essayer de résoudre ce problème vous même (comme ça, nous restons concentrés pour améliorer wallabag au lieu d'écrire ces fichiers de configuration :) ).
|
||||
|
||||
Vous pouvez essayer de voir si ça fonctionne ici : `http://f43.me/feed/test <http://f43.me/feed/test>`_ (ce site utilise principalement la même manière de fonctionner que wallabag pour récupérer les articles).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
Filtres
|
||||
=======
|
||||
Retrouver des articles grâce aux filtres
|
||||
========================================
|
||||
|
||||
Pour retrouver plus facilement vos articles, vous pouvez utiliser les filtres.
|
||||
Cliquez sur la troisième icône de la barre supérieure.
|
||||
|
|
|
|||
|
|
@ -1,68 +0,0 @@
|
|||
Sauvegardez votre premier article
|
||||
=================================
|
||||
|
||||
La fonctionnalité principale de wallabag est de sauvegarder des articles.
|
||||
Vous avez plusieurs manières de le faire.
|
||||
|
||||
.. note::
|
||||
|
||||
Un guide de démarrage s'affichera dans l'application jusqu'à ce que vous
|
||||
enregistriez votre premier article.
|
||||
|
||||
En utilisant le bookmarklet
|
||||
---------------------------
|
||||
|
||||
Sur la page ``Aide``, vous avez un onglet ``Bookmarklet``. Glissez/déposez le lien ``bag it!``
|
||||
dans votre barre de favoris de votre navigateur.
|
||||
|
||||
Maintennat, à chaque fois que vous lisez un article et que vous souhaitez le sauvegarder,
|
||||
cliquez sur le lien ``bag it!`` dans votre barre de favoris. L'article est enregistré.
|
||||
|
||||
En utilisant le formulaire classique
|
||||
------------------------------------
|
||||
|
||||
Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icône,
|
||||
un signe plus, vous pouvez facilement ajouter un nouvel article.
|
||||
|
||||
.. image:: ../../img/user/topbar.png
|
||||
:alt: Barre supérieure
|
||||
:align: center
|
||||
|
||||
Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez
|
||||
sur la touche ``Entrée``. L'article est enregistré.
|
||||
|
||||
En utilisant l'extension de votre navigateur
|
||||
--------------------------------------------
|
||||
|
||||
Firefox
|
||||
~~~~~~~
|
||||
|
||||
*Cette extension n'est pas encore disponible pour wallabag v2*.
|
||||
|
||||
Chrome
|
||||
~~~~~~
|
||||
|
||||
*Cette extension n'est pas encore disponible pour wallabag v2*.
|
||||
|
||||
En utilisant l'application de votre smartphone
|
||||
----------------------------------------------
|
||||
|
||||
Android
|
||||
~~~~~~~
|
||||
|
||||
*Cette application n'est pas encore disponible pour wallabag v2*.
|
||||
|
||||
Firefox OS
|
||||
~~~~~~~~~~
|
||||
|
||||
*Cette application n'est pas encore disponible pour wallabag v2*.
|
||||
|
||||
Windows Phone
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
*Cette application n'est pas encore disponible pour wallabag v2*.
|
||||
|
||||
iOS
|
||||
~~~
|
||||
|
||||
*Cette application n'est pas encore disponible pour wallabag v2*.
|
||||
|
|
@ -1,8 +1,20 @@
|
|||
Migrer depuis un service externe
|
||||
================================
|
||||
Migrer depuis ...
|
||||
=================
|
||||
|
||||
Depuis Pocket
|
||||
-------------
|
||||
Dans wallabag 2.x, vous pouvez importer des données depuis :
|
||||
|
||||
- `Pocket <#id1>`_
|
||||
- `Readability <#id2>`_
|
||||
- `Instapaper <#id4>`_
|
||||
- `wallabag 1.x <#id6>`_
|
||||
- `wallabag 2.x <#id7>`_
|
||||
|
||||
Nous avons aussi développé `un script pour exécuter des migrations via la ligne de commande <#import-via-la-ligne-de-commande-cli>`_.
|
||||
|
||||
Puisque les imports peuvent gourmands en ressource, nous avons mis en place un système de tâche asynchrone. `Vous trouverez la documentation ici <http://doc.wallabag.org/fr/master/developer/asynchronous.html>`_ (niveau expert).
|
||||
|
||||
Pocket
|
||||
------
|
||||
|
||||
Créer une nouvelle application dans Pocket
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -30,8 +42,8 @@ Vous devez autoriser wallabag à se connecter à votre compte Pocket.
|
|||
Vos données vont être importées. L'import de données est une action qui peut être couteuse
|
||||
pour votre serveur.
|
||||
|
||||
Depuis Readability
|
||||
------------------
|
||||
Readability
|
||||
-----------
|
||||
|
||||
Exportez vos données de Readability
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -46,8 +58,8 @@ la section Readability et ensuite sélectionnez votre fichier json pour l'upload
|
|||
|
||||
Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur.
|
||||
|
||||
Depuis Instapaper
|
||||
-----------------
|
||||
Instapaper
|
||||
----------
|
||||
|
||||
Exportez vos données de Instapaper
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -62,8 +74,66 @@ la section Instapaper et ensuite sélectionnez votre fichier CSV pour l'uploader
|
|||
|
||||
Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur.
|
||||
|
||||
wallabag 1.x
|
||||
------------
|
||||
|
||||
Depuis un fichier HTML ou JSON
|
||||
------------------------------
|
||||
Si vous utilisiez wallabag v1.x, vous devez exporter vos données avant de migrer à wallabag v2.x, à cause du changement complet de l'application et de sa base de données. Sur votre ancienne instance de wallabag v1, vous pouvez exporter vos données en allant sur la page de configuration de l'application.
|
||||
|
||||
*Fonctionnalité pas encore implémentée dans wallabag v2.*
|
||||
.. image:: ../../img/user/export_v1.png
|
||||
:alt: Export depuis wallabag v1
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
Si vous avez plusieurs comptes sur la même instance de wallabag, chaque utilisateur doit exporter ses données depuis wallabag v1 et les importer dans la v2.
|
||||
|
||||
.. note::
|
||||
S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <https://www.wallabag.org/pages/support.html>`_.
|
||||
|
||||
Une fois que vous avez récupéré le fichier json contenant vos données, vous pouvez installer wallabag v2 si c'est nécessaire en suivant `la procédure standard <http://doc.wallabag.org/fr/master/user/installation.html>`_.
|
||||
|
||||
Une fois que vous avez créé un compte utilisateur sur votre nouvelle instance de wallabag v2, rendez-vous dans la section `Import`. Vous devez choisir l'import depuis wallabag v1 puis sélectionner votre fichier json récupéré précédemment.
|
||||
|
||||
.. image:: ../../img/user/import_wallabagv1.png
|
||||
:alt: Import depuis wallabag v1
|
||||
:align: center
|
||||
|
||||
wallabag 2.x
|
||||
------------
|
||||
|
||||
Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json.
|
||||
|
||||
.. image:: ../../img/user/export_v2.png
|
||||
:alt: Export depuis wallabag v2
|
||||
:align: center
|
||||
|
||||
Depuis votre nouvelle instance de wallabag, créez votre compte utilisateur puis cliquez sur le lien dans le menu pour accéder à l'import. Choisissez l'import depuis wallabag v2 puis sélectionnez votre fichier json pour l'uploader.
|
||||
|
||||
.. note::
|
||||
S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <https://www.wallabag.org/pages/support.html>`_.
|
||||
|
||||
Import via la ligne de commande (CLI)
|
||||
-------------------------------------<http://doc.wallabag.org/en/master/user/parameters.html
|
||||
|
||||
Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 :
|
||||
|
||||
::
|
||||
|
||||
bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
|
||||
|
||||
Remplacez les valeurs :
|
||||
|
||||
* ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1)
|
||||
* ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1
|
||||
|
||||
Si vous voulez marquer tous ces articles comme lus, vous pouvez ajouter l'option ``--markAsRead``.
|
||||
|
||||
Pour importer un fichier wallabag v2, vous devez ajouter l'option ``--importer=v2``.
|
||||
|
||||
Vous obtiendrez :
|
||||
|
||||
::
|
||||
|
||||
Start : 05-04-2016 11:36:07 ---
|
||||
403 imported
|
||||
0 already saved
|
||||
End : 05-04-2016 11:36:09 ---
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
Se connecter
|
||||
============
|
||||
|
||||
Votre compte est maintenant actif, félicitations !
|
||||
|
||||
Pour vous connecter à wallabag, remplissez le formulaire de connexion.
|
||||
|
||||
Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connecté
|
||||
vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an.
|
||||
|
||||
.. image:: ../../img/user/login_form.png
|
||||
:alt: Formulaire de connexion
|
||||
:align: center
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
Migrer depuis la v1 ou la v2
|
||||
============================
|
||||
|
||||
Depuis wallabag 1.x
|
||||
-------------------
|
||||
|
||||
Si vous utilisiez wallabag v1.x, vous devez exporter vos données avant de migrer à wallabag v2.x, à cause du changement complet de l'application et de sa base de données. Sur votre ancienne instance de wallabag v1, vous pouvez exporter vos données en allant sur la page de configuration de l'application.
|
||||
|
||||
.. image:: ../../img/user/export_v1.png
|
||||
:alt: Export depuis wallabag v1
|
||||
:align: center
|
||||
|
||||
.. note::
|
||||
Si vous avez plusieurs comptes sur la même instance de wallabag, chaque utilisateur doit exporter ses données depuis wallabag v1 et les importer dans la v2.
|
||||
|
||||
.. note::
|
||||
S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <https://www.wallabag.org/pages/support.html>`__.
|
||||
|
||||
Une fois que vous avez récupéré le fichier json contenant vos données, vous pouvez installer wallabag v2 si c'est nécessaire en suivant `la procédure standard <http://doc.wallabag.org/fr/master/user/installation.html>`__.
|
||||
|
||||
Une fois que vous avez créé un compte utilisateur sur votre nouvelle instance de wallabag v2, rendez-vous dans la section `Import`. Vous devez choisir l'import depuis wallabag v1 puis sélectionner votre fichier json récupéré précédemment.
|
||||
|
||||
.. image:: ../../img/user/import_wallabagv1.png
|
||||
:alt: Import depuis wallabag v1
|
||||
:align: center
|
||||
|
||||
Depuis wallabag 2.x
|
||||
-------------------
|
||||
|
||||
Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json.
|
||||
|
||||
.. image:: ../../img/user/export_v2.png
|
||||
:alt: Export depuis wallabag v2
|
||||
:align: center
|
||||
|
||||
Depuis votre nouvelle instance de wallabag, créez votre compte utilisateur puis cliquez sur le lien dans le menu pour accéder à l'import. Choisissez l'import depuis wallabag v2 puis sélectionnez votre fichier json pour l'uploader.
|
||||
|
||||
.. note::
|
||||
S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <https://www.wallabag.org/pages/support.html>`__.
|
||||
|
||||
Import via la ligne de commande (CLI)
|
||||
-------------------------------------
|
||||
|
||||
Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 :
|
||||
|
||||
::
|
||||
|
||||
bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
|
||||
|
||||
Remplacez les valeurs :
|
||||
|
||||
* ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1)
|
||||
* ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1
|
||||
|
||||
Si vous voulez marquer tous ces articles comme lus, vous pouvez ajouter l'option ``--markAsRead``.
|
||||
|
||||
Pour importer un fichier wallabag v2, vous devez ajouter l'option ``--importer=v2``.
|
||||
|
||||
Vous obtiendrez :
|
||||
|
||||
::
|
||||
|
||||
Start : 05-04-2016 11:36:07 ---
|
||||
403 imported
|
||||
0 already saved
|
||||
End : 05-04-2016 11:36:09 ---
|
||||
|
|
@ -1,5 +1,48 @@
|
|||
À quoi servent les paramètres ?
|
||||
===============================
|
||||
|
||||
Fichier `parameters.yml` par défaut
|
||||
-----------------------------------
|
||||
|
||||
Voici la dernière version par défaut du fichier `app/config/parameters.yml`. Soyez sur que le votre respecte celui-ci.
|
||||
Si vous ne savez pas quelle valeur vous devez mettre, laissez celle par défaut.
|
||||
|
||||
.. code-block:: yml
|
||||
|
||||
parameters:
|
||||
database_driver: pdo_sqlite
|
||||
database_host: 127.0.0.1
|
||||
database_port: null
|
||||
database_name: symfony
|
||||
database_user: root
|
||||
database_password: null
|
||||
database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
|
||||
database_table_prefix: wallabag_
|
||||
database_socket: null
|
||||
mailer_transport: smtp
|
||||
mailer_host: 127.0.0.1
|
||||
mailer_user: null
|
||||
mailer_password: null
|
||||
locale: en
|
||||
secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
|
||||
twofactor_auth: true
|
||||
twofactor_sender: no-reply@wallabag.org
|
||||
fosuser_registration: true
|
||||
fosuser_confirmation: true
|
||||
from_email: no-reply@wallabag.org
|
||||
rss_limit: 50
|
||||
rabbitmq_host: localhost
|
||||
rabbitmq_port: 5672
|
||||
rabbitmq_user: guest
|
||||
rabbitmq_password: guest
|
||||
redis_scheme: tcp
|
||||
redis_host: localhost
|
||||
redis_port: 6379
|
||||
redis_path: null
|
||||
|
||||
Meaning of each parameter
|
||||
-------------------------
|
||||
|
||||
.. csv-table:: Paramètres de base de données
|
||||
:header: "name", "default", "description"
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +0,0 @@
|
|||
Partager des articles
|
||||
=====================
|
||||
|
||||
Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage :
|
||||
|
||||
.. image:: ../../img/user/share.png
|
||||
:alt: partager un article
|
||||
:align: center
|
||||
|
||||
Vous pouvez maintenant le partager :
|
||||
|
||||
- avec une URL publique (vous obtiendrez une vue allégée de l'article)
|
||||
- avec un tweet
|
||||
- dans votre Shaarli
|
||||
- avec un message dans Diaspora*
|
||||
- sur Carrot
|
||||
- avec un email
|
||||
|
|
@ -1,87 +0,0 @@
|
|||
Mettre à jour de la 2.0.x à la 2.1.1
|
||||
====================================
|
||||
|
||||
.. warning::
|
||||
Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajoutant votre consumer key dans les paramètres internes, pensez à effectuer une sauvegarde de celle-ci : vous devrez l'ajouter dans la configuration de wallabag après la mise à jour.
|
||||
|
||||
Mise à jour sur un serveur dédié
|
||||
--------------------------------
|
||||
|
||||
::
|
||||
|
||||
rm -rf var/cache/*
|
||||
git fetch origin
|
||||
git fetch --tags
|
||||
git checkout 2.1.1 --force
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console doctrine:migrations:migrate --env=prod
|
||||
php bin/console cache:clear --env=prod
|
||||
|
||||
Mise à jour sur un hébergement mutualisé
|
||||
----------------------------------------
|
||||
|
||||
Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
|
||||
|
||||
Téléchargez la dernière version de wallabag :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
|
||||
|
||||
(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``)
|
||||
|
||||
Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
|
||||
|
||||
Vérifiez que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. Voici un fichier ``parameters.yml`` par défaut. Si vous ne savez pas quelle valeur mettre à un paramètre, laissez la valeur par défaut.
|
||||
|
||||
.. code-block:: yml
|
||||
|
||||
parameters:
|
||||
database_driver: pdo_sqlite
|
||||
database_host: 127.0.0.1
|
||||
database_port: null
|
||||
database_name: symfony
|
||||
database_user: root
|
||||
database_password: null
|
||||
database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
|
||||
database_table_prefix: wallabag_
|
||||
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
|
||||
|
||||
Vous trouverez `ici une documentation détaillée concernant les paramètres <http://doc.wallabag.org/fr/master/user/parameters.html>`_.
|
||||
|
||||
Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
|
||||
|
||||
Videz le répertoire ``var/cache``.
|
||||
|
||||
Vous allez devoir également exécuter des requêtes SQL pour mettre à jour votre base de données. Nous partons du principe que le préfixe de vos tables est ``wallabag_`` et que le serveur SQL est un serveur MySQL :
|
||||
|
||||
.. code-block:: sql
|
||||
|
||||
ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
|
||||
INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
|
||||
ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
|
||||
INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
|
||||
INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
|
||||
ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
|
||||
DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
|
||||
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
Mettre à jour de la 2.1.x à la 2.1.y
|
||||
====================================
|
||||
|
||||
Mise à jour sur un serveur dédié
|
||||
--------------------------------
|
||||
|
||||
La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.3`` par le numéro de la dernière version) :
|
||||
|
||||
::
|
||||
|
||||
make update
|
||||
|
||||
Mise à jour sur un hébergement mutualisé
|
||||
----------------------------------------
|
||||
|
||||
Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
|
||||
|
||||
Téléchargez la dernière version de wallabag :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
|
||||
|
||||
Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
|
||||
|
||||
Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
|
||||
|
||||
Videz le répertoire ``var/cache``.
|
||||
102
docs/fr/user/upgrade.rst
Normal file
102
docs/fr/user/upgrade.rst
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
Mettre à jour votre installation de wallabag
|
||||
============================================
|
||||
|
||||
Vous trouverez ici différentes manières de mettre à jour wallabag :
|
||||
|
||||
- `de la 2.0.x à la 2.1.1 <#mettre-a-jour-de-la-2-0-x-a-la-2-1-1>`_
|
||||
- `de la 2.1.x à la 2.1.y <#mettre-a-jour-de-la-2-1-x-a-la-2-1-y>`_
|
||||
- `de la 1.x à la 2.x <#depuis-wallabag-1-x>`_
|
||||
|
||||
Mettre à jour de la 2.0.x à la 2.1.1
|
||||
------------------------------------
|
||||
|
||||
.. warning::
|
||||
Avant cette migration, si vous aviez configuré l'import depuis Pocket en ajoutant votre consumer key dans les paramètres internes, pensez à effectuer une sauvegarde de celle-ci : vous devrez l'ajouter dans la configuration de wallabag après la mise à jour.
|
||||
|
||||
Mise à jour sur un serveur dédié
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
::
|
||||
|
||||
rm -rf var/cache/*
|
||||
git fetch origin
|
||||
git fetch --tags
|
||||
git checkout 2.1.1 --force
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console doctrine:migrations:migrate --env=prod
|
||||
php bin/console cache:clear --env=prod
|
||||
|
||||
Mise à jour sur un hébergement mutualisé
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
|
||||
|
||||
Téléchargez la version 2.1.1 de wallabag :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
|
||||
|
||||
(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``)
|
||||
|
||||
Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
|
||||
|
||||
Merci de vérifier que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. Vous trouverez `ici une documentation détaillée concernant les paramètres <http://doc.wallabag.org/fr/master/user/parameters.html>`_.
|
||||
|
||||
Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
|
||||
|
||||
Videz le répertoire ``var/cache``.
|
||||
|
||||
Vous allez devoir également exécuter des requêtes SQL pour mettre à jour votre base de données. Nous partons du principe que le préfixe de vos tables est ``wallabag_`` et que le serveur SQL est un serveur MySQL :
|
||||
|
||||
.. code-block:: sql
|
||||
|
||||
ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
|
||||
INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
|
||||
ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
|
||||
INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
|
||||
INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
|
||||
ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
|
||||
DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
|
||||
|
||||
Mettre à jour de la 2.1.x à la 2.1.y
|
||||
------------------------------------
|
||||
|
||||
Mise à jour sur un serveur dédié
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Pour mettre à jour votre installation de wallabag et récupérer la dernière version, exécutez la commande suivante dans votre répertoire d'installation :
|
||||
|
||||
::
|
||||
|
||||
make update
|
||||
|
||||
Mise à jour sur un hébergement mutualisé
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
|
||||
|
||||
Téléchargez la dernière version de wallabag :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
|
||||
|
||||
Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
|
||||
|
||||
Merci de vérifier que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. Vous trouverez `ici une documentation détaillée concernant les paramètres <http://doc.wallabag.org/fr/master/user/parameters.html>`_.
|
||||
|
||||
Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
|
||||
|
||||
Videz le répertoire ``var/cache``.
|
||||
|
||||
Depuis wallabag 1.x
|
||||
-------------------
|
||||
|
||||
Il n'y a pas de script automatique pour mettre à jour wallabag 1.x en wallabag 2.x. Vous devez :
|
||||
|
||||
- exportez vos données
|
||||
- installer wallabag 2.x (`lisez la documentation d'installation <http://doc.wallabag.org/fr/master/user/installation.html>`_ )
|
||||
- importer vos données dans votre installation toute propre (`lisez la documentation d'import <http://doc.wallabag.org/fr/master/user/import.html>`_ )
|
||||
Loading…
Reference in a new issue