taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

taler-mailbox.conf.5.rst (1916B)


      1 mailbox.conf(5)
      2 ###############
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **mailbox.conf** - taler-mailbox 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-mailbox/config.d/``.
     19 The configuration file given with **-c** to taler-mailbox 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-mailbox-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 “[mailbox]” 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: ``https://example.com``
     39 
     40 MAX_BODY_BYTES
     41   Number of bytes of the challenge.
     42   Default: ``256``
     43 
     44 MESSAGE_RESPONSE_LIMIT
     45   Maximum number of messages returned in a single response.
     46   Default: ``50``
     47 
     48 MONTHLY_FEE
     49   Monthly fee of this service.
     50   Default: ``KUDOS:0``
     51 
     52 REGISTRATION_UPDATE_FEE
     53   Registration modification fee.
     54   Default: ``KUDOS:0``
     55 
     56 MESSAGE_FEE
     57   Cost for sending a message to a mailbox.
     58   Default: ``KUDOS:0``
     59 
     60 FREE_MESSAGE_QUOTA
     61   Number of messages that can be sent for free
     62   Default: ``0``
     63 
     64 PENDING_REGISTRATION_EXPIRATION
     65   Lifetime of a pending (unpaid) registration until it is purged from the database.
     66   Default: ``24h``
     67 
     68 SEE ALSO
     69 ========
     70 
     71 taler-mailbox-dbinit(1), taler-mailbox-httpd(1), taler-mailbox-config(1).
     72 
     73 
     74 BUGS
     75 ====
     76 
     77 Report bugs by using https://bugs.taler.net/ or by sending electronic
     78 mail to <taler@gnu.org>.