taler-mdb.conf.5.rst (4404B)
1 .. 2 This file is part of GNU TALER. 3 Copyright (C) 2014-2024 Taler Systems SA 4 5 TALER is free software; you can redistribute it and/or modify it under the 6 terms of the GNU Affero General Public License as published by the Free Software 7 Foundation; either version 2.1, or (at your option) any later version. 8 9 TALER is distributed in the hope that it will be useful, but WITHOUT ANY 10 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 11 A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. 12 13 You should have received a copy of the GNU Affero General Public License along with 14 TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> 15 16 @author Christian Grothoff 17 18 19 taler-mdb.conf(5) 20 ################# 21 22 .. only:: html 23 24 Name 25 ==== 26 27 **taler-mdb.conf** - Taler-mdb configuration file 28 29 30 Description 31 =========== 32 33 .. include:: ../frags/common-conf-syntax.rst 34 35 Files containing default values for many of the options described below 36 are installed under ``$TALER_MDB_PREFIX/share/taler-exchange/config.d/``. 37 The configuration file given with **-c** to Taler binaries 38 overrides these defaults. 39 40 A configuration file may include another, by using the ``@INLINE@`` directive, 41 for example, in ``main.conf``, you could write ``@INLINE@ sub.conf`` to 42 include the entirety of ``sub.conf`` at that point in ``main.conf``. 43 44 45 Taler-mdb Options 46 ----------------- 47 48 Taler-mdb is a component to run GNU Taler as a payment system on 49 vending machines using the multi-drop bus protocol. These options 50 are thus not useful for most users. Note that right now, the 51 cancel button is hard-coded to be using GPIO pin 23. 52 53 ADVERTISEMENT_COMMAND 54 Program to run while not vending, possibly useful to show advertisements on the screen (optional). 55 ESSID 56 ESSID to advertise to wallets for use as an open WiFi to make payments (optional). 57 FULFILLMENT_MSG 58 Message shown to users by their wallets upon successful payment. If "${PRODUCT_DESCRIPTION}" appears in the message, it will be replaced with the description of the product that was sold. 59 BACKEND_BASE_URL 60 Base URL (possibly including instance) for the Taler merchant backend used to process payments. 61 BACKEND_AUTHORIZATION 62 Full HTTP "Authorization" header (usually with a Bearer token) to be send to the merchant backend for authorization of requests. Mandatory. 63 FRAMEBUFFER_BACKLIGHT 64 Name of the file used to control brightness of the display. Optional. Defaults to "/sys/class/backlight/soc:backlight/brightness" if not given. 65 FRAMEBUFFER_DEVICE 66 Name of the framebuffer device to use. Defaults to "/dev/fb1" if not given. 67 UART_DEVICE 68 Name of the UART device to use. Defaults to "/dev/ttyAMA0" if not given. 69 FAIL_COMMAND 70 Command to run by taler-mdb to display a failure to the user. If not given, errors will not be properly shown. Should usually be set to "taler-mdb-show.sh". 71 FAIL_HELPER 72 Command used by taler-mdb-network-check.sh to run to display a failure to the user. If not given, errors will not be properly shown. Should usually be set to "taler-mdb-show.sh". 73 74 Each products being sold must be configured in a section where the name starts with "product-". 75 In these sections, the options that must be provided are: 76 77 NUMBER 78 Number identifying the slot in the vending machine that corresponds to this product. 79 INSTANCE 80 Instance to use for the payment. Optional. If not given, the BACKEND_BASE_URL from "[taler-mdb]" will be used. 81 BACKEND_AUTHORIZATION 82 Full HTTP "Authorization" header (usually with a Bearer token) to be send to the merchant backend for authorization of requests. Optional, will use global BACKEND_AUTHORIZATION setting from "[taler-mdb]" if missing. 83 DESCRIPTION 84 Human-readable description of the product. Use "empty" if the product is known to be sold out (only effective if selling out is enabled via command-line). 85 PRICE 86 Actual price of the product, as a Taler amount ("$CURRENCY:$VALUE.$FRACTION"). 87 KEY 88 Key used to select the product from the console during testing. Optional. 89 THUMBNAIL 90 Name of a filename with a preview image of the product to be given to the wallet. Optional. Only ".png", ".jpg", ".jpeg" and ".svg" are supported at this time. 91 92 93 SEE ALSO 94 ======== 95 96 taler-mdb(1), taler-mdb-qr-show(1), taler-mdb-display(1) 97 98 BUGS 99 ==== 100 101 Report bugs by using https://bugs.taler.net/ or by sending electronic 102 mail to <taler@gnu.org>.