taler-docs

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

paivana.conf.5.rst (2790B)

      1 paivana.conf(5)
      2 ###############
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **paivana.conf** - Paivana 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/paivana/config.d/``.
     19 The configuration file given with **-c** to Paivana 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 
     27 
     28 GLOBAL OPTIONS
     29 --------------
     30 
     31 The following options are from the “[paivana]” section.
     32 This is normally the only section in a paivana.conf file.
     33 
     34 SERVE
     35   Should the HTTP server listen on a UNIX domain socket (set option to "unix"), or on a TCP socket (set option to "tcp"), or be activated via systemd (set option to "systemd").
     36 
     37 PORT
     38   Port on which the HTTP server listens, e.g. 9967.
     39   Only used if ``SERVE`` is ``tcp``.
     40 
     41 BIND_TO
     42   Which IP address should we bind to?  E.g. ``127.0.0.1`` or ``::1``
     43   for loopback.  Can also be given as a hostname.  We will bind to
     44   the wildcard (dual-stack) if left empty.
     45   Only used if ``SERVE`` is ``tcp``.
     46 
     47 UNIXPATH
     48   Which unix domain path should we bind to?
     49   Only used if ``SERVE`` is ``unix``.
     50 
     51 UNIXPATH_MODE = 660
     52   What should be the file access permissions for ``UNIXPATH``?
     53   Only used if ``SERVE`` is ``unix``.
     54 
     55 BASE_URL
     56   Our own Base URL, used if we cannot learn our own base
     57   URL from "Host" or other HTTP headers. Optional but recommended.
     58 
     59 DESTINATION_BASE_URL
     60   Base URL of the target HTTP server we forward requests to once
     61   they have passed the paywall check.
     62 
     63 MERCHANT_BACKEND_URL
     64   Base URL of our Taler merchant backend.
     65 
     66 MERCHANT_BACKEND_UNIX_PATH
     67   UNIX path of our Taler merchant backend. Optional. Only set this
     68   option if the backend is reachable on the local machine via a
     69   UNIX domain socket.
     70 
     71 MERCHNAT_ACCESS_TOKEN
     72   Access token to use when accessing the merchant backend.
     73   This is a secret value.
     74 
     75 SECRET
     76   Secret used to determine the Paivana cookie for access control.
     77   Should be set to ensure cookies remain valid across restarts.
     78   Optional, generated at random at every startup if not set.
     79   This is a secret value.
     80 
     81 WHITELIST
     82   Posix extended regular expression whitelisting some paths.
     83   Whitelisted paths are never subject to the paywall. Should
     84   be used to whitelist resources such as images or style sheets.
     85   Paths matched against the whitelist always start with '/'.
     86   This setting is optional.
     87 
     88 SEE ALSO
     89 ========
     90 
     91 paivana-httpd(1), taler-merchant-httpd(1)
     92 
     93 
     94 BUGS
     95 ====
     96 
     97 Report bugs by using https://bugs.taler.net/ or by sending electronic
     98 mail to <taler@gnu.org>.