]> git.immae.eu Git - github/wallabag/wallabag.git/blame - docs/en/user/configuration.rst
Fix documentation and add help message in Baggy
[github/wallabag/wallabag.git] / docs / en / user / configuration.rst
CommitLineData
59e91bc8
NL
1Configuration
2=============
3
4Now you're logged in, it's time to configure your account as you want.
5
3495f78d
NL
6Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``,
7``User information``, ``Password`` and ``Tagging rules``.
59e91bc8
NL
8
9Settings
10--------
11
12Theme
13~~~~~
14
3495f78d
NL
15wallabag is customizable. You can choose your prefered theme here. You can also
16create a new one, a chapter will be dedicated for this. The default theme is
17``Material``, it's the theme used in the documentation screenshots.
59e91bc8
NL
18
19Items per page
20~~~~~~~~~~~~~~
21
22You can change the number of articles displayed on each page.
23
37b37172
NL
24Reading speed
25~~~~~~~~~~~~~
26
78becd54 27wallabag calculates a reading time for each article. You can define here, thanks to this list, if you are
37b37172
NL
28a fast or a slow reader. wallabag will recalculate the reading time for each article.
29
59e91bc8
NL
30Language
31~~~~~~~~
32
3495f78d
NL
33You can change the language of wallabag interface. You need to logout for this change
34to take effect.
59e91bc8
NL
35
36RSS
37---
38
39wallabag provides RSS feeds for each article status: unread, starred and archive.
40
41Firstly, you need to create a personal token: click on ``Create your token``.
42It's possible to change your token by clicking on ``Reset your token``.
43
44Now you have three links, one for each status: add them into your favourite RSS reader.
45
46You can also define how many articles you want in each RSS feed (default value: 50).
47
48User information
49----------------
50
51You can change your name, your email address and enable ``Two factor authentication``.
52
53Two factor authentication
54~~~~~~~~~~~~~~~~~~~~~~~~~
55
3495f78d
NL
56 Two-factor authentication (also known as 2FA) is a technology patented in 1984
57 that provides identification of users by means of the combination of two different components.
59e91bc8
NL
58
59https://en.wikipedia.org/wiki/Two-factor_authentication
60
3495f78d
NL
61If you enable 2FA, each time you want to login to wallabag, you'll receive
62a code by email. You have to put this code on the following form.
59e91bc8
NL
63
64.. image:: ../../img/user/2FA_form.png
3495f78d
NL
65 :alt: Two factor authentication
66 :align: center
59e91bc8 67
3495f78d
NL
68If you don't want to receive a code each time you want to login, you can check
69the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days.
59e91bc8
NL
70
71Password
72--------
73
3495f78d 74You can change your password here (8 characters minimum).
a42938f4
NL
75
76Tagging rules
77-------------
78
3495f78d
NL
79If you want to automatically assign a tag to new articles, this part
80of the configuration is for you.
a42938f4
NL
81
82What does « tagging rules » mean?
83~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84
85They are rules used by wallabag to automatically tag new entries.
3495f78d
NL
86Each time a new entry is added, all the tagging rules will be used to add
87the tags you configured, thus saving you the trouble to manually classify your entries.
a42938f4
NL
88
89How do I use them?
90~~~~~~~~~~~~~~~~~~
91
3495f78d
NL
92Let assume you want to tag new entries as *« short reading »* when
93the reading time is inferior to 3 minutes.
94In that case, you should put « readingTime <= 3 » in the **Rule** field
95and *« short reading »* in the **Tags** field.
a42938f4 96Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*.
3495f78d
NL
97Complex rules can be written by using predefined operators:
98if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*.
a42938f4
NL
99
100Which variables and operators can I use to write rules?
101~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102
103The following variables and operators can be used to create tagging rules:
104
105=========== ============================================== ======== ==========
106Variable Meaning Operator Meaning
107----------- ---------------------------------------------- -------- ----------
108title Title of the entry <= Less than…
109url URL of the entry < Strictly less than…
110isArchived Whether the entry is archived or not => Greater than…
111isStared Whether the entry is starred or not > Strictly greater than…
112content The entry's content = Equal to…
113language The entry's language != Not equal to…
114mimetype The entry's mime-type OR One rule or another
115readingTime The estimated entry's reading time, in minutes AND One rule and another
116domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football"
3495f78d 117=========== ============================================== ======== ==========