-API DoKumentation
+API Dokumentation
=================
Dank dieser Dokumentation werden wir sehen, wie wir mit der wallabag API interagieren.
--- /dev/null
+Asynchrone Aufgaben
+===================
+
+Um große asynchrone Aufgaben zu starten (etwa für große Importe), können wir RabbitMQ oder Redis nutzen.
+
+Installation von RabbitMQ für asynchrone Aufgaben
+-------------------------------------------------
+
+Voraussetzungen
+^^^^^^^^^^^^^^^
+
+Du musst RabbitMQ auf deinem Server installiert haben.
+
+Installation
+^^^^^^^^^^^^
+
+.. code:: bash
+
+ wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
+ apt-key add rabbitmq-signing-key-public.asc
+ apt-get update
+ apt-get install rabbitmq-server
+
+Konfiguration und Start
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code:: bash
+
+ rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
+ rabbitmq-server -detached
+
+RabbitMQ stoppen
+^^^^^^^^^^^^^^^^
+
+.. code:: bash
+
+ rabbitmqctl stop
+
+RabbitMQ für wallabag konfigurieren
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Bearbeite deine ``app/config/parameters.yml``-Datei, um die RabbitMQ-Parameter zu ändern. Die Standardwerte sollten in Ordnung sein:
+
+.. code:: yaml
+
+ rabbitmq_host: localhost
+ rabbitmq_port: 5672
+ rabbitmq_user: guest
+ rabbitmq_password: guest
+
+RabbitMQ in wallabag aktivieren
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In den internen Einstellungen, aktiviere RabbitMQ im Import-Abschnitt mit dem Wert 1.
+
+Starte den RabbitMQ-Consumer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Abhängig davon, über welchen Service du importieren möchtest, musst du den entsprechenden (oder mehrere) Cronjob aktivieren:
+
+.. code:: bash
+
+ # für den Pocket-Import
+ bin/console rabbitmq:consumer -e=prod import_pocket -w
+
+ # für den Readability-Import
+ bin/console rabbitmq:consumer -e=prod import_readability -w
+
+ # für den Instapaper-Import
+ bin/console rabbitmq:consumer -e=prod import_instapaper -w
+
+ # für den wallabag v1-Import
+ bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
+
+ # für den wallabag v2-Import
+ bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
+
+ # für den Firefox-Import
+ bin/console rabbitmq:consumer -e=prod import_firefox -w
+
+ # für den Chrome-Import
+ bin/console rabbitmq:consumer -e=prod import_chrome -w
+
+Redis für asynchrone Aufgaben installieren
+------------------------------------------
+
+Um große asynchrone Aufgaben zu starten (etwa für große Importe), können wir auch Redis nutzen.
+
+Voraussetzungen
+^^^^^^^^^^^^^^^
+
+Du musst Redis auf deinem Server installiert haben.
+
+Installation
+^^^^^^^^^^^^
+
+.. code:: bash
+
+ apt-get install redis-server
+
+Start
+^^^^^
+
+Der Server kann bereits nach der Installation laufen, falls nicht, kannst du ihn wie folgt starten:
+
+.. code:: bash
+
+ redis-server
+
+
+Redis für wallabag konfigurieren
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Bearbeite deine ``app/config/parameters.yml``-Datei, um die Redis-Parameter zu ändern. Die Standardwerte sollten in Ordnung sein:
+
+.. code:: yaml
+
+ redis_host: localhost
+ redis_port: 6379
+
+Redis in wallabag aktivieren
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In den internen Einstellungen, aktiviere Redis im Import-Abschnitt mit dem Wert 1.
+
+Starten des Redis-Consumer
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Abhängig davon, über welchen Service du importieren möchtest, musst du den entsprechenden (oder mehrere) Cronjob aktivieren:
+
+.. code:: bash
+
+ # für den Pocket-Import
+ bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
+
+ # für den Readability-Import
+ bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
+
+ # für den Instapaper-Import
+ bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
+
+ # für den wallabag v1-Import
+ bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
+
+ # für den wallabag v2-Import
+ bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
+
+ # für den Firefox-Import
+ bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
+
+ # für den Chrome-Import
+ bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
+
+Wenn du den Import nur für einige Artikel nutzen willst, kannst du die Nummer festlegen (hier: 12) und der Consumer wird nach dem zwölften Artikel aufhören:
+
+.. code:: bash
+
+ bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
\ No newline at end of file
+++ /dev/null
-Installiere RabbitMQ für asynchrone Aufgaben
-============================================
-
-Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen.
-
-Voraussetzungen
----------------
-
-Du musst RabbitMQ auf deinem Server installiert haben.
-
-Installation
-~~~~~~~~~~~~
-
-.. code:: bash
-
- wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
- apt-key add rabbitmq-signing-key-public.asc
- apt-get update
- apt-get install rabbitmq-server
-
-Konfiguration und Starten
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. code:: bash
-
- rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
- rabbitmq-server -detached
-
-RabbitMQ stoppen
-~~~~~~~~~~~~~~~
-
-.. code:: bash
-
- rabbitmqctl stop
-
-
-Konfigure RabbitMQ in wallabag
-------------------------------
-
-Bearbeite die Datei ``app/config/parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein:
-
-.. code:: yaml
-
- rabbitmq_host: localhost
- rabbitmq_port: 5672
- rabbitmq_user: guest
- rabbitmq_password: guest
-
-Enable RabbitMQ in wallabag
----------------------------
-
-In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
-
-Starte den RabbitMQ Consumer
-----------------------------
-
-Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst):
-
-.. code:: bash
-
- # for Pocket import
- bin/console rabbitmq:consumer -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
-
+++ /dev/null
-Installiere Redis für asynchrone Aufgaben
-=========================================
-
-Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen.
-
-Voraussetzungen
----------------
-
-Du musst Redis auf deinem Server installiert haben.
-
-Installation
-~~~~~~~~~~~~
-
-.. code:: bash
-
- apt-get install redis-server
-
-Starten
-~~~~~~
-
-Der Redis Service läuft eventuell schon direkt nach der Installation. Falls nicht kannst du ihn wie folgt starten:
-
-.. code:: bash
-
- redis-server
-
-
-Konfigure Redis in wallabag
----------------------------
-
-Bearbeite die Datei ``app/config/parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein:
-
-.. 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).
-
-Starte den Redis Consumer
--------------------------
-
-Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst):
-
-.. code:: bash
-
- # for Pocket import
- bin/console wallabag:import:redis-worker -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
-
-Wenn du den Import nur für ein paar Nachrichten und nicht für alle starten willst, kannst du die Nummer (im folgenden Beispiel 12) angeben. Der Redis Worker wird dann nach der 12. Nachricht stoppen:
-
-.. code:: bash
-
- bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
**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`
: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:
developer/documentation
developer/translate
developer/maintenance
- developer/redis
- developer/rabbitmq
+ developer/asynchronous
:alt: Einstellungsbildschirm
:align: center
-Trage deine Wallabagdaten ein. Du musst deine Wallabagadresse eintragen. Es ist wichtig, dass die URL nicht mit einem Schrägstrich endet. Füge auch deine Wallabagzugangsdaten in das Nutzer- und Passwortfeld ein.
+Trage deine Wallabagdaten ein. Du musst deine Wallabagadresse eintragen. **Es ist wichtig, dass die URL nicht mit einem Schrägstrich endet.** Füge auch deine Wallabagzugangsdaten in das Nutzer- und Passwortfeld ein.
.. image:: ../../img/user/android_configuration_filled_in.de.png
:alt: Eingetragene Einstellungen
Bekannte Limitierungen
---------------------
-2FA
-~~~
+Zwei-Faktor-Authentifizierung (2FA)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Zur Zeit unterstützt die App keine Zwei-Faktor Authentifizierung. Du solltest sie deaktivieren damit die App funktioniert.
Referenzen
----------
-`Quellcode der Android Applikation <https://github.com/wallabag/android-app>`_
-
-`Android Applikation auf F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
-
-`Android Applikation auf Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
-
-`Support Chat auf English <https://gitter.im/wallabag/wallabag>`_
-
+- `Quellcode der Android-App <https://github.com/wallabag/android-app>`_
+- `Android-App auf F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
+- `Android-App auf Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
\ No newline at end of file
+++ /dev/null
-Anmerkungen
-===========
-
-In jedem Artikel, den du liest, kannst du Anmerkungen hinzufügen. Es ist einfacher mit ein paar Bilder erklärt.
-
-Wähle den Teil des Artikels aus, den du kommentieren willst und klicke auf den Bleistift:
-
-.. image:: ../../img/user/annotations_1.png
- :alt: Wähle den Text
- :align: center
-
-Schreibe deinen Kommentar:
-
-.. image:: ../../img/user/annotations_2.png
- :alt: Schreibe deinen Kommentar
- :align: center
-
-Der Text ist nun hervorgehoben und du kannst deine Anmerkung lesen, wenn du den Mauspfeil darüber fährst.
-
-.. image:: ../../img/user/annotations_3.png
- :alt: lese deine Anmerkung
- :align: center
-
-Du kannst so viele Anmerkungen erstellen wie du möchtest.
--- /dev/null
+Artikel
+=======
+
+Speichere deinen ersten Artikel
+-------------------------------
+
+Die Hauptzweck von wallabag ist es, Artikel aus dem Web zu speichern. Es gibt viele Wege, dieses Ziel zu erreichen.
+Wenn du denkst, dass ein Artikel falsch angezeigt wird, kannst du `diese Dokumentation lesen <http://doc.wallabag.org/de/master/user/errors_during_fetching.html>`_.
+
+Über ein Bookmarklet
+^^^^^^^^^^^^^^^^^^^^
+
+Auf der ``Howto``-Seite hast du einen ``Bookmarklet``-Tab. Ziehe das ``bag it!`` in die Lesezeichenleiste deines Browsers.
+Nun kannst du jedes Mal, wenn du einen Artikel speichern willst, auf den ``bag it!``-Link klicken, dann ist der Artikel gespeichert.
+
+Der klassische Weg
+^^^^^^^^^^^^^^^^^^
+
+In der oberen Leiste deines Fensters hast du auf der rechten Seite drei Symbole. Mit dem ersten Symbole, einem Plus-Zeichen, kannst du auf einfache Weise einen neuen Artikel speichern.
+
+.. image:: ../../img/user/topbar.png
+ :alt: Top bar
+ :align: center
+
+Klicke darauf, um ein neues Feld anzuzeigen, füge die Artikel-URL ein und drücke Enter. Dann wird der Artikel gespeichert.
+
+Über ein Browser-Addon
+^^^^^^^^^^^^^^^^^^^^^^
+
+Firefox
+"""""""
+
+Du kannst das `Firefox-Addon hier <https://addons.mozilla.org/firefox/addon/wallabag-v2/> herunterladen`_.
+
+Chrome
+""""""
+
+Du kannst das `Chrome-Addon hier <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr> herunterladen`_.
+
+Über das Smartphone
+^^^^^^^^^^^^^^^^^^^
+
+Android
+"""""""
+
+Du kannst die `Android-App hier <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche> herunterladen`_.
+
+Windows 10 in general
+"""""""""""""""""""""
+
+Du kannst die `Windows-App hier <https://www.microsoft.com/store/apps/9nblggh5x3p6> herunterladen`_.
+
+Artikel herunterladen
+---------------------
+
+Du kannst jeden Artikel in verschiedenen Formaten herunterladen: ePUB, MOBI, PDF, XML, JSON, CSV.
+
+Klicke in der Artikelansicht auf dieses Symbol in der Seitenleiste:
+
+.. image:: ../../img/user/download_article.png
+ :alt: Artikel herunterladen
+ :align: center
+
+Du kannst sogar eine ganze Kategorie (Ungelesen, Favoriten, Archiv) in diesen Formaten herunterladen:
+Beispielsweise kannst du auf der **Ungelesen**-Ansicht auf dieses Symbol in der oberen Leiste klicken:
+
+.. image:: ../../img/user/download_articles.png
+ :alt: Artikel herunterladen
+ :align: center
+
+Artikel teilen
+--------------
+
+Wenn du einen Artikel liest, kannst du ihn auch teilen. Klicke dazu einfach auf den Teilen-Button:
+
+.. image:: ../../img/user/share.png
+ :alt: Artikel teilen
+ :align: center
+
+Nun kannst du den Artikel teilen:
+
+- über eine öffentliche URL (es wird eine reduzierte Ansicht des Artikels zurückgegeben)
+- über einen Tweet
+- in deine Shaarli
+- mit einem Beitrag auf Diaspora*
+- an Carrot
+- mit einer E-Mail
+
+Artikel-Anmerkungen
+-------------------
+
+In jedem Artikel, den du liest, kannst du Anmerkungen hinzufügen. Es ist einfacher mit ein paar Bilder erklärt.
+
+Wähle den Teil des Artikels aus, den du kommentieren willst und klicke auf den Bleistift:
+
+.. image:: ../../img/user/annotations_1.png
+ :alt: Wähle den Text
+ :align: center
+
+Schreibe deinen Kommentar:
+
+.. image:: ../../img/user/annotations_2.png
+ :alt: Schreibe deinen Kommentar
+ :align: center
+
+Der Text ist nun hervorgehoben und du kannst deine Anmerkung lesen, wenn du den Mauspfeil darüber fährst.
+
+.. image:: ../../img/user/annotations_3.png
+ :alt: lese deine Anmerkung
+ :align: center
+
+Du kannst so viele Anmerkungen erstellen wie du möchtest.
Bilder
------
-Die Bilder, die von wallabag empfangen worden, sind unter `data/assets/images` gespeichert (der Bilder-Speicher wird in wallabag 2.2 implementiert).
+Die Bilder, die von wallabag empfangen worden, sind unter `web/assets/images` gespeichert (der Bilder-Speicher wird in wallabag 2.2 implementiert).
Du kannst deinen Namen ändern, deine E-Mail-Adresse und die Zwei-Faktor-Authentifizierung aktivieren.
-Zwei-Faktor-Authentifizierung
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Zwei-Faktor-Authentifizierung (2FA)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Die Zwei-Faktor-Authentifizierung (2FA) dient dem Identitätsnachweis eines Nutzers mittels der
Kombination zweier verschiedener und insbesondere unabhängiger Komponenten (Faktoren).
Account erstellen
=================
+Registrierungsformular
+----------------------
+
Klicke auf der Loginseite auf den ``Registrieren`` Button-
.. image:: ../../img/user/registration_form.png
.. image:: ../../img/user/activated_account.png
:alt: Willkommen!
:align: center
+
+Anmeldung
+---------
+
+Glückwunsch, dein Account ist nun aktiviert!
+Um dich auf wallabag anzumelden, fülle das Formular auf der Login-Seite aus.
+
+Wenn du auf einem persönlichen Computer bist und angemeldet bleiben möchtest,
+kannst du ein Häkchen nach ``angemeldet bleiben`` setzen, wallabag wird sich ein Jahr an dich erinnern.
+
+.. image:: ../../img/user/login_form.png
+ :alt: Login form
+ :align: center
\ No newline at end of file
+++ /dev/null
-Artikel herunterladen
-=====================
-
-Du kannst jeden Artikel in verschiedenen Formaten herunterladen: ePUB, MOBI, PDF, XML, JSON, CSV.
-
-In der Artikelansicht, klickst du auf dieses Icon in der Seitenleiste:
-
-.. image:: ../../img/user/download_article.png
- :alt: Artikel herunterladen
- :align: center
-
-Du kannst auch eine ganze Kategorie (ungelesen, Favoriten, Archiv) in diesen Formaten herunterladen.
-Zum Beispiel, in der Ansicht **Ungelesen**, klickst du auf das Icon in der oberen Leiste:
-
-.. image:: ../../img/user/download_articles.png
- :alt: Artikel herunterladen
- :align: center
+++ /dev/null
-Speichere deinen ersten Artikel
-===============================
-
-Der Hauptzweck von wallabag ist es Webartikel zu speichern. Du hast viele Wege das zu tun.
-
-.. note::
-
- Eine Schnellstartanleitung wird in der Anwendung angezeigt bis du deinen ersten
- Artikel gespeichert hast.
-
-Durch Nutzung eines Bookmarklets
---------------------------------
-
-Auf der ``How-To`` Seite, hast du einen Reiter ``Bookmarklet``. Ziehe und lasse den
-``bag it!`` Link in die Lesezeichenleiste deines Browser los.
-
-Jetzt kannst du immer wenn du einen Artikel im Web liest und ihn du ihn speichern
-willst, klicke auf den ``bag it!`` Link in deiner Lesezeichenleiste. Der Artikel
-wird gespeichert.
-
-Durch Nutzung des klassischen Formulars
----------------------------------------
-
-In der oberen Leiste auf deinem Bildschirm, hast du drei Icons. Mit dem ersten, einem
-Pluszeichen, kannst du einfach neue Artikel speichern.
-
-.. image:: ../../img/user/topbar.png
- :alt: obere Leiste
- :align: center
-
-Klick darauf, um ein neues Feld anzeigen zu lassen, füge deine Artikel URL ein und
-drücke die ``Enter`` Taste. Der Artikel wird gespeichert.
-
-Durch Nutzung eines Browser Add-ons
------------------------------------
-
-Firefox
-~~~~~~~
-
-*Dieses Addon ist noch nicht für wallbag v2 verfügbar*.
-
-Chrome
-~~~~~~
-
-*Dieses Addon ist noch nicht für wallbag v2 verfügbar*.
-
-Durch Nutzung deiner Smartphone App
------------------------------------
-
-Android
-~~~~~~~
-
-*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
-
-Firefox OS
-~~~~~~~~~~
-
-*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
-
-Windows Phone
-~~~~~~~~~~~~~
-
-*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
-
-iOS
-~~~
-
-*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
Migration von einem Drittanbieter
=================================
-Von Pocket
------------
+In wallabag 2.x kannst du Daten von folgenden Anbietern importieren:
+
+- Pocket <#id1>`_
+- Readability <#id2>`_
+- Instapaper <#id4>`_
+- wallabag 1.x <#id6>`_
+- wallabag 2.x <#id7>`_
+
+Wir haben zusätzlich `ein Skript für die Migration per Kommandozeile <#import-via-command-line-interface-cli>`_ geschrieben.
+
+Da Importe eine Menge Zeit in Anspruch nehmen können, haben wir auch ein asynchrones Aufgabensystem entwickelt. `Du kannst die Dokumentation hier lesen <http://doc.wallabag.org/de/master/developer/asynchronous.html>`_ (für Experten).
+
+Pocket
+------
Erstelle eine neue Applikation in Pocket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Importiere deine Daten in wallabag 2.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Klicke auf den ``Importieren`` Link im menü, auf ``Inhalte importieren`` in dem Pocketabschnitt und
+Klicke auf den ``Importieren`` Link im Menü, auf ``Inhalte importieren`` in dem Pocketabschnitt und
dann auf ``Verbinde mit Pocket und importieren Daten``.
Du musst wallabag erlauben, mit deinem Pocketaccount zu interagieren.
Deine Daten werden importiert. Datenimport kann ein sehr anspruchsvoller Prozess für deinen Server
sein (wir müssen daran arbeiten, um diesen Import zu verbessern).
-Von Instapaper
---------------
+Readability
+-----------
+
+Exportiere deine Readability-Daten
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Auf der Tools-Seite (`https://www.readability.com/tools/ <https://www.readability.com/tools/>`_), klicke auf "Daten exportieren" im "Daten-Export"-Abschnitt. Du wirst eine E-Mail mit einem Downloadlink zu einer JSON-Datei erhalten, welche zugegebenermaßen nicht mit .json endet.
+
+Importiere deine Daten in wallabag 2.x
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Klicke auf den ``Importieren``-Link im Menü, auf ``Inhalte importieren`` im Readability-Abschnitt und wähle dann deine JSON-Datei aus und lade sie hoch.
+
+Deine Daten werden dann importiert. Dies kann eine starke Belastung für den Server sein.
+
+Instapaper
+----------
+
+Exportiere deine Instapaper-Daten
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Klicke in den Einstellungen (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_) auf "CSV-Datei herunterladen" im Export-Abschnitt. Eine CSV-Datei mit dem Namen ``instapaper-export.csv`` wird heruntergeladen.
+
+Importiere deine Daten in wallabag 2.x
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Klicke auf den ``Importieren``-Link im Menü, auf ``Inhalte importieren`` im Instapaper-Abschnitt und wähle dann deine CSV-Datei aus und lade sie hoch.
+
+Deine Daten werden dann importiert. Dies kann eine starke Belastung für den Server sein.
+
+wallabag 1.x
+------------
+
+Wenn du in der Vergangenheit wallabag 1.x genutzt hast, musst du deine Daten exportieren, bevor du auf wallabag 2.x umsteigst, da sich viel an der Anwendung und der Datenbank geändert hast. In deiner alten wallabag-installation kannst du deine Daten exportieren, indem du die Konfigurationsseite auf der alten wallabag-Instanz öffnest.
+
+.. image:: ../../img/user/export_v1.png
+ :alt: Export aus wallabag 1.x
+ :align: center
+
+.. note::
+ Wenn du mehrere Accounts auf der gleichen wallabag-Instanz hast, muss jeder Nutzer seine Daten aus 1.x exportieren und in 2.x importieren.
+
+.. note::
+ Falls während des Exports oder des Imports Probleme auftreten sollten, scheue dich nicht, den `Support zu kontaktieren <https://www.wallabag.org/pages/support.html>`__.
+
+Wenn du dann die JSON-Datei mit deinen Einträgen heruntergeladen hast, kannst du `wallabag 2 über die Standard-Prozedur installieren <http://doc.wallabag.org/en/master/user/installation.html>`__.
+
+Nach dem Erstellen des Benutzeraccounts auf deiner neuen "wallabag 2.x"-Instanz, navigiere auf den Import-Bereich und wähle `Aus wallabag v1 importieren`. Wähle deine JSON-Datei und lade sie hoch.
+
+.. image:: ../../img/user/import_wallabagv1.png
+ :alt: Import aus wallabag v1
+ :align: center
+
+wallabag 2.x
+------------
+
+Gehe auf der alten wallabag-Instanz, die du vorher genutzt hast, auf `Alle Artikel` und exportiere diese dann als JSON.
+
+.. image:: ../../img/user/export_v2.png
+ :alt: Export aus wallabag v2
+ :align: center
+
+Nach dem Erstellen des Benutzeraccounts auf deiner neuen "wallabag 2.x"-Instanz, navigiere auf den Import-Bereich und wähle `Aus wallabag v2 importieren`. Wähle deine JSON-Datei und lade sie hoch.
+
+.. note::
+ Falls während des Exports oder des Imports Probleme auftreten sollten, scheue dich nicht, den `Support zu kontaktieren <https://www.wallabag.org/pages/support.html>`__.
+
+Import über die Kommandozeile (CLI)
+-----------------------------------
+
+Falls du auf deinem Server Zugriff auf die Kommandozeile hast, kannst du den folgenden Befehl ausführen, um deine Daten aus wallabag v1 zu importieren:
+
+::
+
+ bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
+
+Bitte ersetze die Werte:
+
+* ``1`` ist die Benutzer-ID in der Datenbank (die ID des ersten Benutzers ist immer 1)
+* ``~/Downloads/wallabag-export-1-2016-04-05.json`` ist der Pfad zu deiner wallabag v1-Exportdatei
-*Funktion noch nicht implementiert in wallabag v2.*
+Wenn du alle Artikel als gelesen markieren möchtest, kannst du die ``--markAsRead``-Option hinzufügen.
-Von Readability
----------------
+Um eine wallabag 2.x-Datei zu importieren, musst du die Option ``--importer=v2`` hinzufügen.
-*Funktion noch nicht implementiert in wallabag v2.*
+Als Ergebnis wirst du so etwas erhalten:
-Von einer HTML oder JSON Datei
-------------------------------
+::
-*Funktion noch nicht implementiert in wallabag v2.*
+ Start : 05-04-2016 11:36:07 ---
+ 403 imported
+ 0 already saved
+ End : 05-04-2016 11:36:09 ---
\ No newline at end of file
+++ /dev/null
-Login
-=====
-
-Dein Account ist nun aktiviert, Glückwünsch!
-
-Um dich bei wallabag einzuloggen, fülle das Formular auf der Loginseite aus.
-
-Wenn du an deinem persönlichen Computer arbeitest und verbunden bleiben willst,
-kannst du die Checkbox ``Angemeldet bleiben`` anhaken: wallabag wird sich für ein Jahr an deinen Login erinnern.
-
-.. image:: ../../img/user/login_form.png
- :alt: Loginformular
- :align: center
+++ /dev/null
-Migration von v1 oder v2
-========================
-
-Von wallabag 1.x
------------------
-
-Wenn du bisher wallabag v1.x genutzt hast, musst du deine Daten exportieren bevor du zu wallabag v2.x migrierst, weil die Applikation und ihre Datenbank sich stark geändert haben. In deiner alten wallabag Installation kannst du deine Daten auf der Konfigurationsseite exportieren.
-
-.. image:: ../../img/user/export_v1.png
- :alt: Export von wallabag v1
- :align: center
-
-.. note::
- Wenn du mehrere Accounts auf der gleichen Instanz von wallabag hast, muss jeder Nutzer von v1 exportieren und in v2 seine Daten importieren.
-
-.. note::
- Wenn du Probleme während des Exports oder Imports hast, scheue dich nicht davor `nach Hilfe zu fragen <https://www.wallabag.org/pages/support.html>`__.
-
-Wenn du eine JSON Datei mit deinen Artikeln erhalten hast, kannst du wallabag v2 installieren falls benötigt durch Befolgen `der Standardprozedur <http://doc.wallabag.org/en/master/user/installation.html>`__.
-
-Nachdem du einen Nutzerkonto auf deiner neuen wallabag v2 Instanz eingerichtet hast, kannst du zu dem Abschnitt `Import` springen und `Import von wallabag v1` auswählen. Wähle deine JSON Datei aus und lade sie hoch.
-
-.. image:: ../../img/user/import_wallabagv1.png
- :alt: Import von wallabag v1
- :align: center
-
-Import via command-line interface (CLI)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Wenn du CLI Zugang zu deinem Webserver hast, kannst du dieses Kommando ausführen, um deine Aritkel vom wallabag v1 Export zu importieren:
-
-::
-
- bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
-
-Bitte ersetze folgende Werte:
-
-* ``1`` ist die Nutzer ID in der Databank (Die ID von dem ersten erstellten Nutzer in wallabag ist 1)
-* ``~/Downloads/wallabag-export-1-2016-04-05.json`` ist der Pfad zu deinem wallabag v1 Export
-
-Du wirst eine solche Ausgabe erhalten:
-
-::
-
- Start : 05-04-2016 11:36:07 ---
- 403 imported
- 0 already saved
- End : 05-04-2016 11:36:09 ---
-
-Von wallabag 2.x
-----------------
-
-In der vorherigen wallabag Instanz, gehe zu `Alle Artikel` und exportiere diese Artikel als JSON.
-
-.. image:: ../../img/user/export_v2.png
- :alt: Export von wallabag v2
- :align: center
-
-In deiner neuen wallabag Instanz erstellst du ein Nutzerkonto und klickst auf den Link im Menü, um den Import fortzusetzen. Wähle Import von wallabag v2 aus und lade deine JSON Datei hoch.
-
-.. note::
- Wenn du Probleme während des Exports oder Imports hast, scheue dich nicht davor `nach Hilfe zu fragen <https://www.wallabag.org/pages/support.html>`__.
Was bedeuten die Parameter?
===========================
+
+Standardeinstellungen der `parameters.yml`
+------------------------------------------
+
+Dies ist die letzte standardisierte Version der `app/config/parameters.yml`-Datei. Stelle sicher, dass sich deine mit dieser ähnelt.
+Wenn du nicht weißt, welchen Wert du setzen sollst, belasse es bei dem Standardwert.
+
+.. 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
+
+Bedeutung von jedem Parameter
+-----------------------------
+
.. csv-table:: Datenbankparameter
:header: "Name", "Standardwert", "Beschreibung"
+++ /dev/null
-Wallabag von 2.0.x auf 2.1.1 updaten
-====================================
-
-.. warning::
-Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen.
-
-Update auf einem dedizierten Webserver
---------------------------------------
-
-Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag-Installation auf die neueste Version zu aktualisieren, führe die folgenden Kommandos in deinem wallabag-Ordner aus (ersetze ``2.1.1`` mit der neuesten Releasenummer):
-
-::
-
- rm -rf var/cache/*
- git fetch origin
- git fetch --tags
- git checkout 2.1.1 --force
- SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
- php bin/console doctrine:migrations:migrate --env=prod
- php bin/console cache:clear --env=prod
-
-Update auf einem Shared Webhosting
-----------------------------------
-
-Sichere deine ``app/config/parameters.yml`` Datei.
-
-Lade das neueste Release von wallabag herunter:
-
-.. code-block:: bash
-
- wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-
-(2.1.1 md5 Hashsumme: ``9584a3b60a2b2a4de87f536548caac93``)
-
-Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
-
-Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration):
-
-.. code-block:: 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
-
-Du kannst `hier eine Dokumentation über die Parameter finden <http://doc.wallabag.org/en/master/user/parameters.html>`_.
-
-Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren.
-
-Leere den ``var/cache`` Ordner.
-
-Du musst einige SQL-Abfragen ausführen, um die Datenbank zu aktualisieren. Wir nehmen in diesem Fall an, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank genutzt wird:
-
-.. code-block:: sql
-
- ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
- INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
- ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
- INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
- INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
- ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
- DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
+++ /dev/null
-Wallabag von 2.1.x auf 2.1.y updaten
-====================================
-
-Update auf einem dedizierten Webserver
---------------------------------------
-
-Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.3`` mit der neuesten Releasenummer):
-
-::
-
- make update
-
-Update auf einem Shared Webhosting
-----------------------------------
-
-Sichere deine ``app/config/parameters.yml`` Datei.
-
-Lade das neueste Release von wallabag herunter:
-
-.. code-block:: bash
-
- wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-
-Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website <https://www.wallabag.org/pages/download-wallabag.html>`_.
-
-Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
-
-Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren.
-
-Leere den ``var/cache`` Ordner.
--- /dev/null
+wallabag-Installation aktualisieren
+===================================
+
+Du wirst hier mehrere Wege finden, um deine wallabag zu aktualisieren:
+
+- `von 2.0.x zu 2.1.1 <#upgrade-von-2-0-x-zu-2-1-1>`_
+- `von 2.1.x zu 2.1.y <#upgrade-von-2-1-x-zu-2-1-y>`_
+- `von 1.x zu 2.x <#upgrade-von-1-x>`_
+
+Upgrade von 2.0.x zu 2.1.1
+---------------------------
+
+.. warning::
+
+ Mache eine Sicherung deines Pocket-Consumer-Key, falls hinzugefügt, da dieser nach dem Upgrade erneut hinzugefügt werden muss.
+
+Upgrade auf einem dedizierten Webserver
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+::
+
+ 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 auf einem Shared Hosting
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sichere deine ``app/config/parameters.yml``-Datei.
+
+Lade das 2.1.1-Release von wallabag herunter:
+
+.. 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``)
+
+Extrahiere das Archiv in deinen wallabag-Ordner und ersetze die ``app/config/parameters.yml`` mit deiner.
+
+Bitte überprüfe, dass deine ``app/config/parameters.yml`` alle notwendigen Parameter enthält. Eine Dokumentation darüber `findest du hier <http://doc.wallabag.org/de/master/user/parameters.html>`_.
+
+Falls du SQLite nutzt, musst du außerdem deinen ``data/``-Ordner in die neue Installation kopieren.
+
+Leere den ``var/cache``-Ordner.
+
+Du musst einige SQL-Abfragen durchführen, um deine Datenbank zu aktualisieren. Wir gehen in diesem Fall davon aus, dass das Tabellenpräfix ``wallabag_`` ist und eine MySQL-Datenbank verwendet wird:
+
+.. code-block:: sql
+
+ ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
+ INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
+ ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
+ INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
+ INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
+ ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
+ DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
+
+Upgrade von 2.1.x zu 2.1.y
+-----------------------------
+
+Upgrade auf einem dedizierten Webserver
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Um deine wallabag-Installation auf die letzte Version zu aktualisieren, führe den folgenden Befehl in deinem wallabag-Ordner aus:
+
+::
+
+ make update
+
+Upgrade auf einem Shared Hosting
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sichere deine ``app/config/parameters.yml``-Datei.
+
+Lade das letzte Release von wallabag herunter:
+
+.. code-block:: bash
+
+ wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+
+Du findest den `aktuellen MD5-Hash auf unserer Webseite <https://www.wallabag.org/pages/download-wallabag.html>`_.
+
+Extrahiere das Archiv in deinen wallabag-Ordner und ersetze die ``app/config/parameters.yml`` mit deiner.
+
+Bitte überprüfe, dass deine ``app/config/parameters.yml`` alle notwendigen Parameter enthält. Eine Dokumentation darüber `findest du hier <http://doc.wallabag.org/de/master/user/parameters.html>`_.
+
+Falls du SQLite nutzt, musst du außerdem deinen ``data/``-Ordner in die neue Installation kopieren.
+
+Leere den ``var/cache``-Ordner.
+
+Upgrade von 1.x
+---------------
+
+Es gibt kein automatisiertes Skript, um wallabag 1.x auf wallabag 2.x zu aktualisieren. Du musst:
+
+- deine Daten exportieren
+- wallabag 2.x installieren (Dokumentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
+- die Daten in die neue Installation importieren (`Dokumentation <http://doc.wallabag.org/en/master/user/import.html>`_ )
\ No newline at end of file
--- /dev/null
+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
+
+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 instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
+
+If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message :
+
+.. code:: bash
+
+ bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
+++ /dev/null
-Install RabbitMQ for asynchronous tasks
-=======================================
-
-In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ.
-
-Requirements
-------------
-
-You need to have RabbitMQ installed on your server.
-
-Installation
-~~~~~~~~~~~~
-
-.. code:: bash
-
- wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
- apt-key add rabbitmq-signing-key-public.asc
- apt-get update
- apt-get install rabbitmq-server
-
-Configuration and launch
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. code:: bash
-
- rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
- rabbitmq-server -detached
-
-Stop RabbitMQ
-~~~~~~~~~~~~~
-
-.. code:: bash
-
- rabbitmqctl stop
-
-
-Configure RabbitMQ in wallabag
-------------------------------
-
-Edit your ``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
-
-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
+++ /dev/null
-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 instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
-
-If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message :
-
-.. code:: bash
-
- bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
**wallabag** is a read-it-later application: it saves a web page by
keeping content only. Elements like navigation or ads are deleted.
-.. tip::
-
- This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__.
-
The main documentation for this application is organized into a couple sections:
* :ref:`user-docs`
The documentation is available in other languages:
* `Documentation en français <http://doc.wallabag.org/fr/master/>`_
-* `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_
+* `Dokumentation in Deutsch <http://doc.wallabag.org/de/master/>`_
.. _user-docs:
:maxdepth: 2
:caption: User documentation
- user/faq
user/installation
- user/upgrade-2.0.x-2.1.1
- user/upgrade-2.1.x-2.1.y
- 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:
developer/documentation
developer/translate
developer/maintenance
- developer/redis
- developer/rabbitmq
+ developer/asynchronous
-Android App
-===========
-
+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
---------------------------
: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
: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
:align: center
-
-
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.
-
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 <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>`_
+++ /dev/null
-Annotations
-===========
-
-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.
--- /dev/null
+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 <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_.
+
+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 <https://addons.mozilla.org/firefox/addon/wallabag-v2/>`_.
+
+Chrome
+""""""
+
+You can download the `Chrome addon here <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_.
+
+By using your smarphone application
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Android
+"""""""
+
+You can download the `Android application here <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_.
+
+Windows Phone
+"""""""""""""
+
+You can downlaod the `Windows Phone application here <https://www.microsoft.com/store/apps/9nblggh5x3p6>`_.
+
+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
+- 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.
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.
Images
------
-The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2).
+The images retrieved by wallabag are stored under `web/assets/images` (the images storage will be implemented in wallabag 2.2).
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.
-Create an account
-=================
+Create an account and authentication
+====================================
+
+Register
+--------
On the login page, click on ``Register`` button.
.. 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
+++ /dev/null
-Download 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
How can I help to fix that?
---------------------------
-You can `sending us an email with the article's URL <mailto:hello@wallabag.org>`_.
-
-Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ).
+You can try to 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 <http://f43.me/feed/test>`_ (it uses almost the same system as wallabag to retrieve content).
-Filters
-=======
+Retrieve your articles thanks to filters
+========================================
-To retrieve articles easier, you can use filters.
+To retrieve articles easily, you can use filters.
Click on the third icon in the top bar.
.. image:: ../../img/user/topbar.png
-Migrate from a third service
-============================
+Migrate from ...
+================
-From Pocket
------------
+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 <http://doc.wallabag.org/fr/master/developer/asynchronous.html>`_ (for experts).
+
+Pocket
+------
Create a new application on Pocket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
-From Readability
-----------------
+Readability
+-----------
Export your Readability data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Your data will be imported. Data import can be a demanding process for your server.
-From Instapaper
----------------
+Instapaper
+----------
Export your Instapaper data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Your data will be imported. Data import can be a demanding process for your server.
-From HTML or JSON file
-----------------------
+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 <https://www.wallabag.org/pages/support.html>`__.
+
+When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__.
+
+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 <https://www.wallabag.org/pages/support.html>`__.
+
+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 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
+
+Please replace values:
+
+* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
+* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
+
+If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
+
+To import a wallabag v2 file, you need to add the option ``--importer=v2``.
+
+You'll have this in return:
+
+::
-*Feature not yet implemented in wallabag v2.*
+ Start : 05-04-2016 11:36:07 ---
+ 403 imported
+ 0 already saved
+ End : 05-04-2016 11:36:09 ---
+++ /dev/null
-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
+++ /dev/null
-Migrate from v1 or v2
-=====================
-
-From 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 <https://www.wallabag.org/pages/support.html>`__.
-
-When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__.
-
-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
-
-From wallabag 2.x
------------------
-
-From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
-
-.. image:: ../../img/user/export_v2.png
- :alt: Export depuis wallabag v2
- :align: center
-
-From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it.
-
-.. note::
- If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
-
-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 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
-
-Please replace values:
-
-* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
-* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
-
-If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
-
-To import a wallabag v2 file, you need to add the option ``--importer=v2``.
-
-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 ---
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
+
+Meaning of each parameter
+-------------------------
+
.. csv-table:: Database parameters
:header: "name", "default", "description"
+++ /dev/null
-Upgrading from 2.1.x to 2.1.y
-=============================
-
-Upgrade on a dedicated web server
----------------------------------
-
-The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.3`` by the last release number):
-
-::
-
- make update
-
-Upgrade on a shared hosting
----------------------------
-
-Backup your ``app/config/parameters.yml`` file.
-
-Download the last release of wallabag:
-
-.. code-block:: bash
-
- wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-
-You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
-
-Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
-
-If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
-
-Empty ``var/cache`` folder.
+Upgrade your wallabag installation
+==================================
+
+You will find here different ways to upgrade your wallabag:
+
+- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
+- `from 2.1.x to 2.1.y <#upgrading-from-2-1-x-to-2-1-y>`_
+- `from 1.x to 2.x <#from-wallabag-1-x>`_
+
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
----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
php bin/console cache:clear --env=prod
Upgrade on a shared hosting
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
Backup your ``app/config/parameters.yml`` file.
-Download the last release of wallabag:
+Download the 2.1.1 release of wallabag:
.. code-block:: bash
Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
-Please check that your ``app/config/parameters.yml`` contains all the required parameters. Here is a default ``parameters.yml`` file. If you don't know which parameter you need to set, please leave the default one.
-
-.. code-block:: yml
-
- 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
-
-You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
+Please check that your ``app/config/parameters.yml`` contains all the required parameters. You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
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';
+
+Upgrading from 2.1.x to 2.1.y
+-----------------------------
+
+Upgrade on a dedicated web server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to upgrade your wallabag installation and get the last version, run the following command in you wallabag folder:
+
+::
+
+ make update
+
+Upgrade on a shared hosting
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Backup your ``app/config/parameters.yml`` file.
+
+Download the last release of wallabag:
+
+.. code-block:: bash
+
+ wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
+
+You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
+
+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 <http://doc.wallabag.org/en/master/user/parameters.html>`_.
+
+If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
+
+Empty ``var/cache`` folder.
+
+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 <http://doc.wallabag.org/en/master/user/installation.html>`_ )
+- import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )
--- /dev/null
+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
+++ /dev/null
-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
+++ /dev/null
-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
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`
: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:
developer/documentation
developer/translate
developer/maintenance
- developer/redis
- developer/rabbitmq
+ developer/asynchronous
--- /dev/null
+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>`_
+
+++ /dev/null
-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.
--- /dev/null
+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.
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).
+Se créer un compte et se connecter
+==================================
+
Se créer un compte
-==================
+------------------
Sur la page de connexion, cliquez sur le bouton ``Créer un compte``.
.. image:: ../../img/user/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
+++ /dev/null
-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
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).
-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.
+++ /dev/null
-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*.
-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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur.
+wallabag 1.x
+------------
+
+Si vous utilisiez wallabag v1.x, vous devez exporter vos données avant de migrer à wallabag v2.x, à cause du changement complet de l'application et de sa base de données. Sur votre ancienne instance de wallabag v1, vous pouvez exporter vos données en allant sur la page de configuration de l'application.
+
+.. image:: ../../img/user/export_v1.png
+ :alt: Export depuis wallabag v1
+ :align: center
+
+.. note::
+ Si vous avez plusieurs comptes sur la même instance de wallabag, chaque utilisateur doit exporter ses données depuis wallabag v1 et les importer dans la v2.
+
+.. note::
+ S'il vous arrive des problèmes durant l'export ou l'import, n'hésitez pas à `demander de l'aide <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 :
-Depuis un fichier HTML ou JSON
-------------------------------
+::
-*Fonctionnalité pas encore implémentée dans wallabag v2.*
+ Start : 05-04-2016 11:36:07 ---
+ 403 imported
+ 0 already saved
+ End : 05-04-2016 11:36:09 ---
\ No newline at end of file
+++ /dev/null
-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
+++ /dev/null
-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 ---
À 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"
+++ /dev/null
-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
+++ /dev/null
-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';
-
+++ /dev/null
-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``.
--- /dev/null
+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>`_ )
projects / github / wallabag / wallabag.git / commitdiff
