docs/en/user/configuration.rst

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