aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
Diffstat
-rw-r--r--docs/de/developer/api.rst2
-rw-r--r--docs/de/developer/asynchronous.rst158
-rw-r--r--docs/de/developer/rabbitmq.rst81
-rw-r--r--docs/de/developer/redis.rst75
-rw-r--r--docs/de/index.rst20
-rw-r--r--docs/de/user/android.rst17
-rw-r--r--docs/de/user/annotations.rst24
-rw-r--r--docs/de/user/articles.rst112
-rw-r--r--docs/de/user/backup.rst2
-rw-r--r--docs/de/user/configuration.rst4
-rw-r--r--docs/de/user/create_account.rst16
-rw-r--r--docs/de/user/download_articles.rst17
-rw-r--r--docs/de/user/first_article.rst68
-rw-r--r--docs/de/user/import.rst115
-rw-r--r--docs/de/user/login.rst13
-rw-r--r--docs/de/user/migration.rst62
-rw-r--r--docs/de/user/parameters.rst43
-rw-r--r--docs/de/user/upgrade-2.0.x-2.1.1.rst88
-rw-r--r--docs/de/user/upgrade-2.1.x-2.1.y.rst30
-rw-r--r--docs/de/user/upgrade.rst103
-rw-r--r--docs/en/developer/asynchronous.rst159
-rw-r--r--docs/en/developer/rabbitmq.rst80
-rw-r--r--docs/en/developer/redis.rst75
-rw-r--r--docs/en/index.rst23
-rw-r--r--docs/en/user/android.rst32
-rw-r--r--docs/en/user/annotations.rst24
-rw-r--r--docs/en/user/articles.rst116
-rw-r--r--docs/en/user/backup.rst3
-rw-r--r--docs/en/user/configuration.rst4
-rw-r--r--docs/en/user/create_account.rst21
-rw-r--r--docs/en/user/download_articles.rst17
-rw-r--r--docs/en/user/errors_during_fetching.rst4
-rw-r--r--docs/en/user/filters.rst6
-rw-r--r--docs/en/user/import.rst93
-rw-r--r--docs/en/user/login.rst13
-rw-r--r--docs/en/user/migration.rst66
-rw-r--r--docs/en/user/parameters.rst43
-rw-r--r--docs/en/user/upgrade-2.1.x-2.1.y.rst30
-rw-r--r--docs/en/user/upgrade.rst (renamed from docs/en/user/upgrade-2.0.x-2.1.1.rst)96
-rw-r--r--docs/fr/developer/asynchronous.rst159
-rw-r--r--docs/fr/developer/rabbitmq.rst80
-rw-r--r--docs/fr/developer/redis.rst75
-rw-r--r--docs/fr/index.rst22
-rw-r--r--docs/fr/user/android.rst96
-rw-r--r--docs/fr/user/annotations.rst25
-rw-r--r--docs/fr/user/articles.rst123
-rw-r--r--docs/fr/user/backup.rst2
-rw-r--r--docs/fr/user/create_account.rst19
-rw-r--r--docs/fr/user/download_articles.rst17
-rw-r--r--docs/fr/user/errors_during_fetching.rst4
-rw-r--r--docs/fr/user/filters.rst4
-rw-r--r--docs/fr/user/first_article.rst68
-rw-r--r--docs/fr/user/import.rst92
-rw-r--r--docs/fr/user/login.rst13
-rw-r--r--docs/fr/user/migration.rst66
-rw-r--r--docs/fr/user/parameters.rst43
-rw-r--r--docs/fr/user/share.rst17
-rw-r--r--docs/fr/user/upgrade-2.0.x-2.1.1.rst87
-rw-r--r--docs/fr/user/upgrade-2.1.x-2.1.y.rst30
-rw-r--r--docs/fr/user/upgrade.rst102
60 files changed, 1681 insertions, 1418 deletions
diff --git a/docs/de/developer/api.rst b/docs/de/developer/api.rst
index bb21154d..9d230e31 100644
--- a/docs/de/developer/api.rst
+++ b/docs/de/developer/api.rst
@@ -1,4 +1,4 @@
1API DoKumentation 1API Dokumentation
2================= 2=================
3 3
4Dank dieser Dokumentation werden wir sehen, wie wir mit der wallabag API interagieren. 4Dank dieser Dokumentation werden wir sehen, wie wir mit der wallabag API interagieren.
diff --git a/docs/de/developer/asynchronous.rst b/docs/de/developer/asynchronous.rst
new file mode 100644
index 00000000..1d241a72
--- /dev/null
+++ b/docs/de/developer/asynchronous.rst
@@ -0,0 +1,158 @@
1Asynchrone Aufgaben
2===================
3
4Um große asynchrone Aufgaben zu starten (etwa für große Importe), können wir RabbitMQ oder Redis nutzen.
5
6Installation von RabbitMQ für asynchrone Aufgaben
7-------------------------------------------------
8
9Voraussetzungen
10^^^^^^^^^^^^^^^
11
12Du musst RabbitMQ auf deinem Server installiert haben.
13
14Installation
15^^^^^^^^^^^^
16
17.. code:: bash
18
19 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
20 apt-key add rabbitmq-signing-key-public.asc
21 apt-get update
22 apt-get install rabbitmq-server
23
24Konfiguration und Start
25^^^^^^^^^^^^^^^^^^^^^^^
26
27.. code:: bash
28
29 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
30 rabbitmq-server -detached
31
32RabbitMQ stoppen
33^^^^^^^^^^^^^^^^
34
35.. code:: bash
36
37 rabbitmqctl stop
38
39RabbitMQ für wallabag konfigurieren
40^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
41
42Bearbeite deine ``app/config/parameters.yml``-Datei, um die RabbitMQ-Parameter zu ändern. Die Standardwerte sollten in Ordnung sein:
43
44.. code:: yaml
45
46 rabbitmq_host: localhost
47 rabbitmq_port: 5672
48 rabbitmq_user: guest
49 rabbitmq_password: guest
50
51RabbitMQ in wallabag aktivieren
52^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
53
54In den internen Einstellungen, aktiviere RabbitMQ im Import-Abschnitt mit dem Wert 1.
55
56Starte den RabbitMQ-Consumer
57^^^^^^^^^^^^^^^^^^^^^^^^^^^^
58
59Abhängig davon, über welchen Service du importieren möchtest, musst du den entsprechenden (oder mehrere) Cronjob aktivieren:
60
61.. code:: bash
62
63 # für den Pocket-Import
64 bin/console rabbitmq:consumer -e=prod import_pocket -w
65
66 # für den Readability-Import
67 bin/console rabbitmq:consumer -e=prod import_readability -w
68
69 # für den Instapaper-Import
70 bin/console rabbitmq:consumer -e=prod import_instapaper -w
71
72 # für den wallabag v1-Import
73 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
74
75 # für den wallabag v2-Import
76 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
77
78 # für den Firefox-Import
79 bin/console rabbitmq:consumer -e=prod import_firefox -w
80
81 # für den Chrome-Import
82 bin/console rabbitmq:consumer -e=prod import_chrome -w
83
84Redis für asynchrone Aufgaben installieren
85------------------------------------------
86
87Um große asynchrone Aufgaben zu starten (etwa für große Importe), können wir auch Redis nutzen.
88
89Voraussetzungen
90^^^^^^^^^^^^^^^
91
92Du musst Redis auf deinem Server installiert haben.
93
94Installation
95^^^^^^^^^^^^
96
97.. code:: bash
98
99 apt-get install redis-server
100
101Start
102^^^^^
103
104Der Server kann bereits nach der Installation laufen, falls nicht, kannst du ihn wie folgt starten:
105
106.. code:: bash
107
108 redis-server
109
110
111Redis für wallabag konfigurieren
112^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
113
114Bearbeite deine ``app/config/parameters.yml``-Datei, um die Redis-Parameter zu ändern. Die Standardwerte sollten in Ordnung sein:
115
116.. code:: yaml
117
118 redis_host: localhost
119 redis_port: 6379
120
121Redis in wallabag aktivieren
122^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123
124In den internen Einstellungen, aktiviere Redis im Import-Abschnitt mit dem Wert 1.
125
126Starten des Redis-Consumer
127^^^^^^^^^^^^^^^^^^^^^^^^^^
128
129Abhängig davon, über welchen Service du importieren möchtest, musst du den entsprechenden (oder mehrere) Cronjob aktivieren:
130
131.. code:: bash
132
133 # für den Pocket-Import
134 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
135
136 # für den Readability-Import
137 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
138
139 # für den Instapaper-Import
140 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
141
142 # für den wallabag v1-Import
143 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
144
145 # für den wallabag v2-Import
146 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
147
148 # für den Firefox-Import
149 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
150
151 # für den Chrome-Import
152 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
153
154Wenn 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:
155
156.. code:: bash
157
158 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 \ No newline at end of file
diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst
deleted file mode 100644
index 143b64a1..00000000
--- a/docs/de/developer/rabbitmq.rst
+++ /dev/null
@@ -1,81 +0,0 @@
1Installiere RabbitMQ für asynchrone Aufgaben
2============================================
3
4Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir RabbitMQ nutzen.
5
6Voraussetzungen
7---------------
8
9Du musst RabbitMQ auf deinem Server installiert haben.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
17 apt-key add rabbitmq-signing-key-public.asc
18 apt-get update
19 apt-get install rabbitmq-server
20
21Konfiguration und Starten
22~~~~~~~~~~~~~~~~~~~~~~~~~
23
24.. code:: bash
25
26 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
27 rabbitmq-server -detached
28
29RabbitMQ stoppen
30~~~~~~~~~~~~~~~
31
32.. code:: bash
33
34 rabbitmqctl stop
35
36
37Konfigure RabbitMQ in wallabag
38------------------------------
39
40Bearbeite die Datei ``app/config/parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein:
41
42.. code:: yaml
43
44 rabbitmq_host: localhost
45 rabbitmq_port: 5672
46 rabbitmq_user: guest
47 rabbitmq_password: guest
48
49Enable RabbitMQ in wallabag
50---------------------------
51
52In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
53
54Starte den RabbitMQ Consumer
55----------------------------
56
57Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst):
58
59.. code:: bash
60
61 # for Pocket import
62 bin/console rabbitmq:consumer -e=prod import_pocket -w
63
64 # for Readability import
65 bin/console rabbitmq:consumer -e=prod import_readability -w
66
67 # for Instapaper import
68 bin/console rabbitmq:consumer -e=prod import_instapaper -w
69
70 # for wallabag v1 import
71 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
72
73 # for wallabag v2 import
74 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
75
76 # for Firefox import
77 bin/console rabbitmq:consumer -e=prod import_firefox -w
78
79 # for Chrome import
80 bin/console rabbitmq:consumer -e=prod import_chrome -w
81
diff --git a/docs/de/developer/redis.rst b/docs/de/developer/redis.rst
deleted file mode 100644
index 2505bf24..00000000
--- a/docs/de/developer/redis.rst
+++ /dev/null
@@ -1,75 +0,0 @@
1Installiere Redis für asynchrone Aufgaben
2=========================================
3
4Um asynchrone Aufgaben zu starten (nützlich z.B. für große Imports), können wir Redis nutzen.
5
6Voraussetzungen
7---------------
8
9Du musst Redis auf deinem Server installiert haben.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Starten
19~~~~~~
20
21Der Redis Service läuft eventuell schon direkt nach der Installation. Falls nicht kannst du ihn wie folgt starten:
22
23.. code:: bash
24
25 redis-server
26
27
28Konfigure Redis in wallabag
29---------------------------
30
31Bearbeite die Datei ``app/config/parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein:
32
33.. code:: yaml
34
35 redis_host: localhost
36 redis_port: 6379
37
38Enable Redis in wallabag
39------------------------
40
41In internal settings, in the **Import** section, enable Redis (with the value 1).
42
43Starte den Redis Consumer
44-------------------------
45
46Abhängig von welchem Service du importieren möchtest, solltest du einen Cron Job aktivieren (oder mehrere, wenn du viele unterstützen willst):
47
48.. code:: bash
49
50 # for Pocket import
51 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
52
53 # for Readability import
54 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
55
56 # for Instapaper import
57 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
58
59 # for wallabag v1 import
60 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
61
62 # for wallabag v2 import
63 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
64
65 # for Firefox import
66 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
67
68 # for Chrome import
69 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
70
71Wenn 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:
72
73.. code:: bash
74
75 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/de/index.rst b/docs/de/index.rst
index b422bf83..28a47200 100644
--- a/docs/de/index.rst
+++ b/docs/de/index.rst
@@ -8,10 +8,6 @@ wallabag Dokumentation
8**wallabag** ist eine Read-it-later Applikation: es speichert Websites, 8**wallabag** ist eine Read-it-later Applikation: es speichert Websites,
9indem es nur den Inhalt behält. Elemente wie Navigation oder Werbung werden gelöscht. 9indem es nur den Inhalt behält. Elemente wie Navigation oder Werbung werden gelöscht.
10 10
11.. tip::
12
13 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>`__.
14
15Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organisiert: 11Die Hauptdokumentation für diese Applikation ist in einigen Abschnitten organisiert:
16 12
17* :ref:`user-docs` 13* :ref:`user-docs`
@@ -28,24 +24,19 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
28 :maxdepth: 2 24 :maxdepth: 2
29 :caption: Nutzerdokumentation 25 :caption: Nutzerdokumentation
30 26
31 user/faq
32 user/installation 27 user/installation
33 user/upgrade-2.0.x-2.1.1 28 user/upgrade
34 user/upgrade-2.0.x-2.1.1 29 user/configuration
35 user/migration
36 user/import 30 user/import
37 user/create_account 31 user/create_account
38 user/login 32 user/articles
39 user/configuration
40 user/first_article
41 user/errors_during_fetching 33 user/errors_during_fetching
42 user/annotations
43 user/download_articles
44 user/filters 34 user/filters
45 user/tags 35 user/tags
46 user/android 36 user/android
47 user/parameters 37 user/parameters
48 user/backup 38 user/backup
39 user/faq
49 40
50.. _dev-docs: 41.. _dev-docs:
51 42
@@ -58,5 +49,4 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
58 developer/documentation 49 developer/documentation
59 developer/translate 50 developer/translate
60 developer/maintenance 51 developer/maintenance
61 developer/redis 52 developer/asynchronous
62 developer/rabbitmq
diff --git a/docs/de/user/android.rst b/docs/de/user/android.rst
index 8573bcb8..31509438 100644
--- a/docs/de/user/android.rst
+++ b/docs/de/user/android.rst
@@ -23,7 +23,7 @@ Bestätige nur diese Nachricht und du wirst zum Einstellungsbildschirm weitergel
23 :alt: Einstellungsbildschirm 23 :alt: Einstellungsbildschirm
24 :align: center 24 :align: center
25 25
26Trage 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. 26Trage 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.
27 27
28.. image:: ../../img/user/android_configuration_filled_in.de.png 28.. image:: ../../img/user/android_configuration_filled_in.de.png
29 :alt: Eingetragene Einstellungen 29 :alt: Eingetragene Einstellungen
@@ -76,8 +76,8 @@ Schließlich nach der ersten erfolgreichen Synchronisation, wird dir die Liste d
76Bekannte Limitierungen 76Bekannte Limitierungen
77--------------------- 77---------------------
78 78
792FA 79Zwei-Faktor-Authentifizierung (2FA)
80~~~ 80~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81 81
82Zur Zeit unterstützt die App keine Zwei-Faktor Authentifizierung. Du solltest sie deaktivieren damit die App funktioniert. 82Zur Zeit unterstützt die App keine Zwei-Faktor Authentifizierung. Du solltest sie deaktivieren damit die App funktioniert.
83 83
@@ -97,11 +97,6 @@ Wenn du deine Wallabaginstanz per HTTPS erreichen kannst, solltest du das so kon
97Referenzen 97Referenzen
98---------- 98----------
99 99
100`Quellcode der Android Applikation <https://github.com/wallabag/android-app>`_ 100- `Quellcode der Android-App <https://github.com/wallabag/android-app>`_
101 101- `Android-App auf F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
102`Android Applikation auf F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_ 102- `Android-App auf Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_ \ No newline at end of file
103
104`Android Applikation auf Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
105
106`Support Chat auf English <https://gitter.im/wallabag/wallabag>`_
107
diff --git a/docs/de/user/annotations.rst b/docs/de/user/annotations.rst
deleted file mode 100644
index 4b4d58b0..00000000
--- a/docs/de/user/annotations.rst
+++ /dev/null
@@ -1,24 +0,0 @@
1Anmerkungen
2===========
3
4In jedem Artikel, den du liest, kannst du Anmerkungen hinzufügen. Es ist einfacher mit ein paar Bilder erklärt.
5
6Wähle den Teil des Artikels aus, den du kommentieren willst und klicke auf den Bleistift:
7
8.. image:: ../../img/user/annotations_1.png
9 :alt: Wähle den Text
10 :align: center
11
12Schreibe deinen Kommentar:
13
14.. image:: ../../img/user/annotations_2.png
15 :alt: Schreibe deinen Kommentar
16 :align: center
17
18Der Text ist nun hervorgehoben und du kannst deine Anmerkung lesen, wenn du den Mauspfeil darüber fährst.
19
20.. image:: ../../img/user/annotations_3.png
21 :alt: lese deine Anmerkung
22 :align: center
23
24Du kannst so viele Anmerkungen erstellen wie du möchtest.
diff --git a/docs/de/user/articles.rst b/docs/de/user/articles.rst
new file mode 100644
index 00000000..07cfa06c
--- /dev/null
+++ b/docs/de/user/articles.rst
@@ -0,0 +1,112 @@
1Artikel
2=======
3
4Speichere deinen ersten Artikel
5-------------------------------
6
7Die Hauptzweck von wallabag ist es, Artikel aus dem Web zu speichern. Es gibt viele Wege, dieses Ziel zu erreichen.
8Wenn du denkst, dass ein Artikel falsch angezeigt wird, kannst du `diese Dokumentation lesen <http://doc.wallabag.org/de/master/user/errors_during_fetching.html>`_.
9
10Über ein Bookmarklet
11^^^^^^^^^^^^^^^^^^^^
12
13Auf der ``Howto``-Seite hast du einen ``Bookmarklet``-Tab. Ziehe das ``bag it!`` in die Lesezeichenleiste deines Browsers.
14Nun kannst du jedes Mal, wenn du einen Artikel speichern willst, auf den ``bag it!``-Link klicken, dann ist der Artikel gespeichert.
15
16Der klassische Weg
17^^^^^^^^^^^^^^^^^^
18
19In 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.
20
21.. image:: ../../img/user/topbar.png
22 :alt: Top bar
23 :align: center
24
25Klicke darauf, um ein neues Feld anzuzeigen, füge die Artikel-URL ein und drücke Enter. Dann wird der Artikel gespeichert.
26
27Über ein Browser-Addon
28^^^^^^^^^^^^^^^^^^^^^^
29
30Firefox
31"""""""
32
33Du kannst das `Firefox-Addon hier <https://addons.mozilla.org/firefox/addon/wallabag-v2/> herunterladen`_.
34
35Chrome
36""""""
37
38Du kannst das `Chrome-Addon hier <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr> herunterladen`_.
39
40Über das Smartphone
41^^^^^^^^^^^^^^^^^^^
42
43Android
44"""""""
45
46Du kannst die `Android-App hier <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche> herunterladen`_.
47
48Windows 10 in general
49"""""""""""""""""""""
50
51Du kannst die `Windows-App hier <https://www.microsoft.com/store/apps/9nblggh5x3p6> herunterladen`_.
52
53Artikel herunterladen
54---------------------
55
56Du kannst jeden Artikel in verschiedenen Formaten herunterladen: ePUB, MOBI, PDF, XML, JSON, CSV.
57
58Klicke in der Artikelansicht auf dieses Symbol in der Seitenleiste:
59
60.. image:: ../../img/user/download_article.png
61 :alt: Artikel herunterladen
62 :align: center
63
64Du kannst sogar eine ganze Kategorie (Ungelesen, Favoriten, Archiv) in diesen Formaten herunterladen:
65Beispielsweise kannst du auf der **Ungelesen**-Ansicht auf dieses Symbol in der oberen Leiste klicken:
66
67.. image:: ../../img/user/download_articles.png
68 :alt: Artikel herunterladen
69 :align: center
70
71Artikel teilen
72--------------
73
74Wenn du einen Artikel liest, kannst du ihn auch teilen. Klicke dazu einfach auf den Teilen-Button:
75
76.. image:: ../../img/user/share.png
77 :alt: Artikel teilen
78 :align: center
79
80Nun kannst du den Artikel teilen:
81
82- über eine öffentliche URL (es wird eine reduzierte Ansicht des Artikels zurückgegeben)
83- über einen Tweet
84- in deine Shaarli
85- mit einem Beitrag auf Diaspora*
86- an Carrot
87- mit einer E-Mail
88
89Artikel-Anmerkungen
90-------------------
91
92In jedem Artikel, den du liest, kannst du Anmerkungen hinzufügen. Es ist einfacher mit ein paar Bilder erklärt.
93
94Wähle den Teil des Artikels aus, den du kommentieren willst und klicke auf den Bleistift:
95
96.. image:: ../../img/user/annotations_1.png
97 :alt: Wähle den Text
98 :align: center
99
100Schreibe deinen Kommentar:
101
102.. image:: ../../img/user/annotations_2.png
103 :alt: Schreibe deinen Kommentar
104 :align: center
105
106Der Text ist nun hervorgehoben und du kannst deine Anmerkung lesen, wenn du den Mauspfeil darüber fährst.
107
108.. image:: ../../img/user/annotations_3.png
109 :alt: lese deine Anmerkung
110 :align: center
111
112Du kannst so viele Anmerkungen erstellen wie du möchtest.
diff --git a/docs/de/user/backup.rst b/docs/de/user/backup.rst
index ffe3ce37..521e17ad 100644
--- a/docs/de/user/backup.rst
+++ b/docs/de/user/backup.rst
@@ -22,4 +22,4 @@ Um die SQLite-Datenbank zu sichern, ist es lediglich notwendig, das Verzeichnis
22 22
23Bilder 23Bilder
24------ 24------
25Die Bilder, die von wallabag empfangen worden, sind unter `data/assets/images` gespeichert (der Bilder-Speicher wird in wallabag 2.2 implementiert). 25Die Bilder, die von wallabag empfangen worden, sind unter `web/assets/images` gespeichert (der Bilder-Speicher wird in wallabag 2.2 implementiert).
diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst
index 23591cb9..3fb501eb 100644
--- a/docs/de/user/configuration.rst
+++ b/docs/de/user/configuration.rst
@@ -49,8 +49,8 @@ Benutzer-Informationen
49 49
50Du kannst deinen Namen ändern, deine E-Mail-Adresse und die Zwei-Faktor-Authentifizierung aktivieren. 50Du kannst deinen Namen ändern, deine E-Mail-Adresse und die Zwei-Faktor-Authentifizierung aktivieren.
51 51
52Zwei-Faktor-Authentifizierung 52Zwei-Faktor-Authentifizierung (2FA)
53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54 54
55 Die Zwei-Faktor-Authentifizierung (2FA) dient dem Identitätsnachweis eines Nutzers mittels der 55 Die Zwei-Faktor-Authentifizierung (2FA) dient dem Identitätsnachweis eines Nutzers mittels der
56 Kombination zweier verschiedener und insbesondere unabhängiger Komponenten (Faktoren). 56 Kombination zweier verschiedener und insbesondere unabhängiger Komponenten (Faktoren).
diff --git a/docs/de/user/create_account.rst b/docs/de/user/create_account.rst
index ce1b02a4..14a7d006 100644
--- a/docs/de/user/create_account.rst
+++ b/docs/de/user/create_account.rst
@@ -1,6 +1,9 @@
1Account erstellen 1Account erstellen
2================= 2=================
3 3
4Registrierungsformular
5----------------------
6
4Klicke auf der Loginseite auf den ``Registrieren`` Button- 7Klicke auf der Loginseite auf den ``Registrieren`` Button-
5 8
6.. image:: ../../img/user/registration_form.png 9.. image:: ../../img/user/registration_form.png
@@ -23,3 +26,16 @@ Dein Account ist nun aktiviert.
23.. image:: ../../img/user/activated_account.png 26.. image:: ../../img/user/activated_account.png
24 :alt: Willkommen! 27 :alt: Willkommen!
25 :align: center 28 :align: center
29
30Anmeldung
31---------
32
33Glückwunsch, dein Account ist nun aktiviert!
34Um dich auf wallabag anzumelden, fülle das Formular auf der Login-Seite aus.
35
36Wenn du auf einem persönlichen Computer bist und angemeldet bleiben möchtest,
37kannst du ein Häkchen nach ``angemeldet bleiben`` setzen, wallabag wird sich ein Jahr an dich erinnern.
38
39.. image:: ../../img/user/login_form.png
40 :alt: Login form
41 :align: center \ No newline at end of file
diff --git a/docs/de/user/download_articles.rst b/docs/de/user/download_articles.rst
deleted file mode 100644
index 6f5384b2..00000000
--- a/docs/de/user/download_articles.rst
+++ /dev/null
@@ -1,17 +0,0 @@
1Artikel herunterladen
2=====================
3
4Du kannst jeden Artikel in verschiedenen Formaten herunterladen: ePUB, MOBI, PDF, XML, JSON, CSV.
5
6In der Artikelansicht, klickst du auf dieses Icon in der Seitenleiste:
7
8.. image:: ../../img/user/download_article.png
9 :alt: Artikel herunterladen
10 :align: center
11
12Du kannst auch eine ganze Kategorie (ungelesen, Favoriten, Archiv) in diesen Formaten herunterladen.
13Zum Beispiel, in der Ansicht **Ungelesen**, klickst du auf das Icon in der oberen Leiste:
14
15.. image:: ../../img/user/download_articles.png
16 :alt: Artikel herunterladen
17 :align: center
diff --git a/docs/de/user/first_article.rst b/docs/de/user/first_article.rst
deleted file mode 100644
index b8ceda07..00000000
--- a/docs/de/user/first_article.rst
+++ /dev/null
@@ -1,68 +0,0 @@
1Speichere deinen ersten Artikel
2===============================
3
4Der Hauptzweck von wallabag ist es Webartikel zu speichern. Du hast viele Wege das zu tun.
5
6.. note::
7
8 Eine Schnellstartanleitung wird in der Anwendung angezeigt bis du deinen ersten
9 Artikel gespeichert hast.
10
11Durch Nutzung eines Bookmarklets
12--------------------------------
13
14Auf der ``How-To`` Seite, hast du einen Reiter ``Bookmarklet``. Ziehe und lasse den
15``bag it!`` Link in die Lesezeichenleiste deines Browser los.
16
17Jetzt kannst du immer wenn du einen Artikel im Web liest und ihn du ihn speichern
18willst, klicke auf den ``bag it!`` Link in deiner Lesezeichenleiste. Der Artikel
19wird gespeichert.
20
21Durch Nutzung des klassischen Formulars
22---------------------------------------
23
24In der oberen Leiste auf deinem Bildschirm, hast du drei Icons. Mit dem ersten, einem
25Pluszeichen, kannst du einfach neue Artikel speichern.
26
27.. image:: ../../img/user/topbar.png
28 :alt: obere Leiste
29 :align: center
30
31Klick darauf, um ein neues Feld anzeigen zu lassen, füge deine Artikel URL ein und
32drücke die ``Enter`` Taste. Der Artikel wird gespeichert.
33
34Durch Nutzung eines Browser Add-ons
35-----------------------------------
36
37Firefox
38~~~~~~~
39
40*Dieses Addon ist noch nicht für wallbag v2 verfügbar*.
41
42Chrome
43~~~~~~
44
45*Dieses Addon ist noch nicht für wallbag v2 verfügbar*.
46
47Durch Nutzung deiner Smartphone App
48-----------------------------------
49
50Android
51~~~~~~~
52
53*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
54
55Firefox OS
56~~~~~~~~~~
57
58*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
59
60Windows Phone
61~~~~~~~~~~~~~
62
63*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
64
65iOS
66~~~
67
68*Diese Applikation ist noch nicht für wallbag v2 verfügbar*.
diff --git a/docs/de/user/import.rst b/docs/de/user/import.rst
index ecd3134b..55ab9291 100644
--- a/docs/de/user/import.rst
+++ b/docs/de/user/import.rst
@@ -1,8 +1,20 @@
1Migration von einem Drittanbieter 1Migration von einem Drittanbieter
2================================= 2=================================
3 3
4Von Pocket 4In wallabag 2.x kannst du Daten von folgenden Anbietern importieren:
5----------- 5
6- Pocket <#id1>`_
7- Readability <#id2>`_
8- Instapaper <#id4>`_
9- wallabag 1.x <#id6>`_
10- wallabag 2.x <#id7>`_
11
12Wir haben zusätzlich `ein Skript für die Migration per Kommandozeile <#import-via-command-line-interface-cli>`_ geschrieben.
13
14Da 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).
15
16Pocket
17------
6 18
7Erstelle eine neue Applikation in Pocket 19Erstelle eine neue Applikation in Pocket
8~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 20~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -23,24 +35,103 @@ Jetzt ist alles in Ordnung, um von Pocket zu migrieren.
23Importiere deine Daten in wallabag 2.x 35Importiere deine Daten in wallabag 2.x
24~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 36~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 37
26Klicke auf den ``Importieren`` Link im menü, auf ``Inhalte importieren`` in dem Pocketabschnitt und 38Klicke auf den ``Importieren`` Link im Menü, auf ``Inhalte importieren`` in dem Pocketabschnitt und
27dann auf ``Verbinde mit Pocket und importieren Daten``. 39dann auf ``Verbinde mit Pocket und importieren Daten``.
28 40
29Du musst wallabag erlauben, mit deinem Pocketaccount zu interagieren. 41Du musst wallabag erlauben, mit deinem Pocketaccount zu interagieren.
30Deine Daten werden importiert. Datenimport kann ein sehr anspruchsvoller Prozess für deinen Server 42Deine Daten werden importiert. Datenimport kann ein sehr anspruchsvoller Prozess für deinen Server
31sein (wir müssen daran arbeiten, um diesen Import zu verbessern). 43sein (wir müssen daran arbeiten, um diesen Import zu verbessern).
32 44
33Von Instapaper 45Readability
34-------------- 46-----------
47
48Exportiere deine Readability-Daten
49~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50
51Auf 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.
52
53Importiere deine Daten in wallabag 2.x
54~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55
56Klicke auf den ``Importieren``-Link im Menü, auf ``Inhalte importieren`` im Readability-Abschnitt und wähle dann deine JSON-Datei aus und lade sie hoch.
57
58Deine Daten werden dann importiert. Dies kann eine starke Belastung für den Server sein.
59
60Instapaper
61----------
62
63Exportiere deine Instapaper-Daten
64~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65
66Klicke 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.
67
68Importiere deine Daten in wallabag 2.x
69~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70
71Klicke auf den ``Importieren``-Link im Menü, auf ``Inhalte importieren`` im Instapaper-Abschnitt und wähle dann deine CSV-Datei aus und lade sie hoch.
72
73Deine Daten werden dann importiert. Dies kann eine starke Belastung für den Server sein.
74
75wallabag 1.x
76------------
77
78Wenn 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.
79
80.. image:: ../../img/user/export_v1.png
81 :alt: Export aus wallabag 1.x
82 :align: center
83
84.. note::
85 Wenn du mehrere Accounts auf der gleichen wallabag-Instanz hast, muss jeder Nutzer seine Daten aus 1.x exportieren und in 2.x importieren.
86
87.. note::
88 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>`__.
89
90Wenn 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>`__.
91
92Nach 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.
93
94.. image:: ../../img/user/import_wallabagv1.png
95 :alt: Import aus wallabag v1
96 :align: center
97
98wallabag 2.x
99------------
100
101Gehe auf der alten wallabag-Instanz, die du vorher genutzt hast, auf `Alle Artikel` und exportiere diese dann als JSON.
102
103.. image:: ../../img/user/export_v2.png
104 :alt: Export aus wallabag v2
105 :align: center
106
107Nach 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.
108
109.. note::
110 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>`__.
111
112Import über die Kommandozeile (CLI)
113-----------------------------------
114
115Falls du auf deinem Server Zugriff auf die Kommandozeile hast, kannst du den folgenden Befehl ausführen, um deine Daten aus wallabag v1 zu importieren:
116
117::
118
119 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
120
121Bitte ersetze die Werte:
122
123* ``1`` ist die Benutzer-ID in der Datenbank (die ID des ersten Benutzers ist immer 1)
124* ``~/Downloads/wallabag-export-1-2016-04-05.json`` ist der Pfad zu deiner wallabag v1-Exportdatei
35 125
36*Funktion noch nicht implementiert in wallabag v2.* 126Wenn du alle Artikel als gelesen markieren möchtest, kannst du die ``--markAsRead``-Option hinzufügen.
37 127
38Von Readability 128Um eine wallabag 2.x-Datei zu importieren, musst du die Option ``--importer=v2`` hinzufügen.
39---------------
40 129
41*Funktion noch nicht implementiert in wallabag v2.* 130Als Ergebnis wirst du so etwas erhalten:
42 131
43Von einer HTML oder JSON Datei 132::
44------------------------------
45 133
46*Funktion noch nicht implementiert in wallabag v2.* 134 Start : 05-04-2016 11:36:07 ---
135 403 imported
136 0 already saved
137 End : 05-04-2016 11:36:09 --- \ No newline at end of file
diff --git a/docs/de/user/login.rst b/docs/de/user/login.rst
deleted file mode 100644
index cf1cdc4c..00000000
--- a/docs/de/user/login.rst
+++ /dev/null
@@ -1,13 +0,0 @@
1Login
2=====
3
4Dein Account ist nun aktiviert, Glückwünsch!
5
6Um dich bei wallabag einzuloggen, fülle das Formular auf der Loginseite aus.
7
8Wenn du an deinem persönlichen Computer arbeitest und verbunden bleiben willst,
9kannst du die Checkbox ``Angemeldet bleiben`` anhaken: wallabag wird sich für ein Jahr an deinen Login erinnern.
10
11.. image:: ../../img/user/login_form.png
12 :alt: Loginformular
13 :align: center
diff --git a/docs/de/user/migration.rst b/docs/de/user/migration.rst
deleted file mode 100644
index bc8a61b0..00000000
--- a/docs/de/user/migration.rst
+++ /dev/null
@@ -1,62 +0,0 @@
1Migration von v1 oder v2
2========================
3
4Von wallabag 1.x
5-----------------
6
7Wenn 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.
8
9.. image:: ../../img/user/export_v1.png
10 :alt: Export von wallabag v1
11 :align: center
12
13.. note::
14 Wenn du mehrere Accounts auf der gleichen Instanz von wallabag hast, muss jeder Nutzer von v1 exportieren und in v2 seine Daten importieren.
15
16.. note::
17 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>`__.
18
19Wenn 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>`__.
20
21Nachdem 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.
22
23.. image:: ../../img/user/import_wallabagv1.png
24 :alt: Import von wallabag v1
25 :align: center
26
27Import via command-line interface (CLI)
28~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29
30Wenn du CLI Zugang zu deinem Webserver hast, kannst du dieses Kommando ausführen, um deine Aritkel vom wallabag v1 Export zu importieren:
31
32::
33
34 bin/console wallabag:import-v1 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
35
36Bitte ersetze folgende Werte:
37
38* ``1`` ist die Nutzer ID in der Databank (Die ID von dem ersten erstellten Nutzer in wallabag ist 1)
39* ``~/Downloads/wallabag-export-1-2016-04-05.json`` ist der Pfad zu deinem wallabag v1 Export
40
41Du wirst eine solche Ausgabe erhalten:
42
43::
44
45 Start : 05-04-2016 11:36:07 ---
46 403 imported
47 0 already saved
48 End : 05-04-2016 11:36:09 ---
49
50Von wallabag 2.x
51----------------
52
53In der vorherigen wallabag Instanz, gehe zu `Alle Artikel` und exportiere diese Artikel als JSON.
54
55.. image:: ../../img/user/export_v2.png
56 :alt: Export von wallabag v2
57 :align: center
58
59In 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.
60
61.. note::
62 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>`__.
diff --git a/docs/de/user/parameters.rst b/docs/de/user/parameters.rst
index 4c68fe9e..a5a4e4f2 100644
--- a/docs/de/user/parameters.rst
+++ b/docs/de/user/parameters.rst
@@ -1,5 +1,48 @@
1Was bedeuten die Parameter? 1Was bedeuten die Parameter?
2=========================== 2===========================
3
4Standardeinstellungen der `parameters.yml`
5------------------------------------------
6
7Dies ist die letzte standardisierte Version der `app/config/parameters.yml`-Datei. Stelle sicher, dass sich deine mit dieser ähnelt.
8Wenn du nicht weißt, welchen Wert du setzen sollst, belasse es bei dem Standardwert.
9
10.. code-block:: yml
11
12 parameters:
13 database_driver: pdo_sqlite
14 database_host: 127.0.0.1
15 database_port: null
16 database_name: symfony
17 database_user: root
18 database_password: null
19 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
20 database_table_prefix: wallabag_
21 database_socket: null
22 mailer_transport: smtp
23 mailer_host: 127.0.0.1
24 mailer_user: null
25 mailer_password: null
26 locale: en
27 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
28 twofactor_auth: true
29 twofactor_sender: no-reply@wallabag.org
30 fosuser_registration: true
31 fosuser_confirmation: true
32 from_email: no-reply@wallabag.org
33 rss_limit: 50
34 rabbitmq_host: localhost
35 rabbitmq_port: 5672
36 rabbitmq_user: guest
37 rabbitmq_password: guest
38 redis_scheme: tcp
39 redis_host: localhost
40 redis_port: 6379
41 redis_path: null
42
43Bedeutung von jedem Parameter
44-----------------------------
45
3.. csv-table:: Datenbankparameter 46.. csv-table:: Datenbankparameter
4 :header: "Name", "Standardwert", "Beschreibung" 47 :header: "Name", "Standardwert", "Beschreibung"
5 48
diff --git a/docs/de/user/upgrade-2.0.x-2.1.1.rst b/docs/de/user/upgrade-2.0.x-2.1.1.rst
deleted file mode 100644
index d5ab477a..00000000
--- a/docs/de/user/upgrade-2.0.x-2.1.1.rst
+++ /dev/null
@@ -1,88 +0,0 @@
1Wallabag von 2.0.x auf 2.1.1 updaten
2====================================
3
4.. warning::
5Wenn 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.
6
7Update auf einem dedizierten Webserver
8--------------------------------------
9
10Das 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):
11
12::
13
14 rm -rf var/cache/*
15 git fetch origin
16 git fetch --tags
17 git checkout 2.1.1 --force
18 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
19 php bin/console doctrine:migrations:migrate --env=prod
20 php bin/console cache:clear --env=prod
21
22Update auf einem Shared Webhosting
23----------------------------------
24
25Sichere deine ``app/config/parameters.yml`` Datei.
26
27Lade das neueste Release von wallabag herunter:
28
29.. code-block:: bash
30
31 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
32
33(2.1.1 md5 Hashsumme: ``9584a3b60a2b2a4de87f536548caac93``)
34
35Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
36
37Bitte 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):
38
39.. code-block:: yml
40
41 parameters:
42 database_driver: pdo_sqlite
43 database_host: 127.0.0.1
44 database_port: null
45 database_name: symfony
46 database_user: root
47 database_password: null
48 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
49 database_table_prefix: wallabag_
50 database_socket: null
51 mailer_transport: smtp
52 mailer_host: 127.0.0.1
53 mailer_user: null
54 mailer_password: null
55 locale: en
56 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
57 twofactor_auth: true
58 twofactor_sender: no-reply@wallabag.org
59 fosuser_registration: true
60 fosuser_confirmation: true
61 from_email: no-reply@wallabag.org
62 rss_limit: 50
63 rabbitmq_host: localhost
64 rabbitmq_port: 5672
65 rabbitmq_user: guest
66 rabbitmq_password: guest
67 redis_scheme: tcp
68 redis_host: localhost
69 redis_port: 6379
70 redis_path: null
71
72Du kannst `hier eine Dokumentation über die Parameter finden <http://doc.wallabag.org/en/master/user/parameters.html>`_.
73
74Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren.
75
76Leere den ``var/cache`` Ordner.
77
78Du 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:
79
80.. code-block:: sql
81
82 ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
83 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
84 ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
85 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
86 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
87 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
88 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
diff --git a/docs/de/user/upgrade-2.1.x-2.1.y.rst b/docs/de/user/upgrade-2.1.x-2.1.y.rst
deleted file mode 100644
index d3c4f7ab..00000000
--- a/docs/de/user/upgrade-2.1.x-2.1.y.rst
+++ /dev/null
@@ -1,30 +0,0 @@
1Wallabag von 2.1.x auf 2.1.y updaten
2====================================
3
4Update auf einem dedizierten Webserver
5--------------------------------------
6
7Das 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):
8
9::
10
11 make update
12
13Update auf einem Shared Webhosting
14----------------------------------
15
16Sichere deine ``app/config/parameters.yml`` Datei.
17
18Lade das neueste Release von wallabag herunter:
19
20.. code-block:: bash
21
22 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
23
24Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website <https://www.wallabag.org/pages/download-wallabag.html>`_.
25
26Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
27
28Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren.
29
30Leere den ``var/cache`` Ordner.
diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst
new file mode 100644
index 00000000..ad020dd8
--- /dev/null
+++ b/docs/de/user/upgrade.rst
@@ -0,0 +1,103 @@
1wallabag-Installation aktualisieren
2===================================
3
4Du wirst hier mehrere Wege finden, um deine wallabag zu aktualisieren:
5
6- `von 2.0.x zu 2.1.1 <#upgrade-von-2-0-x-zu-2-1-1>`_
7- `von 2.1.x zu 2.1.y <#upgrade-von-2-1-x-zu-2-1-y>`_
8- `von 1.x zu 2.x <#upgrade-von-1-x>`_
9
10Upgrade von 2.0.x zu 2.1.1
11---------------------------
12
13.. warning::
14
15 Mache eine Sicherung deines Pocket-Consumer-Key, falls hinzugefügt, da dieser nach dem Upgrade erneut hinzugefügt werden muss.
16
17Upgrade auf einem dedizierten Webserver
18^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
19
20::
21
22 rm -rf var/cache/*
23 git fetch origin
24 git fetch --tags
25 git checkout 2.1.1 --force
26 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
27 php bin/console doctrine:migrations:migrate --env=prod
28 php bin/console cache:clear --env=prod
29
30Upgrade auf einem Shared Hosting
31^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32
33Sichere deine ``app/config/parameters.yml``-Datei.
34
35Lade das 2.1.1-Release von wallabag herunter:
36
37.. code-block:: bash
38
39 wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
40
41(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
42
43Extrahiere das Archiv in deinen wallabag-Ordner und ersetze die ``app/config/parameters.yml`` mit deiner.
44
45Bitte ü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>`_.
46
47Falls du SQLite nutzt, musst du außerdem deinen ``data/``-Ordner in die neue Installation kopieren.
48
49Leere den ``var/cache``-Ordner.
50
51Du 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:
52
53.. code-block:: sql
54
55 ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
56 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
57 ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
58 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
59 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
60 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
61 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
62
63Upgrade von 2.1.x zu 2.1.y
64-----------------------------
65
66Upgrade auf einem dedizierten Webserver
67^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
68
69Um deine wallabag-Installation auf die letzte Version zu aktualisieren, führe den folgenden Befehl in deinem wallabag-Ordner aus:
70
71::
72
73 make update
74
75Upgrade auf einem Shared Hosting
76^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77
78Sichere deine ``app/config/parameters.yml``-Datei.
79
80Lade das letzte Release von wallabag herunter:
81
82.. code-block:: bash
83
84 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
85
86Du findest den `aktuellen MD5-Hash auf unserer Webseite <https://www.wallabag.org/pages/download-wallabag.html>`_.
87
88Extrahiere das Archiv in deinen wallabag-Ordner und ersetze die ``app/config/parameters.yml`` mit deiner.
89
90Bitte ü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>`_.
91
92Falls du SQLite nutzt, musst du außerdem deinen ``data/``-Ordner in die neue Installation kopieren.
93
94Leere den ``var/cache``-Ordner.
95
96Upgrade von 1.x
97---------------
98
99Es gibt kein automatisiertes Skript, um wallabag 1.x auf wallabag 2.x zu aktualisieren. Du musst:
100
101- deine Daten exportieren
102- wallabag 2.x installieren (Dokumentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
103- die Daten in die neue Installation importieren (`Dokumentation <http://doc.wallabag.org/en/master/user/import.html>`_ ) \ No newline at end of file
diff --git a/docs/en/developer/asynchronous.rst b/docs/en/developer/asynchronous.rst
new file mode 100644
index 00000000..6a991cf6
--- /dev/null
+++ b/docs/en/developer/asynchronous.rst
@@ -0,0 +1,159 @@
1Asynchronous tasks
2==================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ or Redis.
5
6Install RabbitMQ for asynchronous tasks
7---------------------------------------
8
9Requirements
10^^^^^^^^^^^^
11
12You need to have RabbitMQ installed on your server.
13
14Installation
15^^^^^^^^^^^^
16
17.. code:: bash
18
19 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
20 apt-key add rabbitmq-signing-key-public.asc
21 apt-get update
22 apt-get install rabbitmq-server
23
24Configuration and launch
25^^^^^^^^^^^^^^^^^^^^^^^^
26
27.. code:: bash
28
29 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
30 rabbitmq-server -detached
31
32Stop RabbitMQ
33^^^^^^^^^^^^^
34
35.. code:: bash
36
37 rabbitmqctl stop
38
39
40Configure RabbitMQ in wallabag
41^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42
43Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok:
44
45.. code:: yaml
46
47 rabbitmq_host: localhost
48 rabbitmq_port: 5672
49 rabbitmq_user: guest
50 rabbitmq_password: guest
51
52Enable RabbitMQ in wallabag
53^^^^^^^^^^^^^^^^^^^^^^^^^^^
54
55In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
56
57Launch RabbitMQ consumer
58^^^^^^^^^^^^^^^^^^^^^^^^
59
60Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
61
62.. code:: bash
63
64 # for Pocket import
65 bin/console rabbitmq:consumer -e=prod import_pocket -w
66
67 # for Readability import
68 bin/console rabbitmq:consumer -e=prod import_readability -w
69
70 # for Instapaper import
71 bin/console rabbitmq:consumer -e=prod import_instapaper -w
72
73 # for wallabag v1 import
74 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
75
76 # for wallabag v2 import
77 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
78
79 # for Firefox import
80 bin/console rabbitmq:consumer -e=prod import_firefox -w
81
82 # for Chrome import
83 bin/console rabbitmq:consumer -e=prod import_chrome -w
84
85Install Redis for asynchronous tasks
86------------------------------------
87
88In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
89
90Requirements
91^^^^^^^^^^^^
92
93You need to have Redis installed on your server.
94
95Installation
96^^^^^^^^^^^^
97
98.. code:: bash
99
100 apt-get install redis-server
101
102Launch
103^^^^^^
104
105The server might be already running after installing, if not you can launch it using:
106
107.. code:: bash
108
109 redis-server
110
111
112Configure Redis in wallabag
113^^^^^^^^^^^^^^^^^^^^^^^^^^^
114
115Edit your ``app/config/parameters.yml`` file to edit Redis configuration. The default one should be ok:
116
117.. code:: yaml
118
119 redis_host: localhost
120 redis_port: 6379
121
122Enable Redis in wallabag
123^^^^^^^^^^^^^^^^^^^^^^^^
124
125In internal settings, in the **Import** section, enable Redis (with the value 1).
126
127Launch Redis consumer
128^^^^^^^^^^^^^^^^^^^^^
129
130Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
131
132.. code:: bash
133
134 # for Pocket import
135 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
136
137 # for Readability import
138 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
139
140 # for Instapaper import
141 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
142
143 # for wallabag v1 import
144 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
145
146 # for wallabag v2 import
147 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
148
149 # for Firefox import
150 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
151
152 # for Chrome import
153 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
154
155If 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 :
156
157.. code:: bash
158
159 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst
deleted file mode 100644
index 7ee8a5ce..00000000
--- a/docs/en/developer/rabbitmq.rst
+++ /dev/null
@@ -1,80 +0,0 @@
1Install RabbitMQ for asynchronous tasks
2=======================================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ.
5
6Requirements
7------------
8
9You need to have RabbitMQ installed on your server.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
17 apt-key add rabbitmq-signing-key-public.asc
18 apt-get update
19 apt-get install rabbitmq-server
20
21Configuration and launch
22~~~~~~~~~~~~~~~~~~~~~~~~
23
24.. code:: bash
25
26 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
27 rabbitmq-server -detached
28
29Stop RabbitMQ
30~~~~~~~~~~~~~
31
32.. code:: bash
33
34 rabbitmqctl stop
35
36
37Configure RabbitMQ in wallabag
38------------------------------
39
40Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok:
41
42.. code:: yaml
43
44 rabbitmq_host: localhost
45 rabbitmq_port: 5672
46 rabbitmq_user: guest
47 rabbitmq_password: guest
48
49Enable RabbitMQ in wallabag
50---------------------------
51
52In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
53
54Launch RabbitMQ consumer
55------------------------
56
57Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
58
59.. code:: bash
60
61 # for Pocket import
62 bin/console rabbitmq:consumer -e=prod import_pocket -w
63
64 # for Readability import
65 bin/console rabbitmq:consumer -e=prod import_readability -w
66
67 # for Instapaper import
68 bin/console rabbitmq:consumer -e=prod import_instapaper -w
69
70 # for wallabag v1 import
71 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
72
73 # for wallabag v2 import
74 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
75
76 # for Firefox import
77 bin/console rabbitmq:consumer -e=prod import_firefox -w
78
79 # for Chrome import
80 bin/console rabbitmq:consumer -e=prod import_chrome -w
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
deleted file mode 100644
index ea084e66..00000000
--- a/docs/en/developer/redis.rst
+++ /dev/null
@@ -1,75 +0,0 @@
1Install Redis for asynchronous tasks
2====================================
3
4In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis.
5
6Requirements
7------------
8
9You need to have Redis installed on your server.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Launch
19~~~~~~
20
21The server might be already running after installing, if not you can launch it using:
22
23.. code:: bash
24
25 redis-server
26
27
28Configure Redis in wallabag
29---------------------------
30
31Edit your ``app/config/parameters.yml`` file to edit Redis configuration. The default one should be ok:
32
33.. code:: yaml
34
35 redis_host: localhost
36 redis_port: 6379
37
38Enable Redis in wallabag
39------------------------
40
41In internal settings, in the **Import** section, enable Redis (with the value 1).
42
43Launch Redis consumer
44---------------------
45
46Depending on which service you want to import from you need to enable one (or many if you want to support many) cron job:
47
48.. code:: bash
49
50 # for Pocket import
51 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
52
53 # for Readability import
54 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
55
56 # for Instapaper import
57 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
58
59 # for wallabag v1 import
60 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
61
62 # for wallabag v2 import
63 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
64
65 # for Firefox import
66 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
67
68 # for Chrome import
69 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
70
71If 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 :
72
73.. code:: bash
74
75 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 0ead261b..77425bfa 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -8,10 +8,6 @@ wallabag documentation
8**wallabag** is a read-it-later application: it saves a web page by 8**wallabag** is a read-it-later application: it saves a web page by
9keeping content only. Elements like navigation or ads are deleted. 9keeping content only. Elements like navigation or ads are deleted.
10 10
11.. tip::
12
13 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>`__.
14
15The main documentation for this application is organized into a couple sections: 11The main documentation for this application is organized into a couple sections:
16 12
17* :ref:`user-docs` 13* :ref:`user-docs`
@@ -20,7 +16,7 @@ The main documentation for this application is organized into a couple sections:
20The documentation is available in other languages: 16The documentation is available in other languages:
21 17
22* `Documentation en français <http://doc.wallabag.org/fr/master/>`_ 18* `Documentation en français <http://doc.wallabag.org/fr/master/>`_
23* `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_ 19* `Dokumentation in Deutsch <http://doc.wallabag.org/de/master/>`_
24 20
25.. _user-docs: 21.. _user-docs:
26 22
@@ -28,25 +24,19 @@ The documentation is available in other languages:
28 :maxdepth: 2 24 :maxdepth: 2
29 :caption: User documentation 25 :caption: User documentation
30 26
31 user/faq
32 user/installation 27 user/installation
33 user/upgrade-2.0.x-2.1.1 28 user/upgrade
34 user/upgrade-2.1.x-2.1.y 29 user/configuration
35 user/migration
36 user/import 30 user/import
37 user/create_account 31 user/create_account
38 user/login 32 user/articles
39 user/configuration
40 user/first_article
41 user/errors_during_fetching 33 user/errors_during_fetching
42 user/annotations
43 user/download_articles
44 user/share
45 user/filters 34 user/filters
46 user/tags 35 user/tags
47 user/android 36 user/android
48 user/parameters 37 user/parameters
49 user/backup 38 user/backup
39 user/faq
50 40
51.. _dev-docs: 41.. _dev-docs:
52 42
@@ -59,5 +49,4 @@ The documentation is available in other languages:
59 developer/documentation 49 developer/documentation
60 developer/translate 50 developer/translate
61 developer/maintenance 51 developer/maintenance
62 developer/redis 52 developer/asynchronous
63 developer/rabbitmq
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
index 91dcb2fc..e286bb3b 100644
--- a/docs/en/user/android.rst
+++ b/docs/en/user/android.rst
@@ -1,13 +1,11 @@
1Android App 1Android application
2=========== 2===================
3
4 3
5Purpose of this document 4Purpose of this document
6------------------------ 5------------------------
7 6
8This 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. 7This 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.
9 8
10
11Steps to configure your app 9Steps to configure your app
12--------------------------- 10---------------------------
13 11
@@ -23,7 +21,7 @@ Just confirm that message and you get redirected to the settings screen.
23 :alt: Settings screen 21 :alt: Settings screen
24 :align: center 22 :align: center
25 23
26Fill 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. 24Fill 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.
27 25
28.. image:: ../../img/user/android_configuration_filled_in.en.png 26.. image:: ../../img/user/android_configuration_filled_in.en.png
29 :alt: Filled in settings 27 :alt: Filled in settings
@@ -59,49 +57,39 @@ Now you need to scroll to the bottom of the settings menu. Of course you can adj
59 :alt: Bottom of the settings screen 57 :alt: Bottom of the settings screen
60 :align: center 58 :align: center
61 59
62After 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. 60After 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.
63 61
64.. image:: ../../img/user/android_configuration_saved_feed_update.en.png 62.. image:: ../../img/user/android_configuration_saved_feed_update.en.png
65 :alt: Settings saved the first time 63 :alt: Settings saved the first time
66 :align: center 64 :align: center
67 65
68Finally after the synchronisation finished successfully, you are presented to the list of unread articles. 66Finally after the synchronization finished successfully, you are presented to the list of unread articles.
69 67
70.. image:: ../../img/user/android_unread_feed_synced.en.png 68.. image:: ../../img/user/android_unread_feed_synced.en.png
71 :alt: Filled article list cause feeds successfully synchronized 69 :alt: Filled article list cause feeds successfully synchronized
72 :align: center 70 :align: center
73 71
74
75
76Known limitations 72Known limitations
77----------------- 73-----------------
78 74
792FA 75Two factor authentication (2FA)
80~~~ 76~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81 77
82Currently the Android application does not support two-factor authentication. You should disable that to get the application working. 78Currently the Android application does not support two-factor authentication. You should disable that to get the application working.
83 79
84
85Limited amount of articles with wallabag v2 80Limited amount of articles with wallabag v2
86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 81~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 82
88In 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. 83In 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.
89 84
90
91SSL/TLS encryption 85SSL/TLS encryption
92~~~~~~~~~~~~~~~~~~ 86~~~~~~~~~~~~~~~~~~
93 87
94If 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. 88If 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.
95 89
96
97References 90References
98---------- 91----------
99 92
100`Source code of the Android application <https://github.com/wallabag/android-app>`_ 93- `Source code of the Android application <https://github.com/wallabag/android-app>`_
101 94- `Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
102`Android Application on F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_ 95- `Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
103
104`Android Application on Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
105
106`Support chat <https://gitter.im/wallabag/wallabag>`_
107
diff --git a/docs/en/user/annotations.rst b/docs/en/user/annotations.rst
deleted file mode 100644
index fab854aa..00000000
--- a/docs/en/user/annotations.rst
+++ /dev/null
@@ -1,24 +0,0 @@
1Annotations
2===========
3
4In each article you read, you can write annotations. It's easier to understand with some pictures.
5
6Select the part of the article that you want to annotate and click on the pencil:
7
8.. image:: ../../img/user/annotations_1.png
9 :alt: Select your text
10 :align: center
11
12Then, write your annotation:
13
14.. image:: ../../img/user/annotations_2.png
15 :alt: Write your annotation
16 :align: center
17
18The text is now highlighted and you can read your annotation if you move the mouse cursor over it.
19
20.. image:: ../../img/user/annotations_3.png
21 :alt: Read your annotation
22 :align: center
23
24You can create as many annotations as you wish.
diff --git a/docs/en/user/articles.rst b/docs/en/user/articles.rst
new file mode 100644
index 00000000..16b3b0d2
--- /dev/null
+++ b/docs/en/user/articles.rst
@@ -0,0 +1,116 @@
1Articles
2========
3
4Save your first article
5-----------------------
6
7The 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>`_.
8
9By using a bookmarklet
10^^^^^^^^^^^^^^^^^^^^^^
11
12On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!``
13link to your bookmarks bar of your browser.
14
15Now, each time you're reading an article on the web and you want to save it,
16click on the ``bag it!`` link in your bookmarks bar. The article is saved.
17
18By using the classic form
19^^^^^^^^^^^^^^^^^^^^^^^^^
20
21In the top bar of your screen, you have 3 icons. With the first one, a plus sign,
22you can easily save a new article.
23
24.. image:: ../../img/user/topbar.png
25 :alt: Top bar
26 :align: center
27
28Click on it to display a new field, paste the article URL inside and press your
29``Return`` key. The article is saved.
30
31By using a browser add-on
32^^^^^^^^^^^^^^^^^^^^^^^^^
33
34Firefox
35"""""""
36
37You can download the `Firefox addon here <https://addons.mozilla.org/firefox/addon/wallabag-v2/>`_.
38
39Chrome
40""""""
41
42You can download the `Chrome addon here <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_.
43
44By using your smarphone application
45^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
46
47Android
48"""""""
49
50You can download the `Android application here <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_.
51
52Windows Phone
53"""""""""""""
54
55You can downlaod the `Windows Phone application here <https://www.microsoft.com/store/apps/9nblggh5x3p6>`_.
56
57Download your articles
58----------------------
59
60You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV.
61
62On the article view, click on this icon, in the sidebar:
63
64.. image:: ../../img/user/download_article.png
65 :alt: download article
66 :align: center
67
68You can also download a full category (unread, starred, archive) in these formats.
69For example, on **Unread** view, click on this icon in the top bar:
70
71.. image:: ../../img/user/download_articles.png
72 :alt: download articles
73 :align: center
74
75Share your articles
76-------------------
77
78When you're reading an article, you can share it. Just click on the share button:
79
80.. image:: ../../img/user/share.png
81 :alt: share article
82 :align: center
83
84Now, you can share the article:
85
86- with a public URL (you'll have a light view of the article)
87- with a tweet
88- into your Shaarli
89- with a post in Diaspora*
90- to Carrot
91- with an email
92
93Annotate your articles
94----------------------
95
96In each article you read, you can write annotations. It's easier to understand with some pictures.
97
98Select the part of the article that you want to annotate and click on the pencil:
99
100.. image:: ../../img/user/annotations_1.png
101 :alt: Select your text
102 :align: center
103
104Then, write your annotation:
105
106.. image:: ../../img/user/annotations_2.png
107 :alt: Write your annotation
108 :align: center
109
110The text is now highlighted and you can read your annotation if you move the mouse cursor over it.
111
112.. image:: ../../img/user/annotations_3.png
113 :alt: Read your annotation
114 :align: center
115
116You can create as many annotations as you wish.
diff --git a/docs/en/user/backup.rst b/docs/en/user/backup.rst
index 51721000..f8b480a3 100644
--- a/docs/en/user/backup.rst
+++ b/docs/en/user/backup.rst
@@ -1,5 +1,6 @@
1Backup wallabag 1Backup wallabag
2=============== 2===============
3
3Because 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. 4Because 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.
4This articles describes what you need to backup. 5This articles describes what you need to backup.
5 6
@@ -22,4 +23,4 @@ To backup the SQLite database, you just need to copy the directory `data/db` fro
22 23
23Images 24Images
24------ 25------
25The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2). 26The images retrieved by wallabag are stored under `web/assets/images` (the images storage will be implemented in wallabag 2.2).
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
index a6edcd4a..2c1385a8 100644
--- a/docs/en/user/configuration.rst
+++ b/docs/en/user/configuration.rst
@@ -48,8 +48,8 @@ User information
48 48
49You can change your name, your email address and enable ``Two factor authentication``. 49You can change your name, your email address and enable ``Two factor authentication``.
50 50
51Two factor authentication 51Two factor authentication (2FA)
52~~~~~~~~~~~~~~~~~~~~~~~~~ 52~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 53
54 Two-factor authentication (also known as 2FA) is a technology patented in 1984 54 Two-factor authentication (also known as 2FA) is a technology patented in 1984
55 that provides identification of users by means of the combination of two different components. 55 that provides identification of users by means of the combination of two different components.
diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst
index 2e883c88..8c43867d 100644
--- a/docs/en/user/create_account.rst
+++ b/docs/en/user/create_account.rst
@@ -1,5 +1,8 @@
1Create an account 1Create an account and authentication
2================= 2====================================
3
4Register
5--------
3 6
4On the login page, click on ``Register`` button. 7On the login page, click on ``Register`` button.
5 8
@@ -23,3 +26,17 @@ Your account is now activated.
23.. image:: ../../img/user/activated_account.png 26.. image:: ../../img/user/activated_account.png
24 :alt: Welcome on board! 27 :alt: Welcome on board!
25 :align: center 28 :align: center
29
30Login
31-----
32
33Your account is now enabled, congratulations!
34
35To login to wallabag, fill the form on login page.
36
37If you are on your personal computer and you want to stay connected,
38you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year.
39
40.. image:: ../../img/user/login_form.png
41 :alt: Login form
42 :align: center
diff --git a/docs/en/user/download_articles.rst b/docs/en/user/download_articles.rst
deleted file mode 100644
index 4813776d..00000000
--- a/docs/en/user/download_articles.rst
+++ /dev/null
@@ -1,17 +0,0 @@
1Download articles
2=================
3
4You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV.
5
6On the article view, click on this icon, in the sidebar:
7
8.. image:: ../../img/user/download_article.png
9 :alt: download article
10 :align: center
11
12You can also download a full category (unread, starred, archive) in these formats.
13For example, on **Unread** view, click on this icon in the top bar:
14
15.. image:: ../../img/user/download_articles.png
16 :alt: download articles
17 :align: center
diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst
index 6684563a..c5e18d3b 100644
--- a/docs/en/user/errors_during_fetching.rst
+++ b/docs/en/user/errors_during_fetching.rst
@@ -12,9 +12,7 @@ There may be several reasons:
12How can I help to fix that? 12How can I help to fix that?
13--------------------------- 13---------------------------
14 14
15You can `sending us an email with the article's URL <mailto:hello@wallabag.org>`_. 15You can try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ).
16
17Or you can also try to fix this problem by yourself (so we can be focused on improving wallabag internally instead of writing siteconfig :) ).
18 16
19You 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). 17You 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).
20 18
diff --git a/docs/en/user/filters.rst b/docs/en/user/filters.rst
index ad06819b..4d1df6eb 100644
--- a/docs/en/user/filters.rst
+++ b/docs/en/user/filters.rst
@@ -1,7 +1,7 @@
1Filters 1Retrieve your articles thanks to filters
2======= 2========================================
3 3
4To retrieve articles easier, you can use filters. 4To retrieve articles easily, you can use filters.
5Click on the third icon in the top bar. 5Click on the third icon in the top bar.
6 6
7.. image:: ../../img/user/topbar.png 7.. image:: ../../img/user/topbar.png
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index 38cd30c1..a6754fa0 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -1,8 +1,20 @@
1Migrate from a third service 1Migrate from ...
2============================ 2================
3 3
4From Pocket 4In wallabag 2.x, you can import data from:
5----------- 5
6- `Pocket <#id1>`_
7- `Readability <#id2>`_
8- `Instapaper <#id4>`_
9- `wallabag 1.x <#id6>`_
10- `wallabag 2.x <#id7>`_
11
12We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_.
13
14Because 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).
15
16Pocket
17------
6 18
7Create a new application on Pocket 19Create a new application on Pocket
8~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 20~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -29,8 +41,8 @@ and then on ``Connect to Pocket and import data``.
29You need to authorize wallabag to interact with your Pocket account. 41You need to authorize wallabag to interact with your Pocket account.
30Your data will be imported. Data import can be a demanding process for your server. 42Your data will be imported. Data import can be a demanding process for your server.
31 43
32From Readability 44Readability
33---------------- 45-----------
34 46
35Export your Readability data 47Export your Readability data
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 48~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,8 +57,8 @@ and then select your json file and upload it.
45 57
46Your data will be imported. Data import can be a demanding process for your server. 58Your data will be imported. Data import can be a demanding process for your server.
47 59
48From Instapaper 60Instapaper
49--------------- 61----------
50 62
51Export your Instapaper data 63Export your Instapaper data
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 64~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -61,7 +73,66 @@ and then select your CSV file and upload it.
61 73
62Your data will be imported. Data import can be a demanding process for your server. 74Your data will be imported. Data import can be a demanding process for your server.
63 75
64From HTML or JSON file 76wallabag 1.x
65---------------------- 77------------
78
79If 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.
80
81.. image:: ../../img/user/export_v1.png
82 :alt: Exporting from wallabag v1
83 :align: center
84
85.. note::
86 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
87
88.. note::
89 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
90
91When 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>`__.
92
93After 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.
94
95.. image:: ../../img/user/import_wallabagv1.png
96 :alt: Import from wallabag v1
97 :align: center
98
99wallabag 2.x
100------------
101
102From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
103
104.. image:: ../../img/user/export_v2.png
105 :alt: Export depuis wallabag v2
106 :align: center
107
108From 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.
109
110.. note::
111 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
112
113Import via command-line interface (CLI)
114---------------------------------------
115
116If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
117
118::
119
120 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
121
122Please replace values:
123
124* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
125* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
126
127If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
128
129To import a wallabag v2 file, you need to add the option ``--importer=v2``.
130
131You'll have this in return:
132
133::
66 134
67*Feature not yet implemented in wallabag v2.* 135 Start : 05-04-2016 11:36:07 ---
136 403 imported
137 0 already saved
138 End : 05-04-2016 11:36:09 ---
diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst
deleted file mode 100644
index e66089bd..00000000
--- a/docs/en/user/login.rst
+++ /dev/null
@@ -1,13 +0,0 @@
1Login
2=====
3
4Your account is now enabled, congratulations!
5
6To login to wallabag, fill the form on login page.
7
8If you are on your personal computer and you want to stay connected,
9you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year.
10
11.. image:: ../../img/user/login_form.png
12 :alt: Login form
13 :align: center
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst
deleted file mode 100644
index 42062796..00000000
--- a/docs/en/user/migration.rst
+++ /dev/null
@@ -1,66 +0,0 @@
1Migrate from v1 or v2
2=====================
3
4From wallabag 1.x
5-----------------
6
7If 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.
8
9.. image:: ../../img/user/export_v1.png
10 :alt: Exporting from wallabag v1
11 :align: center
12
13.. note::
14 If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data.
15
16.. note::
17 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
18
19When 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>`__.
20
21After 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.
22
23.. image:: ../../img/user/import_wallabagv1.png
24 :alt: Import from wallabag v1
25 :align: center
26
27From wallabag 2.x
28-----------------
29
30From the previous wallabag instance on which you were before, go to `All articles`, then export these articles as json.
31
32.. image:: ../../img/user/export_v2.png
33 :alt: Export depuis wallabag v2
34 :align: center
35
36From 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.
37
38.. note::
39 If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__.
40
41Import via command-line interface (CLI)
42---------------------------------------
43
44If you have a CLI access on your web server, you can execute this command to import your wallabag v1 export:
45
46::
47
48 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
49
50Please replace values:
51
52* ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1)
53* ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export
54
55If you want to mark all these entries as read, you can add the ``--markAsRead`` option.
56
57To import a wallabag v2 file, you need to add the option ``--importer=v2``.
58
59You'll have this in return:
60
61::
62
63 Start : 05-04-2016 11:36:07 ---
64 403 imported
65 0 already saved
66 End : 05-04-2016 11:36:09 ---
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
index 6cbd5ae4..2b02a34d 100644
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -1,5 +1,48 @@
1What is the meaning of the parameters? 1What is the meaning of the parameters?
2====================================== 2======================================
3
4Default `parameters.yml` file
5-----------------------------
6
7Here is the last version of the default `app/config/parameters.yml` file. Be sure that yours respects this one.
8If you don't know which value you need to set, please leave the default one.
9
10.. code-block:: yml
11
12 parameters:
13 database_driver: pdo_sqlite
14 database_host: 127.0.0.1
15 database_port: null
16 database_name: symfony
17 database_user: root
18 database_password: null
19 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
20 database_table_prefix: wallabag_
21 database_socket: null
22 mailer_transport: smtp
23 mailer_host: 127.0.0.1
24 mailer_user: null
25 mailer_password: null
26 locale: en
27 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
28 twofactor_auth: true
29 twofactor_sender: no-reply@wallabag.org
30 fosuser_registration: true
31 fosuser_confirmation: true
32 from_email: no-reply@wallabag.org
33 rss_limit: 50
34 rabbitmq_host: localhost
35 rabbitmq_port: 5672
36 rabbitmq_user: guest
37 rabbitmq_password: guest
38 redis_scheme: tcp
39 redis_host: localhost
40 redis_port: 6379
41 redis_path: null
42
43Meaning of each parameter
44-------------------------
45
3.. csv-table:: Database parameters 46.. csv-table:: Database parameters
4 :header: "name", "default", "description" 47 :header: "name", "default", "description"
5 48
diff --git a/docs/en/user/upgrade-2.1.x-2.1.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst
deleted file mode 100644
index fb41a07b..00000000
--- a/docs/en/user/upgrade-2.1.x-2.1.y.rst
+++ /dev/null
@@ -1,30 +0,0 @@
1Upgrading from 2.1.x to 2.1.y
2=============================
3
4Upgrade on a dedicated web server
5---------------------------------
6
7The 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):
8
9::
10
11 make update
12
13Upgrade on a shared hosting
14---------------------------
15
16Backup your ``app/config/parameters.yml`` file.
17
18Download the last release of wallabag:
19
20.. code-block:: bash
21
22 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
23
24You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
25
26Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
27
28If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
29
30Empty ``var/cache`` folder.
diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade.rst
index 3b39fc8c..544d57eb 100644
--- a/docs/en/user/upgrade-2.0.x-2.1.1.rst
+++ b/docs/en/user/upgrade.rst
@@ -1,12 +1,21 @@
1Upgrade your wallabag installation
2==================================
3
4You will find here different ways to upgrade your wallabag:
5
6- `from 2.0.x to 2.1.1 <#upgrade-from-2-0-x-to-2-1-1>`_
7- `from 2.1.x to 2.1.y <#upgrading-from-2-1-x-to-2-1-y>`_
8- `from 1.x to 2.x <#from-wallabag-1-x>`_
9
1Upgrade from 2.0.x to 2.1.1 10Upgrade from 2.0.x to 2.1.1
2=========================== 11---------------------------
3 12
4.. warning:: 13.. warning::
5 14
6 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. 15 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.
7 16
8Upgrade on a dedicated web server 17Upgrade on a dedicated web server
9--------------------------------- 18^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10 19
11:: 20::
12 21
@@ -19,11 +28,11 @@ Upgrade on a dedicated web server
19 php bin/console cache:clear --env=prod 28 php bin/console cache:clear --env=prod
20 29
21Upgrade on a shared hosting 30Upgrade on a shared hosting
22--------------------------- 31^^^^^^^^^^^^^^^^^^^^^^^^^^^
23 32
24Backup your ``app/config/parameters.yml`` file. 33Backup your ``app/config/parameters.yml`` file.
25 34
26Download the last release of wallabag: 35Download the 2.1.1 release of wallabag:
27 36
28.. code-block:: bash 37.. code-block:: bash
29 38
@@ -33,42 +42,7 @@ Download the last release of wallabag:
33 42
34Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. 43Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
35 44
36Please 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. 45Please 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>`_.
37
38.. code-block:: yml
39
40 parameters:
41 database_driver: pdo_sqlite
42 database_host: 127.0.0.1
43 database_port: null
44 database_name: symfony
45 database_user: root
46 database_password: null
47 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
48 database_table_prefix: wallabag_
49 database_socket: null
50 mailer_transport: smtp
51 mailer_host: 127.0.0.1
52 mailer_user: null
53 mailer_password: null
54 locale: en
55 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
56 twofactor_auth: true
57 twofactor_sender: no-reply@wallabag.org
58 fosuser_registration: true
59 fosuser_confirmation: true
60 from_email: no-reply@wallabag.org
61 rss_limit: 50
62 rabbitmq_host: localhost
63 rabbitmq_port: 5672
64 rabbitmq_user: guest
65 rabbitmq_password: guest
66 redis_scheme: tcp
67 redis_host: localhost
68 redis_port: 6379
69 redis_path: null
70
71You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
72 46
73If you use SQLite, you must also copy your ``data/`` folder inside the new installation. 47If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
74 48
@@ -85,3 +59,45 @@ You must run some SQL queries to upgrade your database. We assume that the table
85 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); 59 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
86 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; 60 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
87 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; 61 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
62
63Upgrading from 2.1.x to 2.1.y
64-----------------------------
65
66Upgrade on a dedicated web server
67^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
68
69In order to upgrade your wallabag installation and get the last version, run the following command in you wallabag folder:
70
71::
72
73 make update
74
75Upgrade on a shared hosting
76^^^^^^^^^^^^^^^^^^^^^^^^^^^
77
78Backup your ``app/config/parameters.yml`` file.
79
80Download the last release of wallabag:
81
82.. code-block:: bash
83
84 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
85
86You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
87
88Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
89
90Please 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>`_.
91
92If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
93
94Empty ``var/cache`` folder.
95
96From wallabag 1.x
97-----------------
98
99There is no automatic script to update from wallabag 1.x to wallabag 2.x. You need to:
100
101- export your data
102- install wallabag 2.x (`read the installation documentation <http://doc.wallabag.org/en/master/user/installation.html>`_ )
103- import data in this fresh installation (`read the import documentation <http://doc.wallabag.org/en/master/user/import.html>`_ )
diff --git a/docs/fr/developer/asynchronous.rst b/docs/fr/developer/asynchronous.rst
new file mode 100644
index 00000000..c5489228
--- /dev/null
+++ b/docs/fr/developer/asynchronous.rst
@@ -0,0 +1,159 @@
1Tâches asynchrones
2==================
3
4Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ ou Redis.
5
6Installer RabbitMQ pour des tâches asynchrones
7----------------------------------------------
8
9Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ.
10
11Pré-requis
12^^^^^^^^^^
13
14Vous devez installer RabbitMQ sur votre serveur.
15
16Installation
17^^^^^^^^^^^^
18
19.. code:: bash
20
21 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
22 apt-key add rabbitmq-signing-key-public.asc
23 apt-get update
24 apt-get install rabbitmq-server
25
26Configuration et démarrage
27^^^^^^^^^^^^^^^^^^^^^^^^^^
28
29.. code:: bash
30
31 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
32 rabbitmq-server -detached
33
34Arrêter RabbitMQ
35^^^^^^^^^^^^^^^^
36
37.. code:: bash
38
39 rabbitmqctl stop
40
41Configurer RabbitMQ dans wallabag
42^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43
44Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir :
45
46.. code:: yaml
47
48 rabbitmq_host: localhost
49 rabbitmq_port: 5672
50 rabbitmq_user: guest
51 rabbitmq_password: guest
52
53Activer RabbitMQ dans wallabag
54^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
55
56Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1).
57
58Démarrer les clients RabbitMQ
59^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
60
61En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
62
63.. code:: bash
64
65 # for Pocket import
66 bin/console rabbitmq:consumer -e=prod import_pocket -w
67
68 # for Readability import
69 bin/console rabbitmq:consumer -e=prod import_readability -w
70
71 # for Instapaper import
72 bin/console rabbitmq:consumer -e=prod import_instapaper -w
73
74 # for wallabag v1 import
75 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
76
77 # for wallabag v2 import
78 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
79
80 # for Firefox import
81 bin/console rabbitmq:consumer -e=prod import_firefox -w
82
83 # for Chrome import
84 bin/console rabbitmq:consumer -e=prod import_chrome -w
85
86Installer Redis pour des tâches asynchrones
87-------------------------------------------
88
89Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis.
90
91Pré-requis
92^^^^^^^^^^
93
94Vous devez installer Redis sur votre serveur.
95
96Installation
97^^^^^^^^^^^^
98
99.. code:: bash
100
101 apt-get install redis-server
102
103Démarrage
104^^^^^^^^^
105
106Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas le cas, vous pouvez le démarrer ainsi :
107
108.. code:: bash
109
110 redis-server
111
112Configurer Redis dans wallabag
113^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
114
115Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir :
116
117.. code:: yaml
118
119 redis_host: localhost
120 redis_port: 6379
121
122Activer Redis dans wallabag
123^^^^^^^^^^^^^^^^^^^^^^^^^^^
124
125Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1).
126
127Démarrer les clients Redis
128^^^^^^^^^^^^^^^^^^^^^^^^^^
129
130En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
131
132.. code:: bash
133
134 # for Pocket import
135 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
136
137 # for Readability import
138 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
139
140 # for Instapaper import
141 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
142
143 # for wallabag v1 import
144 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
145
146 # for wallabag v2 import
147 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
148
149 # for Firefox import
150 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
151
152 # for Chrome import
153 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
154
155Si 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 :
156
157.. code:: bash
158
159 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst
deleted file mode 100644
index b534a48b..00000000
--- a/docs/fr/developer/rabbitmq.rst
+++ /dev/null
@@ -1,80 +0,0 @@
1Installer RabbitMQ pour des tâches asynchrones
2==============================================
3
4Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ.
5
6Pré-requis
7----------
8
9Vous devez installer RabbitMQ sur votre serveur.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
17 apt-key add rabbitmq-signing-key-public.asc
18 apt-get update
19 apt-get install rabbitmq-server
20
21Configuration et démarrage
22~~~~~~~~~~~~~~~~~~~~~~~~~~
23
24.. code:: bash
25
26 rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest)
27 rabbitmq-server -detached
28
29Arrêter RabbitMQ
30~~~~~~~~~~~~~~~~
31
32.. code:: bash
33
34 rabbitmqctl stop
35
36
37Configurer RabbitMQ dans wallabag
38---------------------------------
39
40Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir :
41
42.. code:: yaml
43
44 rabbitmq_host: localhost
45 rabbitmq_port: 5672
46 rabbitmq_user: guest
47 rabbitmq_password: guest
48
49Activer RabbitMQ dans wallabag
50------------------------------
51
52Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1).
53
54Démarrer les clients RabbitMQ
55-----------------------------
56
57En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
58
59.. code:: bash
60
61 # for Pocket import
62 bin/console rabbitmq:consumer -e=prod import_pocket -w
63
64 # for Readability import
65 bin/console rabbitmq:consumer -e=prod import_readability -w
66
67 # for Instapaper import
68 bin/console rabbitmq:consumer -e=prod import_instapaper -w
69
70 # for wallabag v1 import
71 bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w
72
73 # for wallabag v2 import
74 bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w
75
76 # for Firefox import
77 bin/console rabbitmq:consumer -e=prod import_firefox -w
78
79 # for Chrome import
80 bin/console rabbitmq:consumer -e=prod import_chrome -w
diff --git a/docs/fr/developer/redis.rst b/docs/fr/developer/redis.rst
deleted file mode 100644
index 58204d57..00000000
--- a/docs/fr/developer/redis.rst
+++ /dev/null
@@ -1,75 +0,0 @@
1Installer Redis pour des tâches asynchrones
2===========================================
3
4Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis.
5
6Pré-requis
7----------
8
9Vous devez installer Redis sur votre serveur.
10
11Installation
12~~~~~~~~~~~~
13
14.. code:: bash
15
16 apt-get install redis-server
17
18Démarrage
19~~~~~~~~~
20
21Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas le cas, vous pouvez le démarrer ainsi :
22
23.. code:: bash
24
25 redis-server
26
27
28Configurer Redis dans wallabag
29-------------------------------
30
31Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir :
32
33.. code:: yaml
34
35 redis_host: localhost
36 redis_port: 6379
37
38Activer Redis dans wallabag
39---------------------------
40
41Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1).
42
43Démarrer les clients Redis
44--------------------------
45
46En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job :
47
48.. code:: bash
49
50 # for Pocket import
51 bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log
52
53 # for Readability import
54 bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log
55
56 # for Instapaper import
57 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log
58
59 # for wallabag v1 import
60 bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log
61
62 # for wallabag v2 import
63 bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log
64
65 # for Firefox import
66 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
67
68 # for Chrome import
69 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log
70
71Si 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 :
72
73.. code:: bash
74
75 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index dbb85910..564ffe52 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -9,10 +9,6 @@ Documentation de wallabag
9simplement d’archiver une page web en ne conservant que le contenu. Les 9simplement d’archiver une page web en ne conservant que le contenu. Les
10éléments superflus (menu, publicité, etc.) sont supprimés. 10éléments superflus (menu, publicité, etc.) sont supprimés.
11 11
12.. tip::
13
14 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>`__.
15
16La documentation principale de cette application est découpée en plusieurs sections : 12La documentation principale de cette application est découpée en plusieurs sections :
17 13
18* :ref:`user-docs` 14* :ref:`user-docs`
@@ -29,24 +25,19 @@ La documentation est disponible dans d'autres langues :
29 :maxdepth: 2 25 :maxdepth: 2
30 :caption: Documentation utilisateur 26 :caption: Documentation utilisateur
31 27
32 user/faq
33 user/installation 28 user/installation
34 user/upgrade-2.0.x-2.1.1 29 user/upgrade
35 user/upgrade-2.0.x-2.1.1 30 user/configuration
36 user/migration
37 user/import 31 user/import
38 user/create_account 32 user/create_account
39 user/login 33 user/articles
40 user/configuration
41 user/first_article
42 user/errors_during_fetching 34 user/errors_during_fetching
43 user/annotations
44 user/download_articles
45 user/share
46 user/filters 35 user/filters
47 user/tags 36 user/tags
37 user/android
48 user/parameters 38 user/parameters
49 user/backup 39 user/backup
40 user/faq
50 41
51.. _dev-docs: 42.. _dev-docs:
52 43
@@ -59,5 +50,4 @@ La documentation est disponible dans d'autres langues :
59 developer/documentation 50 developer/documentation
60 developer/translate 51 developer/translate
61 developer/maintenance 52 developer/maintenance
62 developer/redis 53 developer/asynchronous
63 developer/rabbitmq
diff --git a/docs/fr/user/android.rst b/docs/fr/user/android.rst
new file mode 100644
index 00000000..91501eea
--- /dev/null
+++ b/docs/fr/user/android.rst
@@ -0,0 +1,96 @@
1Application Android
2===================
3
4But de ce document
5------------------
6
7Ce 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.
8
9Étapes pour configurer votre application
10----------------------------------------
11
12Quand 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.
13
14.. image:: ../../img/user/android_welcome_screen.en.png
15 :alt: Écran de bienvenue
16 :align: center
17
18Vous devez confirmer le message et vous serez redirigé vers l'écran de configuration.
19
20.. image:: ../../img/user/android_configuration_screen.en.png
21 :alt: Écran de configuration
22 :align: center
23
24Saisissez 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.
25
26.. image:: ../../img/user/android_configuration_filled_in.en.png
27 :alt: Paramètres remplis
28 :align: center
29
30Après cet écran, appuyez sur le bouton de test de connexion et attendez que le test se termine.
31
32.. image:: ../../img/user/android_configuration_connection_test.en.png
33 :alt: Test de connexion
34 :align: center
35
36Le test de connexion devrait se terminer avec succès. Si ce n'est pas le cas, vous devez résoudre ça avant de continuer.
37
38.. image:: ../../img/user/android_configuration_connection_test_success.en.png
39 :alt: Test de connexion réussi
40 :align: center
41
42Aprè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.
43
44.. image:: ../../img/user/android_configuration_get_feed_credentials.en.png
45 :alt: Récupération des informations de flux
46 :align: center
47
48Quand le processus est terminé avec succès, vous verrez une notification comme quoi l'identifiant et le jeton ont été remplis correctement.
49
50.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png
51 :alt: Récupération des informations correcte
52 :align: center
53
54Maintenant, 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.
55
56.. image:: ../../img/user/android_configuration_scroll_bottom.en.png
57 :alt: Bottom of the settings screen
58 :align: center
59
60Aprè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.
61
62.. image:: ../../img/user/android_configuration_saved_feed_update.en.png
63 :alt: Settings saved the first time
64 :align: center
65
66Une fois la synchronisation terminée avec succès, vous pouvez lire vos articles.
67
68.. image:: ../../img/user/android_unread_feed_synced.en.png
69 :alt: Filled article list cause feeds successfully synchronized
70 :align: center
71
72Limitations connues
73-------------------
74
75Double authentification (2FA)
76~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77
78Actuellement, l'application Android ne supporte la double authentification. Vous devez la désactiver pour que l'application fonctionne correctement.
79
80Limiter le nombre d'articles avec wallabag v2
81~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
82
83Dans 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.
84
85Cryptage SSL/TLS
86~~~~~~~~~~~~~~~~
87
88Si 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.
89
90Références
91----------
92
93- `Code source de l'application Android <https://github.com/wallabag/android-app>`_
94- `Télécharger l'application Android sur F-Droid <https://f-droid.org/repository/browse/?fdfilter=wallabag&fdid=fr.gaulupeau.apps.InThePoche>`_
95- `Télécharger l'application Android sur Google Play <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_
96
diff --git a/docs/fr/user/annotations.rst b/docs/fr/user/annotations.rst
deleted file mode 100644
index 24585961..00000000
--- a/docs/fr/user/annotations.rst
+++ /dev/null
@@ -1,25 +0,0 @@
1Annotations
2===========
3
4Sur chaque article que vous lisez, vous pouvez écrire des annotations. Puisqu'une image vaut mieux qu'un long discours,
5voici ce que ça donne.
6
7Sélectionnez la zone du texte que vous souhaitez annoter et cliquez sur le crayon :
8
9.. image:: ../../img/user/annotations_1.png
10 :alt: Sélectionnez votre texte
11 :align: center
12
13Ensuite, écrivez votre annotation :
14
15.. image:: ../../img/user/annotations_2.png
16 :alt: Écrivez votre annotation
17 :align: center
18
19Le texte est maintenant surligné et vous pouvez lire le annotation en le survolant avec votre souris.
20
21.. image:: ../../img/user/annotations_3.png
22 :alt: Lisez votre annotation
23 :align: center
24
25Vous pouvez créer autant de annotations que vous le souhaitez.
diff --git a/docs/fr/user/articles.rst b/docs/fr/user/articles.rst
new file mode 100644
index 00000000..fb5b3837
--- /dev/null
+++ b/docs/fr/user/articles.rst
@@ -0,0 +1,123 @@
1Articles
2========
3
4Sauvegardez votre premier article
5---------------------------------
6
7La fonctionnalité principale de wallabag est de sauvegarder des articles.
8Vous avez plusieurs manières de le faire.
9
10.. note::
11
12 Un guide de démarrage s'affichera dans l'application jusqu'à ce que vous
13 enregistriez votre premier article.
14
15En utilisant le bookmarklet
16^^^^^^^^^^^^^^^^^^^^^^^^^^^
17
18Sur la page ``Aide``, vous avez un onglet ``Bookmarklet``. Glissez/déposez le lien ``bag it!``
19dans votre barre de favoris de votre navigateur.
20
21Maintennat, à chaque fois que vous lisez un article et que vous souhaitez le sauvegarder,
22cliquez sur le lien ``bag it!`` dans votre barre de favoris. L'article est enregistré.
23
24En utilisant le formulaire classique
25^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26
27Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icône,
28un signe plus, vous pouvez facilement ajouter un nouvel article.
29
30.. image:: ../../img/user/topbar.png
31 :alt: Barre supérieure
32 :align: center
33
34Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez
35sur la touche ``Entrée``. L'article est enregistré.
36
37En utilisant l'extension de votre navigateur
38^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
39
40Firefox
41"""""""
42
43Vous pouvez télécharger `l'extension Firefox ici <https://addons.mozilla.org/firefox/addon/wallabag-v2/>`_.
44
45Chrome
46""""""
47
48Vous pouvez télécharger `l'extension Chrome ici <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_.
49
50En utilisant l'application de votre smartphone
51^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
52
53Android
54"""""""
55
56Vous pouvez télécharger `l'application Android ici <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_.
57
58Windows Phone
59~~~~~~~~~~~~~
60
61Vous pouvez télécharger `l'application Windows Phone ici <https://www.microsoft.com/store/apps/9nblggh5x3p6>`_.
62
63Téléchargez vos articles
64------------------------
65
66Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PDF, XML, JSON, CSV.
67
68Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale :
69
70.. image:: ../../img/user/download_article.png
71 :alt: Télécharger l'article
72 :align: center
73
74Vous pouvez aussi télécharger une catégorie (non lus, favoris, lus) dans ces formats.
75Par exemple, dans la vue **Non lus**, cliquez sur cette icône dans la barre supérieure :
76
77.. image:: ../../img/user/download_articles.png
78 :alt: Télécharger l'article
79 :align: center
80
81Partagez vos articles
82---------------------
83
84Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage :
85
86.. image:: ../../img/user/share.png
87 :alt: partager un article
88 :align: center
89
90Vous pouvez maintenant le partager :
91
92- avec une URL publique (vous obtiendrez une vue allégée de l'article)
93- avec un tweet
94- dans votre Shaarli
95- avec un message dans Diaspora*
96- sur Carrot
97- avec un email
98
99Annotez vos articles
100--------------------
101
102Sur chaque article que vous lisez, vous pouvez écrire des annotations. Puisqu'une image vaut mieux qu'un long discours,
103voici ce que ça donne.
104
105Sélectionnez la zone du texte que vous souhaitez annoter et cliquez sur le crayon :
106
107.. image:: ../../img/user/annotations_1.png
108 :alt: Sélectionnez votre texte
109 :align: center
110
111Ensuite, écrivez votre annotation :
112
113.. image:: ../../img/user/annotations_2.png
114 :alt: Écrivez votre annotation
115 :align: center
116
117Le texte est maintenant surligné et vous pouvez lire le annotation en le survolant avec votre souris.
118
119.. image:: ../../img/user/annotations_3.png
120 :alt: Lisez votre annotation
121 :align: center
122
123Vous pouvez créer autant de annotations que vous le souhaitez.
diff --git a/docs/fr/user/backup.rst b/docs/fr/user/backup.rst
index ec4b1f4d..f8cf87ee 100644
--- a/docs/fr/user/backup.rst
+++ b/docs/fr/user/backup.rst
@@ -23,4 +23,4 @@ Pour sauvegarder une base SQLite, vous devez juste copier le répertoire `data/d
23 23
24Images 24Images
25------ 25------
26Les images sauvegardées par wallabag sont stockées dans `data/assets/images` (le stockage des images sera implémenté dans wallabag 2.2). 26Les images sauvegardées par wallabag sont stockées dans `web/assets/images` (le stockage des images sera implémenté dans wallabag 2.2).
diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst
index 6e188ab3..9c18e094 100644
--- a/docs/fr/user/create_account.rst
+++ b/docs/fr/user/create_account.rst
@@ -1,5 +1,8 @@
1Se créer un compte et se connecter
2==================================
3
1Se créer un compte 4Se créer un compte
2================== 5------------------
3 6
4Sur la page de connexion, cliquez sur le bouton ``Créer un compte``. 7Sur la page de connexion, cliquez sur le bouton ``Créer un compte``.
5 8
@@ -23,3 +26,17 @@ Votre compte est maintenant actif.
23.. image:: ../../img/user/activated_account.png 26.. image:: ../../img/user/activated_account.png
24 :alt: Bienvenue à bord ! 27 :alt: Bienvenue à bord !
25 :align: center 28 :align: center
29
30Se connecter
31------------
32
33Votre compte est maintenant actif, félicitations !
34
35Pour vous connecter à wallabag, remplissez le formulaire de connexion.
36
37Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connecté
38vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an.
39
40.. image:: ../../img/user/login_form.png
41 :alt: Formulaire de connexion
42 :align: center
diff --git a/docs/fr/user/download_articles.rst b/docs/fr/user/download_articles.rst
deleted file mode 100644
index 39c98206..00000000
--- a/docs/fr/user/download_articles.rst
+++ /dev/null
@@ -1,17 +0,0 @@
1Télécharger des articles
2========================
3
4Vous pouvez télécharger chaque article dans plusieurs formats : ePUB, MOBI, PDF, XML, JSON, CSV.
5
6Lorsque vous lisez un article, cliquez sur cette icône dans la barre latérale :
7
8.. image:: ../../img/user/download_article.png
9 :alt: Télécharger l'article
10 :align: center
11
12Vous pouvez aussi télécharger une catégorie (non lus, favoris, lus) dans ces formats.
13Par exemple, dans la vue **Non lus**, cliquez sur cette icône dans la barre supérieure :
14
15.. image:: ../../img/user/download_articles.png
16 :alt: Télécharger l'article
17 :align: center
diff --git a/docs/fr/user/errors_during_fetching.rst b/docs/fr/user/errors_during_fetching.rst
index 1a60e4bd..13cbde1d 100644
--- a/docs/fr/user/errors_during_fetching.rst
+++ b/docs/fr/user/errors_during_fetching.rst
@@ -12,9 +12,7 @@ Il peut y avoir plusieurs raisons :
12Comment puis-je aider pour réparer ça ? 12Comment puis-je aider pour réparer ça ?
13--------------------------------------- 13---------------------------------------
14 14
15Vous pouvez `nous envoyer un email avec l'URL de l'article <mailto:hello@wallabag.org>`_. 15Vous 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 :) ).
16
17Ou 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 :) ).
18 16
19Vous 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). 17Vous 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).
20 18
diff --git a/docs/fr/user/filters.rst b/docs/fr/user/filters.rst
index 6592f140..449bf010 100644
--- a/docs/fr/user/filters.rst
+++ b/docs/fr/user/filters.rst
@@ -1,5 +1,5 @@
1Filtres 1Retrouver des articles grâce aux filtres
2======= 2========================================
3 3
4Pour retrouver plus facilement vos articles, vous pouvez utiliser les filtres. 4Pour retrouver plus facilement vos articles, vous pouvez utiliser les filtres.
5Cliquez sur la troisième icône de la barre supérieure. 5Cliquez sur la troisième icône de la barre supérieure.
diff --git a/docs/fr/user/first_article.rst b/docs/fr/user/first_article.rst
deleted file mode 100644
index f482badc..00000000
--- a/docs/fr/user/first_article.rst
+++ /dev/null
@@ -1,68 +0,0 @@
1Sauvegardez votre premier article
2=================================
3
4La fonctionnalité principale de wallabag est de sauvegarder des articles.
5Vous avez plusieurs manières de le faire.
6
7.. note::
8
9 Un guide de démarrage s'affichera dans l'application jusqu'à ce que vous
10 enregistriez votre premier article.
11
12En utilisant le bookmarklet
13---------------------------
14
15Sur la page ``Aide``, vous avez un onglet ``Bookmarklet``. Glissez/déposez le lien ``bag it!``
16dans votre barre de favoris de votre navigateur.
17
18Maintennat, à chaque fois que vous lisez un article et que vous souhaitez le sauvegarder,
19cliquez sur le lien ``bag it!`` dans votre barre de favoris. L'article est enregistré.
20
21En utilisant le formulaire classique
22------------------------------------
23
24Dans la barre haut de wallabag, vous avez trois icônes. Avec la première icône,
25un signe plus, vous pouvez facilement ajouter un nouvel article.
26
27.. image:: ../../img/user/topbar.png
28 :alt: Barre supérieure
29 :align: center
30
31Cliquez dessus pour afficher un nouveau champ, collez-y l'URL de l'article et appuyez
32sur la touche ``Entrée``. L'article est enregistré.
33
34En utilisant l'extension de votre navigateur
35--------------------------------------------
36
37Firefox
38~~~~~~~
39
40*Cette extension n'est pas encore disponible pour wallabag v2*.
41
42Chrome
43~~~~~~
44
45*Cette extension n'est pas encore disponible pour wallabag v2*.
46
47En utilisant l'application de votre smartphone
48----------------------------------------------
49
50Android
51~~~~~~~
52
53*Cette application n'est pas encore disponible pour wallabag v2*.
54
55Firefox OS
56~~~~~~~~~~
57
58*Cette application n'est pas encore disponible pour wallabag v2*.
59
60Windows Phone
61~~~~~~~~~~~~~
62
63*Cette application n'est pas encore disponible pour wallabag v2*.
64
65iOS
66~~~
67
68*Cette application n'est pas encore disponible pour wallabag v2*.
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst
index 33062a33..a5d53247 100644
--- a/docs/fr/user/import.rst
+++ b/docs/fr/user/import.rst
@@ -1,8 +1,20 @@
1Migrer depuis un service externe 1Migrer depuis ...
2================================ 2=================
3 3
4Depuis Pocket 4Dans wallabag 2.x, vous pouvez importer des données depuis :
5------------- 5
6- `Pocket <#id1>`_
7- `Readability <#id2>`_
8- `Instapaper <#id4>`_
9- `wallabag 1.x <#id6>`_
10- `wallabag 2.x <#id7>`_
11
12Nous avons aussi développé `un script pour exécuter des migrations via la ligne de commande <#import-via-la-ligne-de-commande-cli>`_.
13
14Puisque 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).
15
16Pocket
17------
6 18
7Créer une nouvelle application dans Pocket 19Créer une nouvelle application dans Pocket
8~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 20~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -30,8 +42,8 @@ Vous devez autoriser wallabag à se connecter à votre compte Pocket.
30Vos données vont être importées. L'import de données est une action qui peut être couteuse 42Vos données vont être importées. L'import de données est une action qui peut être couteuse
31pour votre serveur. 43pour votre serveur.
32 44
33Depuis Readability 45Readability
34------------------ 46-----------
35 47
36Exportez vos données de Readability 48Exportez vos données de Readability
37~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 49~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -46,8 +58,8 @@ la section Readability et ensuite sélectionnez votre fichier json pour l'upload
46 58
47Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur. 59Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur.
48 60
49Depuis Instapaper 61Instapaper
50----------------- 62----------
51 63
52Exportez vos données de Instapaper 64Exportez vos données de Instapaper
53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 65~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -62,8 +74,66 @@ la section Instapaper et ensuite sélectionnez votre fichier CSV pour l'uploader
62 74
63Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur. 75Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur.
64 76
77wallabag 1.x
78------------
79
80Si 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.
81
82.. image:: ../../img/user/export_v1.png
83 :alt: Export depuis wallabag v1
84 :align: center
85
86.. note::
87 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.
88
89.. note::
90 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>`_.
91
92Une 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>`_.
93
94Une 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.
95
96.. image:: ../../img/user/import_wallabagv1.png
97 :alt: Import depuis wallabag v1
98 :align: center
99
100wallabag 2.x
101------------
102
103Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json.
104
105.. image:: ../../img/user/export_v2.png
106 :alt: Export depuis wallabag v2
107 :align: center
108
109Depuis 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.
110
111.. note::
112 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>`_.
113
114Import via la ligne de commande (CLI)
115-------------------------------------<http://doc.wallabag.org/en/master/user/parameters.html
116
117Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 :
118
119::
120
121 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
122
123Remplacez les valeurs :
124
125* ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1)
126* ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1
127
128Si vous voulez marquer tous ces articles comme lus, vous pouvez ajouter l'option ``--markAsRead``.
129
130Pour importer un fichier wallabag v2, vous devez ajouter l'option ``--importer=v2``.
131
132Vous obtiendrez :
65 133
66Depuis un fichier HTML ou JSON 134::
67------------------------------
68 135
69*Fonctionnalité pas encore implémentée dans wallabag v2.* 136 Start : 05-04-2016 11:36:07 ---
137 403 imported
138 0 already saved
139 End : 05-04-2016 11:36:09 --- \ No newline at end of file
diff --git a/docs/fr/user/login.rst b/docs/fr/user/login.rst
deleted file mode 100644
index 522ac259..00000000
--- a/docs/fr/user/login.rst
+++ /dev/null
@@ -1,13 +0,0 @@
1Se connecter
2============
3
4Votre compte est maintenant actif, félicitations !
5
6Pour vous connecter à wallabag, remplissez le formulaire de connexion.
7
8Si vous êtes sur un ordinateur de confiance et que vous souhaitez rester connecté
9vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous pour un an.
10
11.. image:: ../../img/user/login_form.png
12 :alt: Formulaire de connexion
13 :align: center
diff --git a/docs/fr/user/migration.rst b/docs/fr/user/migration.rst
deleted file mode 100644
index 91f8bab2..00000000
--- a/docs/fr/user/migration.rst
+++ /dev/null
@@ -1,66 +0,0 @@
1Migrer depuis la v1 ou la v2
2============================
3
4Depuis wallabag 1.x
5-------------------
6
7Si 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.
8
9.. image:: ../../img/user/export_v1.png
10 :alt: Export depuis wallabag v1
11 :align: center
12
13.. note::
14 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.
15
16.. note::
17 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>`__.
18
19Une 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>`__.
20
21Une 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.
22
23.. image:: ../../img/user/import_wallabagv1.png
24 :alt: Import depuis wallabag v1
25 :align: center
26
27Depuis wallabag 2.x
28-------------------
29
30Depuis l'instance sur laquelle vous étiez, rendez-vous dans la section `Tous les articles`, puis exportez ces articles au format json.
31
32.. image:: ../../img/user/export_v2.png
33 :alt: Export depuis wallabag v2
34 :align: center
35
36Depuis 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.
37
38.. note::
39 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>`__.
40
41Import via la ligne de commande (CLI)
42-------------------------------------
43
44Si vous avez accès à la ligne de commandes de votre serveur web, vous pouvez exécuter cette commande pour import votre fichier wallabag v1 :
45
46::
47
48 bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod
49
50Remplacez les valeurs :
51
52* ``1`` est l'identifiant de votre utilisateur en base (l'ID de votre premier utilisateur créé sur wallabag est 1)
53* ``~/Downloads/wallabag-export-1-2016-04-05.json`` est le chemin de votre export wallabag v1
54
55Si vous voulez marquer tous ces articles comme lus, vous pouvez ajouter l'option ``--markAsRead``.
56
57Pour importer un fichier wallabag v2, vous devez ajouter l'option ``--importer=v2``.
58
59Vous obtiendrez :
60
61::
62
63 Start : 05-04-2016 11:36:07 ---
64 403 imported
65 0 already saved
66 End : 05-04-2016 11:36:09 ---
diff --git a/docs/fr/user/parameters.rst b/docs/fr/user/parameters.rst
index ec8c8995..d1c20ceb 100644
--- a/docs/fr/user/parameters.rst
+++ b/docs/fr/user/parameters.rst
@@ -1,5 +1,48 @@
1À quoi servent les paramètres ? 1À quoi servent les paramètres ?
2=============================== 2===============================
3
4Fichier `parameters.yml` par défaut
5-----------------------------------
6
7Voici la dernière version par défaut du fichier `app/config/parameters.yml`. Soyez sur que le votre respecte celui-ci.
8Si vous ne savez pas quelle valeur vous devez mettre, laissez celle par défaut.
9
10.. code-block:: yml
11
12 parameters:
13 database_driver: pdo_sqlite
14 database_host: 127.0.0.1
15 database_port: null
16 database_name: symfony
17 database_user: root
18 database_password: null
19 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
20 database_table_prefix: wallabag_
21 database_socket: null
22 mailer_transport: smtp
23 mailer_host: 127.0.0.1
24 mailer_user: null
25 mailer_password: null
26 locale: en
27 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
28 twofactor_auth: true
29 twofactor_sender: no-reply@wallabag.org
30 fosuser_registration: true
31 fosuser_confirmation: true
32 from_email: no-reply@wallabag.org
33 rss_limit: 50
34 rabbitmq_host: localhost
35 rabbitmq_port: 5672
36 rabbitmq_user: guest
37 rabbitmq_password: guest
38 redis_scheme: tcp
39 redis_host: localhost
40 redis_port: 6379
41 redis_path: null
42
43Meaning of each parameter
44-------------------------
45
3.. csv-table:: Paramètres de base de données 46.. csv-table:: Paramètres de base de données
4 :header: "name", "default", "description" 47 :header: "name", "default", "description"
5 48
diff --git a/docs/fr/user/share.rst b/docs/fr/user/share.rst
deleted file mode 100644
index b5faa5ba..00000000
--- a/docs/fr/user/share.rst
+++ /dev/null
@@ -1,17 +0,0 @@
1Partager des articles
2=====================
3
4Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage :
5
6.. image:: ../../img/user/share.png
7 :alt: partager un article
8 :align: center
9
10Vous pouvez maintenant le partager :
11
12- avec une URL publique (vous obtiendrez une vue allégée de l'article)
13- avec un tweet
14- dans votre Shaarli
15- avec un message dans Diaspora*
16- sur Carrot
17- avec un email
diff --git a/docs/fr/user/upgrade-2.0.x-2.1.1.rst b/docs/fr/user/upgrade-2.0.x-2.1.1.rst
deleted file mode 100644
index f74c2fcd..00000000
--- a/docs/fr/user/upgrade-2.0.x-2.1.1.rst
+++ /dev/null
@@ -1,87 +0,0 @@
1Mettre à jour de la 2.0.x à la 2.1.1
2====================================
3
4.. warning::
5Avant 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.
6
7Mise à jour sur un serveur dédié
8--------------------------------
9
10::
11
12 rm -rf var/cache/*
13 git fetch origin
14 git fetch --tags
15 git checkout 2.1.1 --force
16 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
17 php bin/console doctrine:migrations:migrate --env=prod
18 php bin/console cache:clear --env=prod
19
20Mise à jour sur un hébergement mutualisé
21----------------------------------------
22
23Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
24
25Téléchargez la dernière version de wallabag :
26
27.. code-block:: bash
28
29 wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
30
31(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``)
32
33Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
34
35Vé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.
36
37.. code-block:: yml
38
39 parameters:
40 database_driver: pdo_sqlite
41 database_host: 127.0.0.1
42 database_port: null
43 database_name: symfony
44 database_user: root
45 database_password: null
46 database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite'
47 database_table_prefix: wallabag_
48 database_socket: null
49 mailer_transport: smtp
50 mailer_host: 127.0.0.1
51 mailer_user: null
52 mailer_password: null
53 locale: en
54 secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv
55 twofactor_auth: true
56 twofactor_sender: no-reply@wallabag.org
57 fosuser_registration: true
58 fosuser_confirmation: true
59 from_email: no-reply@wallabag.org
60 rss_limit: 50
61 rabbitmq_host: localhost
62 rabbitmq_port: 5672
63 rabbitmq_user: guest
64 rabbitmq_password: guest
65 redis_scheme: tcp
66 redis_host: localhost
67 redis_port: 6379
68 redis_path: null
69
70Vous trouverez `ici une documentation détaillée concernant les paramètres <http://doc.wallabag.org/fr/master/user/parameters.html>`_.
71
72Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
73
74Videz le répertoire ``var/cache``.
75
76Vous 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 :
77
78.. code-block:: sql
79
80 ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
81 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
82 ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
83 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
84 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
85 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
86 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
87
diff --git a/docs/fr/user/upgrade-2.1.x-2.1.y.rst b/docs/fr/user/upgrade-2.1.x-2.1.y.rst
deleted file mode 100644
index 2d3b452b..00000000
--- a/docs/fr/user/upgrade-2.1.x-2.1.y.rst
+++ /dev/null
@@ -1,30 +0,0 @@
1Mettre à jour de la 2.1.x à la 2.1.y
2====================================
3
4Mise à jour sur un serveur dédié
5--------------------------------
6
7La 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) :
8
9::
10
11 make update
12
13Mise à jour sur un hébergement mutualisé
14----------------------------------------
15
16Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
17
18Téléchargez la dernière version de wallabag :
19
20.. code-block:: bash
21
22 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
23
24Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
25
26Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
27
28Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
29
30Videz le répertoire ``var/cache``.
diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst
new file mode 100644
index 00000000..c3d33904
--- /dev/null
+++ b/docs/fr/user/upgrade.rst
@@ -0,0 +1,102 @@
1Mettre à jour votre installation de wallabag
2============================================
3
4Vous trouverez ici différentes manières de mettre à jour wallabag :
5
6- `de la 2.0.x à la 2.1.1 <#mettre-a-jour-de-la-2-0-x-a-la-2-1-1>`_
7- `de la 2.1.x à la 2.1.y <#mettre-a-jour-de-la-2-1-x-a-la-2-1-y>`_
8- `de la 1.x à la 2.x <#depuis-wallabag-1-x>`_
9
10Mettre à jour de la 2.0.x à la 2.1.1
11------------------------------------
12
13.. warning::
14Avant 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.
15
16Mise à jour sur un serveur dédié
17^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18
19::
20
21 rm -rf var/cache/*
22 git fetch origin
23 git fetch --tags
24 git checkout 2.1.1 --force
25 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
26 php bin/console doctrine:migrations:migrate --env=prod
27 php bin/console cache:clear --env=prod
28
29Mise à jour sur un hébergement mutualisé
30^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
31
32Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
33
34Téléchargez la version 2.1.1 de wallabag :
35
36.. code-block:: bash
37
38 wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz
39
40(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``)
41
42Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
43
44Merci 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>`_.
45
46Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
47
48Videz le répertoire ``var/cache``.
49
50Vous 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 :
51
52.. code-block:: sql
53
54 ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL;
55 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry');
56 ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL;
57 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import');
58 INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import');
59 ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL;
60 DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key';
61
62Mettre à jour de la 2.1.x à la 2.1.y
63------------------------------------
64
65Mise à jour sur un serveur dédié
66^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67
68Pour 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 :
69
70::
71
72 make update
73
74Mise à jour sur un hébergement mutualisé
75^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
76
77Effectuez une sauvegarde du fichier ``app/config/parameters.yml``.
78
79Téléchargez la dernière version de wallabag :
80
81.. code-block:: bash
82
83 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
84
85Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
86
87Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
88
89Merci 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>`_.
90
91Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
92
93Videz le répertoire ``var/cache``.
94
95Depuis wallabag 1.x
96-------------------
97
98Il n'y a pas de script automatique pour mettre à jour wallabag 1.x en wallabag 2.x. Vous devez :
99
100- exportez vos données
101- installer wallabag 2.x (`lisez la documentation d'installation <http://doc.wallabag.org/fr/master/user/installation.html>`_ )
102- importer vos données dans votre installation toute propre (`lisez la documentation d'import <http://doc.wallabag.org/fr/master/user/import.html>`_ )
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-03 23:49:13 +0000