taler-docs

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

taler-cyclos.conf.5.rst (2463B)

      1 taler-cyclos.conf(5)
      2 ####################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **taler-cyclos.conf** - Cyclos 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_CYCLOS_PREFIX/share/taler-cyclos/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 “[cyclos]” section.
     31 
     32 CURRENCY
     33   Adapter currency
     34 
     35 CYCLOS_URL
     36   Base URL of the Cyclos network server.
     37 
     38 ACCOUNT_ID
     39   ID of the Cyclos account to sync.
     40 
     41 NAME
     42   Legal entity that is associated with the Cyclos account.
     43 
     44 WORKER OPTIONS
     45 --------------
     46 
     47 The following options are from the “[cyclos-worker]” section.
     48 
     49 FREQUENCY
     50   How often should worker run when no notification is received
     51 
     52 USERNAME
     53   Account username.
     54 
     55 PASSWORD
     56   Account password
     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 ACCOUNT_TYPE_ID
     62   Cyclos account type ID to index
     63 
     64 PAYMENT_TYPE_ID
     65   Cyclos payment type ID to use for transfers
     66 
     67 HTTP SERVER OPTIONS
     68 -------------------
     69 
     70 The following configuration value(s) belong to the “[cyclos-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 “[cyclos-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 “[cyclo-httpd-revenue-api]” section.
     88 
     89 ENABLED
     90   Whether to serve the Revenue API.
     91 
     92 .. include:: frags/common-api-options.rst
     93 
     94 DATABASE OPTIONS
     95 ----------------
     96 
     97 Setting the database belongs to the “[cyclosdb-postgres]” section and the following value.
     98 
     99 .. include:: frags/common-db-options.rst
    100 
    101 
    102 SEE ALSO
    103 ========
    104 
    105 taler-cyclos(1)
    106 
    107 BUGS
    108 ====
    109 
    110 Report bugs by using https://bugs.taler.net/ or by sending electronic
    111 mail to <taler@gnu.org>.