taler-auditor.conf.5.rst (3723B)
1 taler-auditor.conf(5) 2 ##################### 3 4 .. only:: html 5 6 Name 7 ==== 8 9 **taler-auditor.conf** - Taler auditor 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 ``$TALER_AUDITOR_PREFIX/share/taler-auditor/config.d/``. 19 The configuration file given with **-c** to Taler 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-auditor-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 “[PATHS]” section is special in that it contains paths that can be 35 referenced using “$” in other configuration values that specify 36 filenames. For Taler, it commonly contains the following paths: 37 38 TALER_HOME 39 Home directory of the user, usually “${HOME}”. Can be overwritten by 40 testcases by setting ${TALER_TEST_HOME}. 41 42 TALER_DATA_HOME 43 Where should Taler store its long-term data. 44 Usually “${TALER_HOME}/.local/share/taler-auditor/”. 45 46 TALER_CONFIG_HOME 47 Where is the Taler configuration kept. 48 Usually “${TALER_HOME}/.config/taler-auditor/”. 49 50 TALER_CACHE_HOME 51 Where should Taler store cached data. 52 Usually “${TALER_HOME}/.cache/taler-auditor/”. 53 54 TALER_RUNTIME_DIR 55 Where should Taler store system runtime data (like UNIX domain 56 sockets). Usually “${TMP}/taler-auditor-runtime”. 57 58 59 .. include:: frags/currency-spec.rst 60 .. include:: frags/exchange-database.rst 61 .. include:: frags/exchange-account.rst 62 .. include:: frags/exchange-coin.rst 63 64 65 EXCHANGE OPTIONS 66 ---------------- 67 68 The following options are from the “[exchange]” section and used by 69 the auditor. 70 71 CURRENCY 72 Name of the currency, e.g. “EUR” for Euro. 73 74 CURRENCY_ROUND_UNIT 75 Smallest amount in this currency that can be transferred using the 76 underlying RTGS. For example: "EUR:0.01" or "JPY:1". 77 78 DB 79 Plugin to use for the database, e.g. “postgres”. 80 81 82 83 AUDITOR OPTIONS 84 --------------- 85 86 The following options must be in section “[auditor]” for the Taler 87 auditor. 88 89 DB 90 Plugin to use for the database, e.g. “postgres” 91 92 AUDITOR_PRIV_FILE 93 Name of the file containing the auditor’s private key. 94 95 PUBLIC_KEY 96 Crockford Base32 encoded auditor public key. Used by (online) auditor 97 processes that do not have access to the (offline) auditor private key file. 98 99 BASE_URL 100 Base URL of the auditor, e.g. “https://auditor.demo.taler.net/” 101 102 SERVE 103 Should the HTTP server listen on a UNIX domain socket (set option to "unix") or on a TCP socket (set option to "tcp")? 104 105 UNIXPATH 106 Path to listen on if we "SERVE" is set to "unix". 107 108 UNIXPATH_MODE 109 Access permission mask to use for the "UNIXPATH". 110 111 PORT 112 Port on which the HTTP server listens, e.g. 8080. 113 114 BIND_TO 115 Hostname to which the merchant HTTP server should be bound to, e.g. "localhost". 116 117 118 119 AUDITOR POSTGRES BACKEND DATABASE OPTIONS 120 ----------------------------------------- 121 122 The following options must be in section “[auditordb-postgres]” if the 123 “postgres” plugin was selected for the database. 124 125 CONFIG 126 How to access the database, e.g. "postgres:///taler" to use the 127 "taler" database. Testcases use “talercheck”. 128 129 130 SEE ALSO 131 ======== 132 133 taler-auditor-dbinit(1), taler-auditor-httpd(1), taler-auditor-offline(1). 134 135 BUGS 136 ==== 137 138 Report bugs by using https://bugs.taler.net/ or by sending electronic 139 mail to <taler@gnu.org>.