taler-docs

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

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

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