aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/de/developer/maintenance.rst32
-rw-r--r--docs/de/index.rst1
-rw-r--r--docs/de/user/configuration.rst8
-rw-r--r--docs/de/user/filters.rst5
-rw-r--r--docs/de/user/import.rst48
-rw-r--r--docs/en/developer/maintenance.rst32
-rw-r--r--docs/en/index.rst1
-rw-r--r--docs/en/user/configuration.rst11
-rw-r--r--docs/en/user/filters.rst5
-rw-r--r--docs/en/user/import.rst32
-rw-r--r--docs/en/user/parameters.rst1
-rw-r--r--docs/fr/developer/maintenance.rst33
-rw-r--r--docs/fr/index.rst1
-rw-r--r--docs/fr/user/configuration.rst11
-rw-r--r--docs/fr/user/filters.rst5
-rw-r--r--docs/fr/user/import.rst34
16 files changed, 143 insertions, 117 deletions
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/index.rst b/docs/de/index.rst
index 28a47200..c1ce7d4b 100644
--- a/docs/de/index.rst
+++ b/docs/de/index.rst
@@ -48,5 +48,4 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
48 developer/docker 48 developer/docker
49 developer/documentation 49 developer/documentation
50 developer/translate 50 developer/translate
51 developer/maintenance
52 developer/asynchronous 51 developer/asynchronous
diff --git a/docs/de/user/configuration.rst b/docs/de/user/configuration.rst
index 3fb501eb..c0a8cd67 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
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..e657e336 100644
--- a/docs/de/user/import.rst
+++ b/docs/de/user/import.rst
@@ -42,6 +42,53 @@ 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
45<<<<<<< HEAD
46Von Readability
47----------------
48
49Exportiere deine Readability Daten
50~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51
52Auf 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).
53
54Importiere deine Daten in wallabag 2.x
55~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56
57Klicke 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.
58
59Deine Daten werden importiert. Der Datenimport can ein beanspruchender Prozess für deinen Server sein.
60
61Von Pinboard
62-------------
63
64Exportiere deine Pinboard Daten
65~~~~~~~~~~~~~~~~~~~~~~~~~
66
67Auf 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``).
68
69Importiere deine Daten in wallabag 2.x
70~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71
72Klicke 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.
73
74Deine Daten werden importiert. Der Datenimport can ein beanspruchender Prozess für deinen Server sein.
75
76Von Instapaper
77---------------
78
79Exportiere deine Instapaper Daten
80~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81
82Auf 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``).
83
84Importiere deine Daten in wallabag 2.x
85~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86
87Klicke 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.
88
89Deine Daten werden importiert. Der Datenimport can ein beanspruchender Prozess für deinen Server sein.
90
91=======
45Readability 92Readability
46----------- 93-----------
47 94
@@ -128,6 +175,7 @@ Wenn du alle Artikel als gelesen markieren möchtest, kannst du die ``--markAsRe
128Um eine wallabag 2.x-Datei zu importieren, musst du die Option ``--importer=v2`` hinzufügen. 175Um eine wallabag 2.x-Datei zu importieren, musst du die Option ``--importer=v2`` hinzufügen.
129 176
130Als Ergebnis wirst du so etwas erhalten: 177Als Ergebnis wirst du so etwas erhalten:
178>>>>>>> origin/master
131 179
132:: 180::
133 181
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/index.rst b/docs/en/index.rst
index 77425bfa..54a1eef8 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -48,5 +48,4 @@ The documentation is available in other languages:
48 developer/docker 48 developer/docker
49 developer/documentation 49 developer/documentation
50 developer/translate 50 developer/translate
51 developer/maintenance
52 developer/asynchronous 51 developer/asynchronous
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
index 2c1385a8..a52d3ddd 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
@@ -48,6 +57,8 @@ User information
48 57
49You can change your name, your email address and enable ``Two factor authentication``. 58You can change your name, your email address and enable ``Two factor authentication``.
50 59
60If the wallabag instance has more than one enabled user, you can delete your account here. **Take care, we delete all your data**.
61
51Two factor authentication (2FA) 62Two factor authentication (2FA)
52~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 63~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 64
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..eb312f7e 100644
--- a/docs/en/user/parameters.rst
+++ b/docs/en/user/parameters.rst
@@ -55,6 +55,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" 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_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" 56 "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)" 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_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji"
58 59
59.. csv-table:: Configuration to send emails from wallabag 60.. csv-table:: Configuration to send emails from wallabag
60 :header: "name", "default", "description" 61 :header: "name", "default", "description"
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/index.rst b/docs/fr/index.rst
index 564ffe52..8a4c600a 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -49,5 +49,4 @@ La documentation est disponible dans d'autres langues :
49 developer/docker 49 developer/docker
50 developer/documentation 50 developer/documentation
51 developer/translate 51 developer/translate
52 developer/maintenance
53 developer/asynchronous 52 developer/asynchronous
diff --git a/docs/fr/user/configuration.rst b/docs/fr/user/configuration.rst
index 8ee0a49b..5ce80f58 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
@@ -49,6 +58,8 @@ Mon compte
49 58
50Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double authentification``. 59Vous pouvez ici modifier votre nom, votre adresse email et activer la ``Double authentification``.
51 60
61Si l'instance de wallabag compte plus d'un utilisateur actif, vous pouvez supprimer ici votre compte. **Attention, nous supprimons toutes vos données**.
62
52Double authentification (2FA) 63Double authentification (2FA)
53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 64~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54 65
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 ---