aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/de/developer/asynchronous.rst5
-rw-r--r--docs/de/developer/maintenance.rst32
-rw-r--r--docs/de/developer/paywall.rst56
-rw-r--r--docs/de/developer/translate.rst2
-rw-r--r--docs/de/index.rst2
-rw-r--r--docs/de/user/configuration.rst11
-rw-r--r--docs/de/user/filters.rst5
-rw-r--r--docs/de/user/import.rst47
-rw-r--r--docs/de/user/parameters.rst2
-rw-r--r--docs/en/developer/asynchronous.rst3
-rw-r--r--docs/en/developer/maintenance.rst32
-rw-r--r--docs/en/developer/paywall.rst56
-rw-r--r--docs/en/developer/translate.rst2
-rw-r--r--docs/en/index.rst2
-rw-r--r--docs/en/user/configuration.rst14
-rw-r--r--docs/en/user/filters.rst5
-rw-r--r--docs/en/user/import.rst32
-rw-r--r--docs/en/user/parameters.rst3
-rw-r--r--docs/fr/developer/asynchronous.rst3
-rw-r--r--docs/fr/developer/maintenance.rst33
-rw-r--r--docs/fr/developer/paywall.rst56
-rw-r--r--docs/fr/developer/translate.rst2
-rw-r--r--docs/fr/index.rst2
-rw-r--r--docs/fr/user/configuration.rst14
-rw-r--r--docs/fr/user/filters.rst5
-rw-r--r--docs/fr/user/import.rst34
-rw-r--r--docs/fr/user/parameters.rst2
27 files changed, 322 insertions, 140 deletions
diff --git a/docs/de/developer/asynchronous.rst b/docs/de/developer/asynchronous.rst
index 1d241a72..742dd3e5 100644
--- a/docs/de/developer/asynchronous.rst
+++ b/docs/de/developer/asynchronous.rst
@@ -47,6 +47,7 @@ Bearbeite deine ``app/config/parameters.yml``-Datei, um die RabbitMQ-Parameter z
47 rabbitmq_port: 5672 47 rabbitmq_port: 5672
48 rabbitmq_user: guest 48 rabbitmq_user: guest
49 rabbitmq_password: guest 49 rabbitmq_password: guest
50 rabbitmq_prefetch_count: 10 # lesen http://www.rabbitmq.com/consumer-prefetch.html
50 51
51RabbitMQ in wallabag aktivieren 52RabbitMQ in wallabag aktivieren
52^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 53^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -149,10 +150,10 @@ Abhängig davon, über welchen Service du importieren möchtest, musst du den en
149 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log 150 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
150 151
151 # für den Chrome-Import 152 # 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 bin/console wallabag:import:redis-worker -e=prod chrome -vv >> /path/to/wallabag/var/logs/redis-chrome.log
153 154
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: 155Wenn 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
156.. code:: bash 157.. code:: bash
157 158
158 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 \ No newline at end of file 159 bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12
diff --git a/docs/de/developer/maintenance.rst b/docs/de/developer/maintenance.rst
deleted file mode 100644
index 31343876..00000000
--- a/docs/de/developer/maintenance.rst
+++ /dev/null
@@ -1,32 +0,0 @@
1Wartungsmodus
2=============
3
4Wenn du längere Aufgaben auf deiner wallabag Instanz ausführen willst, kannst du den Wartungsmodus aktivieren.
5Keiner wird dann Zugang zu deiner Instanz haben.
6
7Aktivieren des Wartungsmodus
8----------------------------
9
10Um den Wartungsmodus zu aktivieren, führe folgendes Kommando aus:
11
12::
13
14 bin/console lexik:maintenance:lock -e=prod --no-interaction
15
16Du kannst deine IP Adresse in ``app/config/config.yml`` setzen, wenn du Zugriff zu wallabag haben willst, auch wenn der Wartungsmodus aktiv ist. Zum Beispiel:
17
18::
19
20 lexik_maintenance:
21 authorized:
22 ips: ['127.0.0.1']
23
24
25Deaktivieren des Wartungsmodus
26------------------------
27
28Um den Wartungsmodus zu deaktivieren, führe dieses Kommando aus:
29
30::
31
32 bin/console lexik:maintenance:unlock -e=prod
diff --git a/docs/de/developer/paywall.rst b/docs/de/developer/paywall.rst
new file mode 100644
index 00000000..365027b4
--- /dev/null
+++ b/docs/de/developer/paywall.rst
@@ -0,0 +1,56 @@
1Articles behind a paywall
2=========================
3
4wallabag can fetch articles from websites which use a paywall system.
5
6Enable paywall authentication
7-----------------------------
8
9In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1).
10
11Configure credentials in wallabag
12---------------------------------
13
14Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites:
15
16.. code:: yaml
17
18 sites_credentials:
19 mediapart.fr: {username: "myMediapartLogin", password: "mypassword"}
20 arretsurimages.net: {username: "myASILogin", password: "mypassword"}
21
22.. note::
23
24 These credentials will be shared between each user of your wallabag instance.
25
26Parsing configuration files
27---------------------------
28
29.. note::
30
31 Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ to understand the configuration files.
32
33Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``,
34``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``.
35
36Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated
37on a website where the login form is loaded after the page (by ajax for example).
38
39``login_uri`` is the action URL of the form (``action`` attribute in the form).
40``login_username_field`` is the ``name`` attribute of the login field.
41``login_password_field`` is the ``name`` attribute of the password field.
42
43For example:
44
45.. code::
46
47 title://div[@id="titrage-contenu"]/h1[@class="title"]
48 body: //div[@class="contenu-html"]/div[@class="page-pane"]
49
50 requires_login: yes
51
52 login_uri: http://www.arretsurimages.net/forum/login.php
53 login_username_field: username
54 login_password_field: password
55
56 not_logged_in_xpath: //body[@class="not-logged-in"]
diff --git a/docs/de/developer/translate.rst b/docs/de/developer/translate.rst
index 50e136ea..10544e31 100644
--- a/docs/de/developer/translate.rst
+++ b/docs/de/developer/translate.rst
@@ -20,7 +20,7 @@ der ISO 639-1 Code deiner Sprache ist (`siehe Wikipedia <https://en.wikipedia.or
20Andere Dateien zum Übersetzen: 20Andere Dateien zum Übersetzen:
21 21
22- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. 22- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
23- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations. 23- https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations.
24 24
25Du musst die ``THE_TRANSLATION_FILE.CODE.yml`` Dateien erstellen. 25Du musst die ``THE_TRANSLATION_FILE.CODE.yml`` Dateien erstellen.
26 26
diff --git a/docs/de/index.rst b/docs/de/index.rst
index 28a47200..1c3e4873 100644
--- a/docs/de/index.rst
+++ b/docs/de/index.rst
@@ -46,7 +46,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
46 46
47 developer/api 47 developer/api
48 developer/docker 48 developer/docker
49 developer/paywall
49 developer/documentation 50 developer/documentation
50 developer/translate 51 developer/translate
51 developer/maintenance
52 developer/asynchronous 52 developer/asynchronous
diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst
index 3fb501eb..47c60f4c 100644
--- a/docs/de/user/configuration.rst
+++ b/docs/de/user/configuration.rst
@@ -27,6 +27,14 @@ Lesegeschwindigkeit
27wallabag berechnet die Lesezeit für jeden Artikel. Du kannst hier definieren, dank dieser Liste, ob du 27wallabag berechnet die Lesezeit für jeden Artikel. Du kannst hier definieren, dank dieser Liste, ob du
28ein schneller oder langsamer Leser bist. wallabag wird die Lesezeit für jeden Artikel neu berechnen. 28ein schneller oder langsamer Leser bist. wallabag wird die Lesezeit für jeden Artikel neu berechnen.
29 29
30Wohin möchtest du weitergeleitet werden, nach dem ein Artikel als gelesen markiert wurde?
31~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32
33Jedes Mal, wenn du eine Aktion ausführst (nach dem Markieren eines Artikels als gelesen oder Favorit, nach dem Löschen eines Artikels oder dem Entfernen eines Tag von einem Eintrag), kannst du weitergeleitet werden:
34
35- zur Homepage
36- zur aktuellen Seite
37
30Sprache 38Sprache
31~~~~~~~ 39~~~~~~~
32 40
@@ -44,6 +52,9 @@ Jetzt hast du drei Links, einen für jeden Status: Füge sie in deinem liebsten
44 52
45Du kannst auch definieren wie viele Artikel du in deinem RSS Feed (Standardwert: 50) haben willst. 53Du kannst auch definieren wie viele Artikel du in deinem RSS Feed (Standardwert: 50) haben willst.
46 54
55There is also a pagination available for these feeds. You can add ``?page=2`` to jump to the second page.
56The pagination follow `the RFC <https://tools.ietf.org/html/rfc5005#page-4>`_ about that, which means you'll find the ``next``, ``previous`` & ``last`` page link inside the `<channel>` tag of each RSS feed.
57
47Benutzer-Informationen 58Benutzer-Informationen
48---------------------- 59----------------------
49 60
diff --git a/docs/de/user/filters.rst b/docs/de/user/filters.rst
index c9cda6b6..94b82b24 100644
--- a/docs/de/user/filters.rst
+++ b/docs/de/user/filters.rst
@@ -30,6 +30,11 @@ Sprache
30wallabag (via graby) kann die Artikelsprache erkennen. Es ist einfach für dich, Artikel 30wallabag (via graby) kann die Artikelsprache erkennen. Es ist einfach für dich, Artikel
31in einer bestimmten Sprache zu filtern. 31in einer bestimmten Sprache zu filtern.
32 32
33HTTP status
34-----------
35
36You can retrieve the articles by filtering by their HTTP status code: 200, 404, 500, etc.
37
33Lesezeit 38Lesezeit
34-------- 39--------
35 40
diff --git a/docs/de/user/import.rst b/docs/de/user/import.rst
index 55ab9291..399a1b98 100644
--- a/docs/de/user/import.rst
+++ b/docs/de/user/import.rst
@@ -42,35 +42,50 @@ Du musst wallabag erlauben, mit deinem Pocketaccount zu interagieren.
42Deine 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
43sein (wir müssen daran arbeiten, um diesen Import zu verbessern). 43sein (wir müssen daran arbeiten, um diesen Import zu verbessern).
44 44
45Readability 45Von Readability
46----------- 46----------------
47 47
48Exportiere deine Readability-Daten 48Exportiere deine Readability Daten
49~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50
51Auf der Seite Tools (`https://www.readability.com/tools/ <https://www.readability.com/tools/>`_), klicke auf "Exportiere deine Daten" in dem Abschnitt "Daten Export". Du wirst eine E-Mail empfangen, um eine JSON Datei herunterladen zu können (Datei endet aber nicht auf .json).
52
53Importiere deine Daten in wallabag 2.x
49~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 54~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50 55
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. 56Klicke auf den ``Importieren`` Link im Menü, auf ``Importiere Inhalte`` in dem Readability Abschnitt und wähle dann deine JSON Datei aus und lade sie hoch.
57
58Deine Daten werden importiert. Der Datenimport can ein beanspruchender Prozess für deinen Server sein.
59
60Von Pinboard
61-------------
62
63Exportiere deine Pinboard Daten
64~~~~~~~~~~~~~~~~~~~~~~~~~
65
66Auf der Seite Backup (`https://pinboard.in/settings/backup <https://pinboard.in/settings/backup>`_), klicke auf "JSON" in dem Abschnitt "Lesezeichen". Eine JSON Datei wird heruntergeladen (z.B. ``pinboard_export``).
52 67
53Importiere deine Daten in wallabag 2.x 68Importiere deine Daten in wallabag 2.x
54~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 69~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55 70
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. 71Klicke auf den ``Importieren`` Link im Menü, auf ``Importiere Inhalte`` in dem Pinboard Abschnitt und wähle dann deine JSON Datei aus und lade sie hoch.
57 72
58Deine Daten werden dann importiert. Dies kann eine starke Belastung für den Server sein. 73Deine Daten werden importiert. Der Datenimport can ein beanspruchender Prozess für deinen Server sein.
59 74
60Instapaper 75Von Instapaper
61---------- 76---------------
62 77
63Exportiere deine Instapaper-Daten 78Exportiere deine Instapaper Daten
64~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 79~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65 80
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. 81Auf der Seite Einstellungen (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_), klicke auf "Download .CSV Datei" in dem Abschnitt "Export". Eine CSV Datei wird heruntergeladen (z.B. ``instapaper-export.csv``).
67 82
68Importiere deine Daten in wallabag 2.x 83Importiere deine Daten in wallabag 2.x
69~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 84~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70 85
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. 86Klicke auf den ``Importieren`` Link im Menü, auf ``Importiere Inhalte`` in dem Instapaper Abschnitt und wähle dann deine JSON Datei aus und lade sie hoch.
72 87
73Deine Daten werden dann importiert. Dies kann eine starke Belastung für den Server sein. 88Deine Daten werden importiert. Der Datenimport can ein beanspruchender Prozess für deinen Server sein.
74 89
75wallabag 1.x 90wallabag 1.x
76------------ 91------------
@@ -134,4 +149,4 @@ Als Ergebnis wirst du so etwas erhalten:
134 Start : 05-04-2016 11:36:07 --- 149 Start : 05-04-2016 11:36:07 ---
135 403 imported 150 403 imported
136 0 already saved 151 0 already saved
137 End : 05-04-2016 11:36:09 --- \ No newline at end of file 152 End : 05-04-2016 11:36:09 ---
diff --git a/docs/de/user/parameters.rst b/docs/de/user/parameters.rst
index a5a4e4f2..8d8f9206 100644
--- a/docs/de/user/parameters.rst
+++ b/docs/de/user/parameters.rst
@@ -39,6 +39,7 @@ Wenn du nicht weißt, welchen Wert du setzen sollst, belasse es bei dem Standard
39 redis_host: localhost 39 redis_host: localhost
40 redis_port: 6379 40 redis_port: 6379
41 redis_path: null 41 redis_path: null
42 redis_password: null
42 43
43Bedeutung von jedem Parameter 44Bedeutung von jedem Parameter
44----------------------------- 45-----------------------------
@@ -91,3 +92,4 @@ Bedeutung von jedem Parameter
91 "redis_host", "localhost", "IP oder Hostname des Zielservers (ignoriert bei Unix Schema)" 92 "redis_host", "localhost", "IP oder Hostname des Zielservers (ignoriert bei Unix Schema)"
92 "redis_port", "6379", "TCP/IP Port des Zielservers (ignoriert bei Unix Schema)" 93 "redis_port", "6379", "TCP/IP Port des Zielservers (ignoriert bei Unix Schema)"
93 "redis_path", "null", "Pfad zur Unix Domain Socket Datei, wenn Redis Unix Domain Sockets nutzt" 94 "redis_path", "null", "Pfad zur Unix Domain Socket Datei, wenn Redis Unix Domain Sockets nutzt"
95 "redis_password", "null", "Kennwort, welches in der Redis-Server-Konfiguration definiert ist (Parameter `requirepass` in `redis.conf`)"
diff --git a/docs/en/developer/asynchronous.rst b/docs/en/developer/asynchronous.rst
index 6a991cf6..2e409e4a 100644
--- a/docs/en/developer/asynchronous.rst
+++ b/docs/en/developer/asynchronous.rst
@@ -48,6 +48,7 @@ Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The
48 rabbitmq_port: 5672 48 rabbitmq_port: 5672
49 rabbitmq_user: guest 49 rabbitmq_user: guest
50 rabbitmq_password: guest 50 rabbitmq_password: guest
51 rabbitmq_prefetch_count: 10 # read http://www.rabbitmq.com/consumer-prefetch.html
51 52
52Enable RabbitMQ in wallabag 53Enable RabbitMQ in wallabag
53^^^^^^^^^^^^^^^^^^^^^^^^^^^ 54^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -150,7 +151,7 @@ Depending on which service you want to import from you need to enable one (or ma
150 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log 151 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
151 152
152 # for Chrome import 153 # for Chrome import
153 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log 154 bin/console wallabag:import:redis-worker -e=prod chrome -vv >> /path/to/wallabag/var/logs/redis-chrome.log
154 155
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 : 156If 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
diff --git a/docs/en/developer/maintenance.rst b/docs/en/developer/maintenance.rst
deleted file mode 100644
index 6d55ed60..00000000
--- a/docs/en/developer/maintenance.rst
+++ /dev/null
@@ -1,32 +0,0 @@
1Maintenance mode
2================
3
4If you have some long tasks to do on your wallabag instance, you can enable a maintenance mode.
5Nobody will have access to your instance.
6
7Enable maintenance mode
8-----------------------
9
10To enable maintenance mode, execute this command:
11
12::
13
14 bin/console lexik:maintenance:lock --no-interaction -e=prod
15
16You can set your IP address in ``app/config/config.yml`` if you want to access to wallabag even if maintenance mode is enabled. For example:
17
18::
19
20 lexik_maintenance:
21 authorized:
22 ips: ['127.0.0.1']
23
24
25Disable maintenance mode
26------------------------
27
28To disable maintenance mode, execute this command:
29
30::
31
32 bin/console lexik:maintenance:unlock -e=prod
diff --git a/docs/en/developer/paywall.rst b/docs/en/developer/paywall.rst
new file mode 100644
index 00000000..365027b4
--- /dev/null
+++ b/docs/en/developer/paywall.rst
@@ -0,0 +1,56 @@
1Articles behind a paywall
2=========================
3
4wallabag can fetch articles from websites which use a paywall system.
5
6Enable paywall authentication
7-----------------------------
8
9In internal settings, in the **Article** section, enable authentication for websites with paywall (with the value 1).
10
11Configure credentials in wallabag
12---------------------------------
13
14Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. Here is an example for some french websites:
15
16.. code:: yaml
17
18 sites_credentials:
19 mediapart.fr: {username: "myMediapartLogin", password: "mypassword"}
20 arretsurimages.net: {username: "myASILogin", password: "mypassword"}
21
22.. note::
23
24 These credentials will be shared between each user of your wallabag instance.
25
26Parsing configuration files
27---------------------------
28
29.. note::
30
31 Read `this part of the documentation <http://doc.wallabag.org/en/master/user/errors_during_fetching.html>`_ to understand the configuration files.
32
33Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``,
34``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``.
35
36Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated
37on a website where the login form is loaded after the page (by ajax for example).
38
39``login_uri`` is the action URL of the form (``action`` attribute in the form).
40``login_username_field`` is the ``name`` attribute of the login field.
41``login_password_field`` is the ``name`` attribute of the password field.
42
43For example:
44
45.. code::
46
47 title://div[@id="titrage-contenu"]/h1[@class="title"]
48 body: //div[@class="contenu-html"]/div[@class="page-pane"]
49
50 requires_login: yes
51
52 login_uri: http://www.arretsurimages.net/forum/login.php
53 login_username_field: username
54 login_password_field: password
55
56 not_logged_in_xpath: //body[@class="not-logged-in"]
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst
index d412d3e9..1e5d5009 100644
--- a/docs/en/developer/translate.rst
+++ b/docs/en/developer/translate.rst
@@ -20,7 +20,7 @@ is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org
20Other files to translate: 20Other files to translate:
21 21
22- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. 22- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
23- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations. 23- https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations.
24 24
25You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. 25You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files.
26 26
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 77425bfa..2e20aee6 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -46,7 +46,7 @@ The documentation is available in other languages:
46 46
47 developer/api 47 developer/api
48 developer/docker 48 developer/docker
49 developer/paywall
49 developer/documentation 50 developer/documentation
50 developer/translate 51 developer/translate
51 developer/maintenance
52 developer/asynchronous 52 developer/asynchronous
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
index 2c1385a8..caca834f 100644
--- a/docs/en/user/configuration.rst
+++ b/docs/en/user/configuration.rst
@@ -26,6 +26,15 @@ Reading speed
26wallabag calculates a reading time for each article. You can define here, thanks to this list, if you are 26wallabag calculates a reading time for each article. You can define here, thanks to this list, if you are
27a fast or a slow reader. wallabag will recalculate the reading time for each article. 27a fast or a slow reader. wallabag will recalculate the reading time for each article.
28 28
29Where do you want to be redirected after mark an article as read?
30~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31
32Each time you'll do some actions (after marking an article as read/favorite,
33after deleting an article, after removing a tag from an entry), you can be redirected:
34
35- To the homepage
36- To the current page
37
29Language 38Language
30~~~~~~~~ 39~~~~~~~~
31 40
@@ -43,11 +52,16 @@ Now you have three links, one for each status: add them into your favourite RSS
43 52
44You can also define how many articles you want in each RSS feed (default value: 50). 53You can also define how many articles you want in each RSS feed (default value: 50).
45 54
55There is also a pagination available for these feeds. You can add ``?page=2`` to jump to the second page.
56The pagination follow `the RFC <https://tools.ietf.org/html/rfc5005#page-4>`_ about that, which means you'll find the ``next``, ``previous`` & ``last`` page link inside the `<channel>` tag of each RSS feed.
57
46User information 58User information
47---------------- 59----------------
48 60
49You can change your name, your email address and enable ``Two factor authentication``. 61You can change your name, your email address and enable ``Two factor authentication``.
50 62
63If the wallabag instance has more than one enabled user, you can delete your account here. **Take care, we delete all your data**.
64
51Two factor authentication (2FA) 65Two factor authentication (2FA)
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 66~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 67
diff --git a/docs/en/user/filters.rst b/docs/en/user/filters.rst
index 4d1df6eb..aae8a749 100644
--- a/docs/en/user/filters.rst
+++ b/docs/en/user/filters.rst
@@ -30,6 +30,11 @@ Language
30wallabag (via graby) can detect article language. It's easy to you to retrieve articles 30wallabag (via graby) can detect article language. It's easy to you to retrieve articles
31written in a specific language. 31written in a specific language.
32 32
33HTTP status
34-----------
35
36You can retrieve the articles by filtering by their HTTP status code: 200, 404, 500, etc.
37
33Reading time 38Reading time
34------------ 39------------
35 40
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst
index a6754fa0..f420a131 100644
--- a/docs/en/user/import.rst
+++ b/docs/en/user/import.rst
@@ -1,13 +1,13 @@
1Migrate from ... 1Migrate from ...
2================ 2================
3 3
4In wallabag 2.x, you can import data from: 4In wallabag 2.x, you can import data from:
5 5
6- `Pocket <#id1>`_ 6- `Pocket <#id1>`_
7- `Readability <#id2>`_ 7- `Readability <#id2>`_
8- `Instapaper <#id4>`_ 8- `Instapaper <#id4>`_
9- `wallabag 1.x <#id6>`_ 9- `wallabag 1.x <#id6>`_
10- `wallabag 2.x <#id7>`_ 10- `wallabag 2.x <#id7>`_
11 11
12We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_. 12We also developed `a script to execute migrations via command-line interface <#import-via-command-line-interface-cli>`_.
13 13
@@ -57,8 +57,24 @@ and then select your json file and upload it.
57 57
58Your 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.
59 59
60Instapaper 60From Pinboard
61---------- 61-------------
62
63Export your Pinboard data
64~~~~~~~~~~~~~~~~~~~~~~~~~
65
66On the backup (`https://pinboard.in/settings/backup <https://pinboard.in/settings/backup>`_) page, click on "JSON" in the "Bookmarks" section. A JSON file will be downloaded (like ``pinboard_export``).
67
68Import your data into wallabag 2.x
69~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70
71Click on ``Import`` link in the menu, on ``Import contents`` in Pinboard section
72and then select your json file and upload it.
73
74Your data will be imported. Data import can be a demanding process for your server.
75
76From Instapaper
77---------------
62 78
63Export your Instapaper data 79Export your Instapaper data
64~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 80~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst
index 2b02a34d..d8a209e7 100644
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -39,6 +39,7 @@ If you don't know which value you need to set, please leave the default one.
39 redis_host: localhost 39 redis_host: localhost
40 redis_port: 6379 40 redis_port: 6379
41 redis_path: null 41 redis_path: null
42 redis_password: null
42 43
43Meaning of each parameter 44Meaning of each parameter
44------------------------- 45-------------------------
@@ -55,6 +56,7 @@ Meaning of each parameter
55 "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty for other database" 56 "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty for other database"
56 "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" 57 "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity"
57 "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)" 58 "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)"
59 "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji"
58 60
59.. csv-table:: Configuration to send emails from wallabag 61.. csv-table:: Configuration to send emails from wallabag
60 :header: "name", "default", "description" 62 :header: "name", "default", "description"
@@ -91,3 +93,4 @@ Meaning of each parameter
91 "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)" 93 "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)"
92 "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)" 94 "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)"
93 "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets" 95 "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets"
96 "redis_password", "null", "Password defined in the Redis server configuration (parameter `requirepass` in `redis.conf`)"
diff --git a/docs/fr/developer/asynchronous.rst b/docs/fr/developer/asynchronous.rst
index c5489228..ff22daea 100644
--- a/docs/fr/developer/asynchronous.rst
+++ b/docs/fr/developer/asynchronous.rst
@@ -49,6 +49,7 @@ Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configurati
49 rabbitmq_port: 5672 49 rabbitmq_port: 5672
50 rabbitmq_user: guest 50 rabbitmq_user: guest
51 rabbitmq_password: guest 51 rabbitmq_password: guest
52 rabbitmq_prefetch_count: 10 # lire http://www.rabbitmq.com/consumer-prefetch.html
52 53
53Activer RabbitMQ dans wallabag 54Activer RabbitMQ dans wallabag
54^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 55^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -150,7 +151,7 @@ En fonction du service dont vous souhaitez importer vos données, vous devez act
150 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log 151 bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log
151 152
152 # for Chrome import 153 # for Chrome import
153 bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-chrome.log 154 bin/console wallabag:import:redis-worker -e=prod chrome -vv >> /path/to/wallabag/var/logs/redis-chrome.log
154 155
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 : 156Si 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
diff --git a/docs/fr/developer/maintenance.rst b/docs/fr/developer/maintenance.rst
deleted file mode 100644
index 8007a85f..00000000
--- a/docs/fr/developer/maintenance.rst
+++ /dev/null
@@ -1,33 +0,0 @@
1Mode maintenance
2================
3
4Si vous devez effectuer de longues tâches sur votre instance de wallabag, vous pouvez activer le mode maintenance.
5Plus personne ne pourra accéder à wallabag.
6
7Activer le mode maintenance
8---------------------------
9
10Pour activer le mode maintenance, exécutez cette commande :
11
12::
13
14 bin/console lexik:maintenance:lock --no-interaction -e=prod
15
16Vous pouvez spécifier votre adresse IP dans ``app/config/config.yml`` si vous souhaitez accéder à wallabag même si
17 le mode maintenance est activé. Par exemple :
18
19::
20
21 lexik_maintenance:
22 authorized:
23 ips: ['127.0.0.1']
24
25
26Désactiver le mode maintenance
27------------------------------
28
29Pour désactiver le mode maintenance, exécutez cette commande :
30
31::
32
33 bin/console lexik:maintenance:unlock -e=prod
diff --git a/docs/fr/developer/paywall.rst b/docs/fr/developer/paywall.rst
new file mode 100644
index 00000000..c1c410b1
--- /dev/null
+++ b/docs/fr/developer/paywall.rst
@@ -0,0 +1,56 @@
1Articles derrière un paywall
2============================
3
4wallabag peut récupérer le contenu des articles des sites qui utilisent un système de paiement.
5
6Activer l'authentification pour les paywall
7-------------------------------------------
8
9Dans les paramètres internes, section **Article**, activez l'authentification pour les articles derrière un paywall (avec la valeur 1).
10
11Configurer les accès dans wallabag
12----------------------------------
13
14Éditez le fichier ``app/config/parameters.yml`` pour modifier les accès aux sites avec paywall. Voici un exemple pour certains sites :
15
16.. code:: yaml
17
18 sites_credentials:
19 mediapart.fr: {username: "myMediapartLogin", password: "mypassword"}
20 arretsurimages.net: {username: "myASILogin", password: "mypassword"}
21
22.. note::
23
24 Ces accès seront partagés entre chaque utilisateur de votre instance wallabag.
25
26Fichiers de configuration pour parser les articles
27--------------------------------------------------
28
29.. note::
30
31 Lisez `cette documentation <http://doc.wallabag.org/fr/master/user/errors_during_fetching.html>`_ pour en savoir plus sur ces fichiers de configuration.
32
33Chaque fichier de configuration doit être enrichi en ajoutant ``requires_login``, ``login_uri``,
34``login_username_field``, ``login_password_field`` et ``not_logged_in_xpath``.
35
36Attention, le formulaire de connexion doit se trouver dans le contenu de la page lors du chargement de celle-ci.
37Il sera impossible pour wallabag de se connecter à un site dont le formulaire de connexion est chargé après coup (en ajax par exemple).
38
39``login_uri`` correspond à l'URL à laquelle le formulaire est soumis (attribut ``action`` du formulaire).
40``login_username_field`` correspond à l'attribut ``name`` du champ de l'identifiant.
41``login_password_field`` correspond à l'attribut ``name`` du champ du mot de passe.
42
43Par exemple :
44
45.. code::
46
47 title://div[@id="titrage-contenu"]/h1[@class="title"]
48 body: //div[@class="contenu-html"]/div[@class="page-pane"]
49
50 requires_login: yes
51
52 login_uri: http://www.arretsurimages.net/forum/login.php
53 login_username_field: username
54 login_password_field: password
55
56 not_logged_in_xpath: //body[@class="not-logged-in"]
diff --git a/docs/fr/developer/translate.rst b/docs/fr/developer/translate.rst
index 902c29ad..870d1c20 100644
--- a/docs/fr/developer/translate.rst
+++ b/docs/fr/developer/translate.rst
@@ -21,7 +21,7 @@ où CODE est le code ISO 639-1 de votre langue (`cf wikipedia <https://fr.wikipe
21Autres fichiers à traduire : 21Autres fichiers à traduire :
22 22
23- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. 23- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
24- https://github.com/wallabag/wallabag/tree/master/app/Resources/FOSUserBundle/translations. 24- https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations.
25 25
26Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``. 26Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``.
27 27
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index 564ffe52..e3f14b04 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -47,7 +47,7 @@ La documentation est disponible dans d'autres langues :
47 47
48 developer/api 48 developer/api
49 developer/docker 49 developer/docker
50 developer/paywall
50 developer/documentation 51 developer/documentation
51 developer/translate 52 developer/translate
52 developer/maintenance
53 developer/asynchronous 53 developer/asynchronous
diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst
index 8ee0a49b..025b05bb 100644
--- a/docs/fr/user/configuration.rst
+++ b/docs/fr/user/configuration.rst
@@ -26,6 +26,15 @@ Vitesse de lecture
26 26
27wallabag calcule une durée de lecture pour chaque article. Vous pouvez définir ici, grâce à cette liste déroulante, si vous lisez plus ou moins vite. wallabag recalculera la durée de lecture de chaque article. 27wallabag calcule une durée de lecture pour chaque article. Vous pouvez définir ici, grâce à cette liste déroulante, si vous lisez plus ou moins vite. wallabag recalculera la durée de lecture de chaque article.
28 28
29Où souhaitez-vous être redirigé après avoir marqué un article comme lu ?
30~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31
32Chaque fois que vous ferez certaines actions (après avoir marqué un article comme lu / comme favori,
33après avoir supprimé un article, après avoir retiré un tag d'un article), vous pouvez être redirigé :
34
35- sur la page d'accueil
36- sur la page courante
37
29Langue 38Langue
30~~~~~~ 39~~~~~~
31 40
@@ -44,11 +53,16 @@ Vous avez maintenant trois liens, un par statut : ajoutez-les dans votre agrég
44Vous pouvez aussi définir combien d'articles vous souhaitez dans vos flux RSS 53Vous pouvez aussi définir combien d'articles vous souhaitez dans vos flux RSS
45(50 est la valeur par défaut). 54(50 est la valeur par défaut).
46 55
56Une pagination est aussi disponible pour ces flux. Il suffit de rajouter ``?page=2`` pour aller à la seconde page, par exemple.
57Cette pagination suit `la RFC <https://tools.ietf.org/html/rfc5005#page-4>`_, ce qui signifie que vous trouverez la page suivante (``next``), précédente (``previous``) et la dernière (``last``) dans la balise `<channel>` de chaque flux RSS.
58
47Mon compte 59Mon compte
48---------- 60----------
49 61
50Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double authentification``. 62Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double authentification``.
51 63
64Si l'instance de wallabag compte plus d'un utilisateur actif, vous pouvez supprimer ici votre compte. **Attention, nous supprimons toutes vos données**.
65
52Double authentification (2FA) 66Double authentification (2FA)
53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 67~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54 68
diff --git a/docs/fr/user/filters.rst b/docs/fr/user/filters.rst
index 449bf010..5807bdbd 100644
--- a/docs/fr/user/filters.rst
+++ b/docs/fr/user/filters.rst
@@ -30,6 +30,11 @@ Langage
30wallabag (via graby) peut détecter la langue dans laquelle l'article est écrit. 30wallabag (via graby) peut détecter la langue dans laquelle l'article est écrit.
31C'est ainsi facile pour vous de retrouver des articles écrits dans une langue spécifique. 31C'est ainsi facile pour vous de retrouver des articles écrits dans une langue spécifique.
32 32
33Statut HTTP
34-----------
35
36Vous pouvez retrouver des articles en filtrant par leur code HTTP : 200, 404, 500, etc.
37
33Temps de lecture 38Temps de lecture
34---------------- 39----------------
35 40
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst
index a5d53247..9a2dda8f 100644
--- a/docs/fr/user/import.rst
+++ b/docs/fr/user/import.rst
@@ -1,13 +1,13 @@
1Migrer depuis ... 1Migrer depuis ...
2================= 2=================
3 3
4Dans wallabag 2.x, vous pouvez importer des données depuis : 4Dans wallabag 2.x, vous pouvez importer des données depuis :
5 5
6- `Pocket <#id1>`_ 6- `Pocket <#id1>`_
7- `Readability <#id2>`_ 7- `Readability <#id2>`_
8- `Instapaper <#id4>`_ 8- `Instapaper <#id4>`_
9- `wallabag 1.x <#id6>`_ 9- `wallabag 1.x <#id6>`_
10- `wallabag 2.x <#id7>`_ 10- `wallabag 2.x <#id7>`_
11 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>`_. 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 13
@@ -58,8 +58,24 @@ la section Readability et ensuite sélectionnez votre fichier json pour l'upload
58 58
59Vos 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.
60 60
61Instapaper 61Depuis Pinboard
62---------- 62---------------
63
64Exportez vos données de Pinboard
65~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66
67Sur la page « Backup » (`https://pinboard.in/settings/backup <https://pinboard.in/settings/backup>`_), cliquez sur « JSON » dans la section « Bookmarks ». Un fichier json (sans extension) sera téléchargé (``pinboard_export``).
68
69Importez vos données dans wallabag 2.x
70~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71
72Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans
73la section Pinboard et ensuite sélectionnez votre fichier json pour l'uploader.
74
75Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur.
76
77Depuis Instapaper
78-----------------
63 79
64Exportez vos données de Instapaper 80Exportez vos données de Instapaper
65~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 81~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -136,4 +152,4 @@ Vous obtiendrez :
136 Start : 05-04-2016 11:36:07 --- 152 Start : 05-04-2016 11:36:07 ---
137 403 imported 153 403 imported
138 0 already saved 154 0 already saved
139 End : 05-04-2016 11:36:09 --- \ No newline at end of file 155 End : 05-04-2016 11:36:09 ---
diff --git a/docs/fr/user/parameters.rst b/docs/fr/user/parameters.rst
index d1c20ceb..b2e33524 100644
--- a/docs/fr/user/parameters.rst
+++ b/docs/fr/user/parameters.rst
@@ -39,6 +39,7 @@ Si vous ne savez pas quelle valeur vous devez mettre, laissez celle par défaut.
39 redis_host: localhost 39 redis_host: localhost
40 redis_port: 6379 40 redis_port: 6379
41 redis_path: null 41 redis_path: null
42 redis_password: null
42 43
43Meaning of each parameter 44Meaning of each parameter
44------------------------- 45-------------------------
@@ -91,3 +92,4 @@ Meaning of each parameter
91 "redis_host", "localhost", "IP ou hôte du serveur cible (ignoré pour un schéma unix)" 92 "redis_host", "localhost", "IP ou hôte du serveur cible (ignoré pour un schéma unix)"
92 "redis_port", "6379", "Port TCP/IP du serveur cible (ignoré pour un schéma unix)" 93 "redis_port", "6379", "Port TCP/IP du serveur cible (ignoré pour un schéma unix)"
93 "redis_path", "null", "Chemin du fichier de socket du domaine UNIX utilisé quand on se connecte à Redis en utilisant les sockets du domaine UNIX" 94 "redis_path", "null", "Chemin du fichier de socket du domaine UNIX utilisé quand on se connecte à Redis en utilisant les sockets du domaine UNIX"
95 "redis_password", "null", "Mot de passe défini dans la configuration serveur de Redis (paramètre `requirepass` dans `redis.conf`)"