aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/user')
-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
4 files changed, 46 insertions, 8 deletions
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`)"