diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/api.rst | 3 | ||||
-rw-r--r-- | docs/en/developer/rabbitmq.rst | 2 | ||||
-rw-r--r-- | docs/en/developer/redis.rst | 2 | ||||
-rw-r--r-- | docs/en/index.rst | 1 | ||||
-rw-r--r-- | docs/en/user/android.rst | 2 | ||||
-rw-r--r-- | docs/en/user/backup.rst | 25 | ||||
-rw-r--r-- | docs/en/user/faq.rst | 7 |
7 files changed, 38 insertions, 4 deletions
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 | ||
264 | Some applications or libraries use our API. Here is a non-exhaustive list of them: | 264 | Some 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 | |||
37 | Configure RabbitMQ in wallabag | 37 | Configure RabbitMQ in wallabag |
38 | ------------------------------ | 38 | ------------------------------ |
39 | 39 | ||
40 | Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok: | 40 | Edit 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 | |||
28 | Configure Redis in wallabag | 28 | Configure Redis in wallabag |
29 | --------------------------- | 29 | --------------------------- |
30 | 30 | ||
31 | Edit your ``parameters.yml`` file to edit Redis configuration. The default one should be ok: | 31 | Edit 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 | |||
79 | 2FA | 79 | 2FA |
80 | ~~~ | 80 | ~~~ |
81 | 81 | ||
82 | Currently the does not support two-factor authentication. You should disable that to get the app working. | 82 | Currently the Android application does not support two-factor authentication. You should disable that to get the application working. |
83 | 83 | ||
84 | 84 | ||
85 | Limited amount of articles with wallabag v2 | 85 | Limited 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 @@ | |||
1 | Backup wallabag | ||
2 | =============== | ||
3 | Because 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. | ||
4 | This articles describes what you need to backup. | ||
5 | |||
6 | Basic settings | ||
7 | -------------- | ||
8 | wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`. | ||
9 | |||
10 | Database | ||
11 | -------- | ||
12 | As 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 | |||
14 | Here'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 | |||
19 | SQLite | ||
20 | ~~~~~~ | ||
21 | To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory. | ||
22 | |||
23 | Images | ||
24 | ------ | ||
25 | The 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 | |||
46 | You can reset your password by clicking on ``Forgot your password?`` link, | 46 | You can reset your password by clicking on ``Forgot your password?`` link, |
47 | on the login page. Then, fill the form with your email address or your username, | 47 | on the login page. Then, fill the form with your email address or your username, |
48 | you'll receive an email to reset your password. | 48 | you'll receive an email to reset your password. |
49 | |||
50 | I've got the ``failed to load external entity`` error when I try to install wallabag | ||
51 | ------------------------------------------------------------------------------------ | ||
52 | |||
53 | As 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 | |||
55 | This is a Doctrine / PHP bug, nothing we can do about it. | ||