taler-directory.conf.5.rst (5769B)
1 directory.conf(5) 2 ################# 3 4 .. only:: html 5 6 Name 7 ==== 8 9 **directory.conf** - taler-directory configuration file 10 11 12 Description 13 =========== 14 15 .. include:: ../frags/common-conf-syntax.rst 16 17 Files containing default values for many of the options described below 18 are installed under ``$PREFIX/share/taler-directory/config.d/``. 19 The configuration file given with **-c** to taler-directory binaries 20 overrides these defaults. 21 22 A configuration file may include another, by using the ``@INLINE@`` directive, 23 for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to 24 include the entirety of ``sub.conf`` at that point in ``main.conf``. 25 26 Be extra careful when using ``taler-directory-config -V VALUE`` to change configuration 27 values: it will destroy all uses of ``@INLINE@`` and furthermore remove all 28 comments from the configuration file! 29 30 31 GLOBAL OPTIONS 32 -------------- 33 34 The following options are from the “[directory]” section. 35 36 BASE_URL 37 The base URL of the service. If your service is proxied, the external base URL this service is availiable at. 38 Default: ``http://localhost:11000`` 39 40 BIND_TO 41 What interface/port to bind to. 42 Default: ``localhost:11000`` 43 44 SALT 45 The salt used when hading the alises internally. Should be unique per directory. 46 Default: ``ChangeMe`` 47 48 DEFAULT_DOC_FILETYPE 49 Default filetype sent when privacy policy o TOS are served. 50 Default: ``text/html`` 51 52 DEFAULT_DOC_LANG 53 Default language sent when privacy policy o TOS are served. 54 Default" ``en`` 55 56 DEFAULT_TOS_PATH 57 Default path where TOS is found. 58 Default: ``terms/`` 59 60 DEFAULT_PP_PATH 61 Default path there privacy policy is found. 62 Default: ``pp/`` 63 64 SUPPORTED_DOC_FILETYPES 65 Supported filetypes for privacy policy and TOS. 66 Default: ``text/html application/pdf application/epub application/xml text/plain`` 67 68 MERCHANT_BASE_URL 69 The base URL of the merchant instance to use. 70 Default: ``https://backend.demo.taler.net`` 71 72 MERCHANT_TOKEN 73 The API token to use for the merchant instance. 74 Default: ``sandbox`` 75 76 CHALLENGE_BYTES 77 Number of bytes of the challenge. 78 Default: ``16`` 79 80 VALIDATION_INITIATION_MAX 81 Maximum number of pending validations for the same alias. 82 Default: ``3`` 83 84 SOLUTION_ATTEMPT_MAX 85 Maximum times a solution may be attempted for an active validation. 86 Default: ``3`` 87 88 VALIDATION_TIMEFRAME 89 Cooldown period between two successive validation requests (for the same alias). 90 Default: ``5m`` 91 92 SOLUTION_ATTEMPT_TIMEFRAME 93 Duration for which a solution must be provided for any given validation. 94 Default: ``1h`` 95 96 VALIDATION_EXPIRATION 97 Time until a pending validation expires 98 Default: ``24h`` 99 100 VALID_PAYMENT_SYSTEM_ADDRESS_REGEX 101 Defines valid payment system addresses that may be registered. 102 Default: ``.*`` 103 104 MONTHLY_FEE 105 Cost for registration of a single month. 106 Default: ``KUDOS:0`` 107 108 NAVIGATION 109 The navigation (header) HTML template file. If relative will be interpreted relative to DATADIR. 110 Default: ``web/templates/nav.html`` 111 112 FOOTER 113 The footer HTML template file. If relative will be interpreted relative to DATADIR. 114 Default: ``web/templates/footer.html`` 115 116 IMPRINT_PAGE 117 The imprint HTML template file. If relative will be interpreted relative to DATADIR. 118 Default: ``web/templates/imprint.html`` 119 120 ABOUT_PAGE 121 The about HTML template file. If relative will be interpreted relative to DATADIR. 122 Default: ``web/templates/about.html`` 123 124 LANDING_PAGE 125 The landing page HTML template file. If relative will be interpreted relative to DATADIR. 126 Default: ``web/templates/landing.html`` 127 128 VALIDATION_LANDING 129 The validation landing HTML template file. If relative will be interpreted relative to DATADIR. 130 Default: ``web/templates/validation_landing.html`` 131 132 LOOKUP_RESULT_PAGE 133 The lookup result HTML template file. If relative will be interpreted relative to DATADIR. 134 Default: ``web/templates/validation_landing.html`` 135 136 137 The following options are from a “[directory-<validator>]” section. 138 139 ENABLED 140 Is this validator enabled or disabled. 141 Default: ``false`` 142 143 TYPE 144 What type of validator is this. Options: ``command``, ``oidc``. 145 Default: ``command`` 146 147 CHALLENGE_FEE 148 What does the initiation of a challenge cost. 149 Default: ``KUDOS:0`` 150 151 VALID_ALIAS_REGEX 152 Defines which aliases are valid in this validator context. 153 Default: empty 154 155 COMMAND 156 Only when TYPE ``command``. The command to execute. Must be set if TYPE is ``command``. 157 Default: unset 158 159 SENDER 160 What should the sender of the email be. Only read by the email validator. 161 Default: unset 162 163 AUTHORIZATION_ENDPOINT 164 Only when TYPE ``oidc``. The URI of the authorization endpoint. 165 Default: unset 166 167 TOKEN_ENDPOINT 168 Only when TYPE ``oidc``. The URI of the token endpoint. 169 Default: unset 170 171 USERINFO_ENDPOINT 172 Only when TYPE ``oidc``. The URI of the userinfo endpoint. 173 Default: unset 174 175 CLIENT_ID 176 Only when TYPE ``oidc``. The OAuth client_id. 177 Default: unset 178 179 CLIENT_SECRET 180 Only when TYPE ``oidc``. The OAuth client_secret. 181 Default: unset 182 183 SCOPE 184 Only when TYPE ``oidc``. The OAuth scope(s) to request. 185 Default: unset 186 187 ALIAS_CLAIM 188 Only when TYPE ``oidc``. The claim to read from the userinfo response. Must be equal to the alias that is being validated. 189 Default: ``sub`` 190 191 The following options are from a “[directory-<disseminator>]” section. 192 193 ENABLED 194 Is this disseminator enabled or disabled. 195 Default: ``false`` 196 197 ZONE 198 The name (not ZEKY) of the local zone authoritative for publication of the directory. 199 Default: unset 200 201 EXPIRATION 202 The relative expiration time of the record sets. 203 Default: ``1d`` 204 205 SEE ALSO 206 ======== 207 208 taler-directory-dbinit(1), taler-directory-httpd(1), taler-directory-config(1). 209 210 211 BUGS 212 ==== 213 214 Report bugs by using https://bugs.taler.net/ or by sending electronic 215 mail to <taler@gnu.org>.