-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
: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
projects / github / wallabag / wallabag.git / commitdiff
