taler-docs

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

libeufin-ebisync.conf.5.rst (3579B)


      1 libeufin-ebisync.conf(5)
      2 ########################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **libeufin-ebisync.conf** - LibEuFin EbiSync 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 ``$LIBEUFIN_EBISYNC_PREFIX/share/libeufin-ebisync/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 GLOBAL OPTIONS
     28 --------------
     29 
     30 The following options are from the “[ebisync]” section.
     31 
     32 HOST_BASE_URL
     33   URL of the EBICS server
     34 
     35 HOST_ID
     36   EBICS specific: name of the EBICS host
     37 
     38 USER_ID
     39   EBICS specific: user ID of the EBICS subscriber.  This value must be assigned
     40   by the bank after having activated a new EBICS subscriber.
     41 
     42 PARTNER_ID
     43   EBICS specific: partner ID of the EBICS subscriber.  This value must be assigned
     44   by the bank after having activated a new EBICS subscriber.
     45 
     46 BANK_PUBLIC_KEYS_FILE
     47   Filesystem location where EbiSync should store the bank public keys.
     48 
     49 CLIENT_PRIVATE_KEYS_FILE
     50   Filesystem location where EbiSync should store the subscriber private keys.
     51 
     52 SETUP OPTIONS
     53 -------------
     54 
     55 The following configuration value(s) belong to the “[ebisync-setup]” section.
     56 
     57 BANK_ENCRYPTION_PUB_KEY_HASH
     58   Bank encryption public key hash.
     59 
     60 BANK_AUTHENTICATION_PUB_KEY_HASH
     61   Bank authentication public key hash.
     62 
     63 FETCH OPTIONS
     64 -------------
     65 
     66 The following configuration value(s) belong to the “[ebisync-fetch]” section.
     67 
     68 FREQUENCY
     69   How often should fetch run when the bank does not support real time notification
     70 
     71 CHECKPOINT_TIME_OF_DAY
     72   At what time HH:MM of day should ``fetch`` perform a checkpoint.
     73 
     74 DESTINATION
     75   Where should the ebics file be stored? This can either be ``azure-blob-storage`` or ``none``.
     76 
     77 AZURE_API_URL
     78   Azure API account base url
     79 
     80 AZURE_ACCOUNT_NAME
     81   Azure API account name
     82 
     83 AZURE_ACCOUNT_KEY
     84   Azure API account key
     85 
     86 AZURE_CONTAINER
     87   Which Azure Blob Storage container to use
     88 
     89 SUBMIT OPTIONS
     90 --------------
     91 
     92 The following configuration value(s) belong to the “[ebisync-submit]” section.
     93 
     94 SOURCE
     95   Where does the ebics file come from? This can either be ``ebisync-api`` or ``none``
     96 
     97 AUTH_METHOD
     98   Authentication scheme for api sources, this can either be ``basic``, ``bearer`` or ``none``.
     99 
    100 USERNAME
    101   User name for ``basic`` authentication scheme.
    102 
    103 PASSWORD
    104   Password for ``basic`` authentication scheme.
    105 
    106 TOKEN
    107   Token for ``bearer`` authentication scheme.
    108 
    109 HTTP SERVER OPTIONS
    110 -------------------
    111 
    112 The following configuration value(s) belong to the “[ebisync-httpd]” section.
    113 
    114 SERVE
    115   This can either be ``tcp`` or ``unix``.
    116 
    117 PORT
    118   Port on which the HTTP server listens, e.g. 9967.
    119   Only used if ``SERVE`` is ``tcp``.
    120 
    121 BIND_TO
    122   Which IP address should we bind to?  E.g. ``127.0.0.1`` or ``::1`` for loopback.  Can also be given as a hostname.
    123   Only used if ``SERVE`` is ``tcp``.
    124 
    125 UNIXPATH
    126   Which unix domain path should we bind to?
    127   Only used if ``SERVE`` is ``unix``.
    128 
    129 SPA
    130   Path to spa files
    131 
    132 DATABASE OPTIONS
    133 ----------------
    134 
    135 Setting the database belongs to the “[ebisyncdb-postgres]” section and the following value.
    136 
    137 .. include:: frags/common-db-options.rst
    138 
    139 SEE ALSO
    140 ========
    141 
    142 libeufin-ebisync(1)
    143 
    144 BUGS
    145 ====
    146 
    147 Report bugs by using https://bugs.taler.net/ or by sending electronic
    148 mail to <taler@gnu.org>.