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