taler-docs

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

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

      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 API_URL
     44   URL of the Magnet Bank API server.
     45 
     46 CONSUMER_KEY
     47   Your Magnet Bank API unique identifier.
     48 
     49 CONSUMER_SECRET
     50   Your Magnet Bank API confidential key.
     51 
     52 KEYS_FILE
     53   Filesystem location where taler-magnet-bank should store the crypto keys.
     54 
     55 ACCOUNT_TYPE
     56   Specify the account type and therefore the indexing behavior. This can either can be ``normal`` or ``exchange``. Exchange accounts bounce invalid incoming Taler transactions.
     57 
     58 HTTP SERVER OPTIONS
     59 -------------------
     60 
     61 The following configuration value(s) belong to the “[magnet-bank-httpd]” section.
     62 
     63 .. include:: frags/common-serve-options.rst
     64 
     65 HTTP WIRE GATEWAY API OPTIONS
     66 -----------------------------
     67 
     68 The following configuration value(s) belong to the “[magnet-bank-httpd-wire-gateway-api]” section.
     69 
     70 ENABLED
     71   Whether to serve the Wire Gateway API.
     72 
     73 .. include:: frags/common-api-options.rst
     74 
     75 HTTP REVENUE API OPTIONS
     76 ------------------------
     77 
     78 The following configuration value(s) belong to the “[magnet-bank-httpd-revenue-api]” section.
     79 
     80 ENABLED
     81   Whether to serve the Revenue API.
     82 
     83 .. include:: frags/common-api-options.rst
     84 
     85 DATABASE OPTIONS
     86 ----------------
     87 
     88 Setting the database belongs to the “[magnet-bankddb-postgres]” section and the following value.
     89 
     90 .. include:: frags/common-db-options.rst
     91 
     92 
     93 SEE ALSO
     94 ========
     95 
     96 taler-magnet-bank(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>.