taler-docs

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

taler-magnet-bank.conf.5.rst (2973B)


      1 taler-magnet-bank.conf(5)
      2 #########################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **taler-magnet-bank.conf** - Magnet Bank Taler adapter 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_MAGNET_BANK_PREFIX/share/taler-magnet-bank/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 
     27 ADAPTER OPTIONS
     28 ---------------
     29 
     30 The following options are from the “[magnet-bank]” section.
     31 
     32 IBAN
     33   IBAN of the Magnet Bank account to sync.
     34 
     35 NAME
     36   Legal entity that is associated with the Magnet Bank account.
     37 
     38 WORKER OPTIONS
     39 --------------
     40 
     41 The following options are from the “[magnet-bank-worker]” section.
     42 
     43 FREQUENCY
     44   How often should worker run
     45 
     46 API_URL
     47   Base URL of the Magnet Bank API server.
     48 
     49 CONSUMER_KEY
     50   Your Magnet Bank API unique identifier.
     51 
     52 CONSUMER_SECRET
     53   Your Magnet Bank API confidential key.
     54 
     55 KEYS_FILE
     56   Filesystem location where taler-magnet-bank should store the crypto keys.
     57 
     58 ACCOUNT_TYPE
     59   Specify the account type and therefore the indexing behavior. This can either can be ``normal`` or ``exchange``. Exchange accounts bounce invalid incoming Taler transactions.
     60 
     61 IGNORE_TRANSACTIONS_BEFORE
     62   Ignore incoming transactions before this value date (``YYYY-MM-DD``).
     63 
     64 IGNORE_BOUNCES_BEFORE
     65   Do not bounce malformed incoming transactions before this value date (``YYYY-MM-DD``).
     66 
     67 HTTP SERVER OPTIONS
     68 -------------------
     69 
     70 The following configuration value(s) belong to the “[magnet-bank-httpd]” section.
     71 
     72 .. include:: frags/common-serve-options.rst
     73 
     74 HTTP WIRE GATEWAY API OPTIONS
     75 -----------------------------
     76 
     77 The following configuration value(s) belong to the “[magnet-bank-httpd-wire-gateway-api]” section.
     78 
     79 ENABLED
     80   Whether to serve the Wire Gateway API.
     81 
     82 .. include:: frags/common-api-options.rst
     83 
     84 HTTP REVENUE API OPTIONS
     85 ------------------------
     86 
     87 The following configuration value(s) belong to the “[magnet-bank-httpd-revenue-api]” section.
     88 
     89 ENABLED
     90   Whether to serve the Revenue API.
     91 
     92 .. include:: frags/common-api-options.rst
     93 
     94 HTTP OBSERVABILITY API OPTIONS
     95 ------------------------------
     96 
     97 The following configuration value(s) belong to the “[magnet-bank-httpd-observability-api]” section.
     98 
     99 ENABLED
    100   Whether to serve the Observability API.
    101 
    102 .. include:: frags/common-api-options.rst
    103 
    104 DATABASE OPTIONS
    105 ----------------
    106 
    107 Setting the database belongs to the “[magnet-bankdb-postgres]” section and the following value.
    108 
    109 .. include:: frags/common-db-options.rst
    110 
    111 
    112 SEE ALSO
    113 ========
    114 
    115 taler-magnet-bank(1)
    116 
    117 BUGS
    118 ====
    119 
    120 Report bugs by using https://bugs.taler.net/ or by sending electronic
    121 mail to <taler@gnu.org>.