aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/de/developer/api.rst3
-rw-r--r--docs/de/developer/rabbitmq.rst2
-rw-r--r--docs/de/developer/redis.rst2
-rw-r--r--docs/de/index.rst1
-rw-r--r--docs/de/user/backup.rst25
-rw-r--r--docs/de/user/faq.rst7
-rw-r--r--docs/en/developer/api.rst3
-rw-r--r--docs/en/developer/rabbitmq.rst2
-rw-r--r--docs/en/developer/redis.rst2
-rw-r--r--docs/en/index.rst1
-rw-r--r--docs/en/user/android.rst2
-rw-r--r--docs/en/user/backup.rst25
-rw-r--r--docs/en/user/faq.rst7
-rw-r--r--docs/fr/developer/api.rst3
-rw-r--r--docs/fr/developer/rabbitmq.rst2
-rw-r--r--docs/fr/developer/redis.rst2
-rw-r--r--docs/fr/index.rst1
-rw-r--r--docs/fr/user/backup.rst26
-rw-r--r--docs/fr/user/faq.rst7
19 files changed, 113 insertions, 10 deletions
diff --git a/docs/de/developer/api.rst b/docs/de/developer/api.rst
index f8911181..bb21154d 100644
--- a/docs/de/developer/api.rst
+++ b/docs/de/developer/api.rst
@@ -264,7 +264,8 @@ Drittanbieter Ressourcen
264 264
265Einige Applikationen oder Bibliotheken nutzen unsere API. Hier ist eine nicht abschließende Aufzählung von ihnen: 265Einige Applikationen oder Bibliotheken nutzen unsere API. Hier ist eine nicht abschließende Aufzählung von ihnen:
266 266
267- `Java wrapper for the wallabag API <https://github.com/Strubbl/wallabag-java>`_ von Strubbl. 267- `Java wrapper for the wallabag API <https://github.com/Strubbl/jWallabag>`_ von Strubbl.
268- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ von Julian Oster. 268- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ von Julian Oster.
269- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ von FoxMaSk, für sein Projekt `Trigger Happy <https://blog.trigger-happy.eu/>`_. 269- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ von FoxMaSk, für sein Projekt `Trigger Happy <https://blog.trigger-happy.eu/>`_.
270- `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ entworfen für `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_, das die wallabag v2 API nutzt. Von Josh Panter. 270- `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ entworfen für `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_, das die wallabag v2 API nutzt. Von Josh Panter.
271- `Golang wrapper for the wallabag API <https://github.com/Strubbl/wallabago>`_ von Strubbl, für sein Projekt `wallabag-stats Graph <https://github.com/Strubbl/wallabag-stats>`_.
diff --git a/docs/de/developer/rabbitmq.rst b/docs/de/developer/rabbitmq.rst
index f81e07e3..143b64a1 100644
--- a/docs/de/developer/rabbitmq.rst
+++ b/docs/de/developer/rabbitmq.rst
@@ -37,7 +37,7 @@ RabbitMQ stoppen
37Konfigure RabbitMQ in wallabag 37Konfigure RabbitMQ in wallabag
38------------------------------ 38------------------------------
39 39
40Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein: 40Bearbeite die Datei ``app/config/parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein:
41 41
42.. code:: yaml 42.. code:: yaml
43 43
diff --git a/docs/de/developer/redis.rst b/docs/de/developer/redis.rst
index 57b41550..2505bf24 100644
--- a/docs/de/developer/redis.rst
+++ b/docs/de/developer/redis.rst
@@ -28,7 +28,7 @@ Der Redis Service läuft eventuell schon direkt nach der Installation. Falls nic
28Konfigure Redis in wallabag 28Konfigure Redis in wallabag
29--------------------------- 29---------------------------
30 30
31Bearbeite die Datei ``parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein: 31Bearbeite die Datei ``app/config/parameters.yml``, um die RabbitMQ Konfiguration einzurichten. Die Standardkonfiguration sollte ok sein:
32 32
33.. code:: yaml 33.. code:: yaml
34 34
diff --git a/docs/de/index.rst b/docs/de/index.rst
index a380d7bd..b422bf83 100644
--- a/docs/de/index.rst
+++ b/docs/de/index.rst
@@ -45,6 +45,7 @@ Die Dokumentation ist in anderen Sprachen verfügbar :
45 user/tags 45 user/tags
46 user/android 46 user/android
47 user/parameters 47 user/parameters
48 user/backup
48 49
49.. _dev-docs: 50.. _dev-docs:
50 51
diff --git a/docs/de/user/backup.rst b/docs/de/user/backup.rst
new file mode 100644
index 00000000..ffe3ce37
--- /dev/null
+++ b/docs/de/user/backup.rst
@@ -0,0 +1,25 @@
1wallabag sichern
2================
3Da es manchmal vorkommen kann, dass dir ein Fehler mit deiner wallabag unterläuft und du Daten verlierst oder deine wallabag auf einen anderen Server verschieben willst, ist eine Sicherung der Daten sicher ratsam.
4Dieser Artikel beschreibt, was du für die Sicherung benötigst.
5
6Grundlegende Einstellungen
7--------------------------
8wallabag speichert grundlegende Parameter (etwa der SMTP-Server oder das Datenbank-Backend) in der Datei `app/config/parameters.yml`.
9
10Datenbank
11---------
12Da wallabag verschiedene Datenbank-Typen unterstützt, hängt der Weg der Sicherung von dem verwendeten Typ ab. Daher verweisen wir an dieser Stelle auf die entsprechenden Dokumentationen:
13
14Hier sind einige Beispiele:
15
16- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html
17- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html
18
19SQLite
20~~~~~~
21Um die SQLite-Datenbank zu sichern, ist es lediglich notwendig, das Verzeichnis `data/db` aus dem wallabag-Installations-Ordner zu kopieren.
22
23Bilder
24------
25Die Bilder, die von wallabag empfangen worden, sind unter `data/assets/images` gespeichert (der Bilder-Speicher wird in wallabag 2.2 implementiert).
diff --git a/docs/de/user/faq.rst b/docs/de/user/faq.rst
index 1a199c1c..c14cb3ef 100644
--- a/docs/de/user/faq.rst
+++ b/docs/de/user/faq.rst
@@ -43,3 +43,10 @@ Ich habe mein Passwort vergessen
43 43
44Du kannst dein Passwort zurücksetzen, indem du auf den Link ``Kennwort vergessen?`` auf der Loginseite klickst. Fülle dann das Formular mit deiner E-Mail-Adresse oder deinem Nutzernamen aus 44Du kannst dein Passwort zurücksetzen, indem du auf den Link ``Kennwort vergessen?`` auf der Loginseite klickst. Fülle dann das Formular mit deiner E-Mail-Adresse oder deinem Nutzernamen aus
45und du wirst eine E-Mail zum Passwort zurücksetzen erhalten. 45und du wirst eine E-Mail zum Passwort zurücksetzen erhalten.
46
47Ich erhalte den Fehler ``failed to load external entity``, wenn ich wallabag installiere
48----------------------------------------------------------------------------------------
49
50Wie `hier <https://github.com/wallabag/wallabag/issues/2529>`_ beschrieben, bearbeite bitte deine Datei ``web/app.php`` und füge ihr diese Zeile ``libxml_disable_entity_loader(false);`` in Zeile 5 hinzu.
51
52Dies ist ein Doctrine / PHP Fehler - nichts, woran wir etwas ändern können.
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst
index 4828cddd..b6c9ed3f 100644
--- a/docs/en/developer/api.rst
+++ b/docs/en/developer/api.rst
@@ -263,7 +263,8 @@ Third party resources
263 263
264Some applications or libraries use our API. Here is a non-exhaustive list of them: 264Some applications or libraries use our API. Here is a non-exhaustive list of them:
265 265
266- `Java wrapper for the wallabag API <https://github.com/Strubbl/wallabag-java>`_ by Strubbl. 266- `Java wrapper for the wallabag API <https://github.com/Strubbl/jWallabag>`_ by Strubbl.
267- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster. 267- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster.
268- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_. 268- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_.
269- `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ designed for `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ that makes use of the wallabag v2 API. By Josh Panter. 269- `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ designed for `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ that makes use of the wallabag v2 API. By Josh Panter.
270- `Golang wrapper for the wallabag API <https://github.com/Strubbl/wallabago>`_ by Strubbl, for his project `wallabag-stats graph <https://github.com/Strubbl/wallabag-stats>`_.
diff --git a/docs/en/developer/rabbitmq.rst b/docs/en/developer/rabbitmq.rst
index 673228e9..7ee8a5ce 100644
--- a/docs/en/developer/rabbitmq.rst
+++ b/docs/en/developer/rabbitmq.rst
@@ -37,7 +37,7 @@ Stop RabbitMQ
37Configure RabbitMQ in wallabag 37Configure RabbitMQ in wallabag
38------------------------------ 38------------------------------
39 39
40Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok: 40Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok:
41 41
42.. code:: yaml 42.. code:: yaml
43 43
diff --git a/docs/en/developer/redis.rst b/docs/en/developer/redis.rst
index 2e2bbbea..ea084e66 100644
--- a/docs/en/developer/redis.rst
+++ b/docs/en/developer/redis.rst
@@ -28,7 +28,7 @@ The server might be already running after installing, if not you can launch it u
28Configure Redis in wallabag 28Configure Redis in wallabag
29--------------------------- 29---------------------------
30 30
31Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok: 31Edit your ``app/config/parameters.yml`` file to edit Redis configuration. The default one should be ok:
32 32
33.. code:: yaml 33.. code:: yaml
34 34
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 6d85db2b..0ead261b 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -46,6 +46,7 @@ The documentation is available in other languages:
46 user/tags 46 user/tags
47 user/android 47 user/android
48 user/parameters 48 user/parameters
49 user/backup
49 50
50.. _dev-docs: 51.. _dev-docs:
51 52
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
index ccbad264..91dcb2fc 100644
--- a/docs/en/user/android.rst
+++ b/docs/en/user/android.rst
@@ -79,7 +79,7 @@ Known limitations
792FA 792FA
80~~~ 80~~~
81 81
82Currently the does not support two-factor authentication. You should disable that to get the app working. 82Currently the Android application does not support two-factor authentication. You should disable that to get the application working.
83 83
84 84
85Limited amount of articles with wallabag v2 85Limited amount of articles with wallabag v2
diff --git a/docs/en/user/backup.rst b/docs/en/user/backup.rst
new file mode 100644
index 00000000..51721000
--- /dev/null
+++ b/docs/en/user/backup.rst
@@ -0,0 +1,25 @@
1Backup wallabag
2===============
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.
4This articles describes what you need to backup.
5
6Basic settings
7--------------
8wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`.
9
10Database
11--------
12As wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation.
13
14Here's some examples:
15
16- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html
17- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html
18
19SQLite
20~~~~~~
21To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory.
22
23Images
24------
25The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2).
diff --git a/docs/en/user/faq.rst b/docs/en/user/faq.rst
index 61303604..0f995ce5 100644
--- a/docs/en/user/faq.rst
+++ b/docs/en/user/faq.rst
@@ -46,3 +46,10 @@ I forgot my password
46You can reset your password by clicking on ``Forgot your password?`` link, 46You can reset your password by clicking on ``Forgot your password?`` link,
47on the login page. Then, fill the form with your email address or your username, 47on the login page. Then, fill the form with your email address or your username,
48you'll receive an email to reset your password. 48you'll receive an email to reset your password.
49
50I've got the ``failed to load external entity`` error when I try to install wallabag
51------------------------------------------------------------------------------------
52
53As described `here <https://github.com/wallabag/wallabag/issues/2529>`_, please edit your ``web/app.php`` file and add this line: ``libxml_disable_entity_loader(false);`` on line 5.
54
55This is a Doctrine / PHP bug, nothing we can do about it.
diff --git a/docs/fr/developer/api.rst b/docs/fr/developer/api.rst
index a0710a96..8a6e2a13 100644
--- a/docs/fr/developer/api.rst
+++ b/docs/fr/developer/api.rst
@@ -263,7 +263,8 @@ Ressources tierces
263 263
264Certaines applications ou bibliothèques utilisent notre API. En voici une liste non exhaustive : 264Certaines applications ou bibliothèques utilisent notre API. En voici une liste non exhaustive :
265 265
266- `Java wrapper for the wallabag API <https://github.com/Strubbl/wallabag-java>`_ par Strubbl. 266- `Java wrapper for the wallabag API <https://github.com/Strubbl/jWallabag>`_ par Strubbl.
267- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ par Julian Oster. 267- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ par Julian Oster.
268- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ par FoxMaSk, pour son projet `Trigger Happy <https://blog.trigger-happy.eu/>`_. 268- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ par FoxMaSk, pour son projet `Trigger Happy <https://blog.trigger-happy.eu/>`_.
269- `Un plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ conçu pour `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ qui utilise l'API wallabag v2. Par Josh Panter. 269- `Un plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ conçu pour `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ qui utilise l'API wallabag v2. Par Josh Panter.
270- `Golang wrapper for the wallabag API <https://github.com/Strubbl/wallabago>`_ par Strubbl, pour son projet `wallabag-stats graphe <https://github.com/Strubbl/wallabag-stats>`_.
diff --git a/docs/fr/developer/rabbitmq.rst b/docs/fr/developer/rabbitmq.rst
index 92db5a28..b534a48b 100644
--- a/docs/fr/developer/rabbitmq.rst
+++ b/docs/fr/developer/rabbitmq.rst
@@ -37,7 +37,7 @@ Arrêter RabbitMQ
37Configurer RabbitMQ dans wallabag 37Configurer RabbitMQ dans wallabag
38--------------------------------- 38---------------------------------
39 39
40Modifiez votre fichier ``parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir : 40Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir :
41 41
42.. code:: yaml 42.. code:: yaml
43 43
diff --git a/docs/fr/developer/redis.rst b/docs/fr/developer/redis.rst
index 8a212e8a..58204d57 100644
--- a/docs/fr/developer/redis.rst
+++ b/docs/fr/developer/redis.rst
@@ -28,7 +28,7 @@ Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas
28Configurer Redis dans wallabag 28Configurer Redis dans wallabag
29------------------------------- 29-------------------------------
30 30
31Modifiez votre fichier ``parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir : 31Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir :
32 32
33.. code:: yaml 33.. code:: yaml
34 34
diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index 2a265ff3..dbb85910 100644
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -46,6 +46,7 @@ La documentation est disponible dans d'autres langues :
46 user/filters 46 user/filters
47 user/tags 47 user/tags
48 user/parameters 48 user/parameters
49 user/backup
49 50
50.. _dev-docs: 51.. _dev-docs:
51 52
diff --git a/docs/fr/user/backup.rst b/docs/fr/user/backup.rst
new file mode 100644
index 00000000..ec4b1f4d
--- /dev/null
+++ b/docs/fr/user/backup.rst
@@ -0,0 +1,26 @@
1Sauvegarde de wallabag
2======================
3
4Parce que des fois vous faites des erreurs avec votre installation de wallabag et vous perdez des données ou parce que vous souhaitez migrer votre installation sur un autre serveur, vous souhaitez faire une sauvegarde de vos données.
5Cette documentation décrit ce que vous devez sauvegarder.
6
7Configuration
8-------------
9wallabag stocke quelques paramètres (comme la configuration SMTP ou les infos de bases de données) dans le fichier `app/config/parameters.yml`.
10
11Base de données
12---------------
13Comme wallabag supporte différentes sortes de bases de données, la manière de sauvegarder dépend du type de base de données que vous utilisez, donc vous devez vous en référez à la documentation correspondante.
14
15Quelques exemples :
16
17- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html
18- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html
19
20SQLite
21~~~~~~
22Pour sauvegarder une base SQLite, vous devez juste copier le répertoire `data/db` de votre installation wallabag.
23
24Images
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).
diff --git a/docs/fr/user/faq.rst b/docs/fr/user/faq.rst
index e220c8a7..49aa94ba 100644
--- a/docs/fr/user/faq.rst
+++ b/docs/fr/user/faq.rst
@@ -33,3 +33,10 @@ J'ai oublié mon mot de passe
33Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``, 33Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``,
34sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur, 34sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur,
35un email vous sera envoyé. 35un email vous sera envoyé.
36
37J'ai l'erreur ``failed to load external entity`` quand j'essaie d'installer wallabag
38------------------------------------------------------------------------------------
39
40Comme décrit `ici <https://github.com/wallabag/wallabag/issues/2529>`_, modifiez le fichier ``web/app.php`` et ajoutez la ligne ``libxml_disable_entity_loader(false);`` à la ligne 5.
41
42C'est un bug lié à PHP et Doctrine, nous ne pouvons rien faire de notre côté.