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