taler-docs

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

depolymerizer-bitcoin.conf.5.rst (3342B)


      1 depolymerizer-bitcoin.conf(5)
      2 #############################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **depolymerizer-bitcoin.conf** - Bitcoin depolymerizer 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 ``$DEPOLYMERIZER-BITCOIN/share/depolymerizer-bitcoin/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 DEPOLYMERIZER OPTIONS
     28 ---------------------
     29 
     30 The following options are from the “[depolymerizer-bitcoin]” section.
     31 
     32 CURRENCY
     33   Adapter currency
     34 
     35 WALLET
     36   Bitcoin wallet address to advertise
     37 
     38 NAME
     39   Legal entity that is associated with the Bitcoin wallet.
     40 
     41 WORKER OPTIONS
     42 --------------
     43 
     44 The following options are from the “[depolymerizer-bitcoin-worker]” section.
     45 
     46 WALLET_NAME
     47   Name of the wallet to sync.
     48 
     49 PASSWORD
     50   Password of the encrypted wallet.
     51 
     52 CONFIRMATION
     53   Number of blocks to consider a transactions durable.
     54 
     55 BOUNCE_FEE
     56   An additional fee to deduce from the bounced amount.
     57 
     58 LIFETIME
     59   Number of worker's loops before worker shutdown (0 means never).
     60 
     61 BUMP_DELAY
     62   Delay in seconds before bumping an unconfirmed transaction fee (0 means never).
     63 
     64 RPC_BIND
     65   RPC server address.
     66 
     67 RPC_AUTH_METHOD
     68   RPC authentication scheme, this can either can be ``basic`` or ``cookie``.
     69 
     70 RPC_COOKIE_FILE
     71   Path to the bitcoind cookie file.
     72   Only used if ``RPC_AUTH_METHOD`` is ``cookie``.
     73 
     74 RPC_USERNAME
     75   User name for basic authentication scheme.
     76   Only used if ``RPC_AUTH_METHOD`` is ``basic``.
     77 
     78 RPC_PASSWORD
     79   Password for basic authentication scheme.
     80   Only used if ``RPC_AUTH_METHOD`` is ``basic``.
     81 
     82 HTTP SERVER OPTIONS
     83 -------------------
     84 
     85 The following configuration value(s) belong to the “[depolymerizer-bitcoin-httpd]” section.
     86 
     87 .. include:: frags/common-serve-options.rst
     88 
     89 LIFETIME
     90   Number of requests to serve before server shutdown (0 means never).
     91 
     92 HTTP WIRE GATEWAY API OPTIONS
     93 -----------------------------
     94 
     95 The following configuration value(s) belong to the “[depolymerizer-bitcoin-httpd-wire-gateway-api]” section.
     96 
     97 ENABLED
     98   Whether to serve the Wire Gateway API and the Prepared Transfer API.
     99 
    100 .. include:: frags/common-api-options.rst
    101 
    102 HTTP REVENUE API OPTIONS
    103 ------------------------
    104 
    105 The following configuration value(s) belong to the “[depolymerizer-bitcoin-httpd-revenue-api]” section.
    106 
    107 ENABLED
    108   Whether to serve the Revenue API.
    109 
    110 .. include:: frags/common-api-options.rst
    111 
    112 HTTP OBSERVABILITY API OPTIONS
    113 ------------------------------
    114 
    115 The following configuration value(s) belong to the “[depolymerizer-bitcoin-httpd-observability-api]” section.
    116 
    117 ENABLED
    118   Whether to serve the Observability API.
    119 
    120 .. include:: frags/common-api-options.rst
    121 
    122 DATABASE OPTIONS
    123 ----------------
    124 
    125 Setting the database belongs to the “[depolymerizer-bitcoindb-postgres]” section and the following value.
    126 
    127 .. include:: frags/common-db-options.rst
    128 
    129 SEE ALSO
    130 ========
    131 
    132 depolymerizer-bitcoin(1)
    133 
    134 BUGS
    135 ====
    136 
    137 Report bugs by using https://bugs.taler.net/ or by sending electronic
    138 mail to <taler@gnu.org>.