taler-auditor.conf(5)
#####################

.. only:: html

   Name
   ====

   **taler-auditor.conf** - Taler auditor configuration file


Description
===========

.. include:: ../frags/common-conf-syntax.rst

Files containing default values for many of the options described below
are installed under ``$TALER_AUDITOR_PREFIX/share/taler-auditor/config.d/``.
The configuration file given with **-c** to Taler binaries
overrides these defaults.

A configuration file may include another, by using the ``@INLINE@`` directive,
for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to
include the entirety of ``sub.conf`` at that point in ``main.conf``.

Be extra careful when using ``taler-auditor-config -V VALUE`` to change configuration
values: it will destroy all uses of ``@INLINE@`` and furthermore remove all
comments from the configuration file!


GLOBAL OPTIONS
--------------

The “[PATHS]” section is special in that it contains paths that can be
referenced using “$” in other configuration values that specify
filenames. For Taler, it commonly contains the following paths:

TALER_HOME
  Home directory of the user, usually “${HOME}”. Can be overwritten by
  testcases by setting ${TALER_TEST_HOME}.

TALER_DATA_HOME
  Where should Taler store its long-term data.
  Usually “${TALER_HOME}/.local/share/taler-auditor/”.

TALER_CONFIG_HOME
  Where is the Taler configuration kept.
  Usually “${TALER_HOME}/.config/taler-auditor/”.

TALER_CACHE_HOME
  Where should Taler store cached data.
  Usually “${TALER_HOME}/.cache/taler-auditor/”.

TALER_RUNTIME_DIR
  Where should Taler store system runtime data (like UNIX domain
  sockets). Usually “${TMP}/taler-auditor-runtime”.


.. include:: frags/currency-spec.rst
.. include:: frags/exchange-database.rst
.. include:: frags/exchange-account.rst
.. include:: frags/exchange-coin.rst


EXCHANGE OPTIONS
----------------

The following options are from the “[exchange]” section and used by
the auditor.

CURRENCY
  Name of the currency, e.g. “EUR” for Euro.

CURRENCY_ROUND_UNIT
  Smallest amount in this currency that can be transferred using the
  underlying RTGS. For example: "EUR:0.01" or "JPY:1".

DB
  Plugin to use for the database, e.g. “postgres”.



AUDITOR OPTIONS
---------------

The following options must be in section “[auditor]” for the Taler
auditor.

DB
  Plugin to use for the database, e.g. “postgres”

AUDITOR_PRIV_FILE
  Name of the file containing the auditor’s private key.

PUBLIC_KEY
  Crockford Base32 encoded auditor public key.  Used by (online) auditor
  processes that do not have access to the (offline) auditor private key file.

BASE_URL
  Base URL of the auditor, e.g. “https://auditor.demo.taler.net/”

SERVE
  Should the HTTP server listen on a UNIX domain socket (set option to "unix") or on a TCP socket (set option to "tcp")?

UNIXPATH
  Path to listen on if we "SERVE" is set to "unix".

UNIXPATH_MODE
  Access permission mask to use for the "UNIXPATH".

PORT
   Port on which the HTTP server listens, e.g. 8080.

BIND_TO
  Hostname to which the merchant HTTP server should be bound to, e.g. "localhost".



AUDITOR POSTGRES BACKEND DATABASE OPTIONS
-----------------------------------------

The following options must be in section “[auditordb-postgres]” if the
“postgres” plugin was selected for the database.

CONFIG
  How to access the database, e.g. "postgres:///taler" to use the
  "taler" database. Testcases use “talercheck”.


SEE ALSO
========

taler-auditor-dbinit(1), taler-auditor-httpd(1), taler-auditor-offline(1).

BUGS
====

Report bugs by using https://bugs.taler.net/ or by sending electronic
mail to <taler@gnu.org>.