libeufin-ebisync.conf.5.rst (3570B)
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 Duration value to instruct the ``fetch`` subcommand how often it should 70 download from the bank. 71 72 CHECKPOINT_TIME_OF_DAY 73 At what time HH:MM of day should ``fetch`` perform a checkpoint. 74 75 DESTINATION 76 Where should the ebics file be stored? This can either be ``azure-blob-storage`` or ``none``. 77 78 AZURE_API_URL 79 Azure API account base url 80 81 AZURE_ACCOUNT_NAME 82 Azure API account name 83 84 AZURE_ACCOUNT_KEY 85 Azure API account key 86 87 AZURE_COUNTAINER 88 Which Azure Blob Storage container to use 89 90 SUBMIT OPTIONS 91 -------------- 92 93 The following configuration value(s) belong to the “[ebisync-submit]” section. 94 95 SOURCE 96 Where does the ebics file come from? This can either be ``ebisync-api`` or ``none`` 97 98 AUTH_METHOD 99 Authentication scheme for api sources, this can either be ``basic``, ``bearer`` or ``none``. 100 101 USERNAME 102 User name for ``basic`` authentication scheme. 103 104 PASSWORD 105 Password for ``basic`` authentication scheme. 106 107 TOKEN 108 Token for ``bearer`` authentication scheme. 109 110 HTTP SERVER OPTIONS 111 ------------------- 112 113 The following configuration value(s) belong to the “[ebisync-httpd]” section. 114 115 SERVE 116 This can either be ``tcp`` or ``unix``. 117 118 PORT 119 Port on which the HTTP server listens, e.g. 9967. 120 Only used if ``SERVE`` is ``tcp``. 121 122 BIND_TO 123 Which IP address should we bind to? E.g. ``127.0.0.1`` or ``::1``for loopback. Can also be given as a hostname. 124 Only used if ``SERVE`` is ``tcp``. 125 126 UNIXPATH 127 Which unix domain path should we bind to? 128 Only used if ``SERVE`` is ``unix``. 129 130 DATABASE OPTIONS 131 ---------------- 132 133 Setting the database belongs to the “[ebisyncdb-postgres]” section and the following value. 134 135 .. include:: frags/common-db-options.rs 136 137 SEE ALSO 138 ======== 139 140 libeufin-ebisync(1) 141 142 BUGS 143 ==== 144 145 Report bugs by using https://bugs.taler.net/ or by sending electronic 146 mail to <taler@gnu.org>.