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