libeufin-bank.1.rst (5257B)
1 libeufin-bank(1) 2 ################# 3 4 .. only:: html 5 6 Name 7 ==== 8 9 **libeufin-bank** - LibEuFin Bank 10 11 12 Synopsis 13 ======== 14 15 **libeufin-bank** 16 [**-h** | **--help**] 17 [**--version**] 18 COMMAND [ARGS...] 19 20 Subcommands: **dbinit**, **passwd**, **create-token**, **serve**, **create-account**, **edit-account**, **gc**, **bench-pwh**, **config** 21 22 23 Description 24 =========== 25 26 **libeufin-bank** is a program that implements a simple core banking system with 27 account and REST APIs, including REST APIs for a Web interface 28 and REST APIs to interact with GNU Taler components. 29 30 Its options are as follows: 31 32 **-h** \| **--help** 33 Print short help on options. 34 35 **–version** 36 Print version information. 37 38 The interaction model is as follows: 39 40 - Configure the database with commands ``dbinit``. 41 42 - Set admin account password with commands ``passwd``. 43 44 - Start the HTTP server with command ``serve``. 45 Let this run in a shell, writing logs to stderr. 46 47 The following sections describe each command in detail. 48 49 dbinit 50 ------ 51 52 This command defines the database schema for LibEuFin Bank. It is mandatory to run this command before invoking the ``passwd`` or ``serve`` commands. 53 54 Its options are as follows: 55 56 **-c** \| **--config** *config_file* 57 Specifies the configuration file. 58 **-L** \| **--log** *LOGLEVEL* 59 Configure logging to use LOGLEVEL. 60 **-r** \| **--reset** 61 Reset database (DANGEROUS: All existing data is lost) 62 **-h** \| **--help** 63 Print short help on options. 64 65 passwd 66 ------ 67 68 This command change any account password. 69 70 It takes two arguments, the account username and the account new password. 71 72 Its options are as follows: 73 74 **-c** \| **--config** *config_file* 75 Specifies the configuration file. 76 **-L** \| **--log** *LOGLEVEL* 77 Configure logging to use LOGLEVEL. 78 **-h** \| **--help** 79 Print short help on options. 80 81 create-token 82 ------------ 83 84 Create authentication token for a userword. 85 86 Its options are as follows: 87 88 **-c** \| **--config** *config_file* 89 Specifies the configuration file. 90 **-L** \| **--log** *LOGLEVEL* 91 Configure logging to use LOGLEVEL. 92 **-u** \| **--user** \| **--username** *USERNAME* 93 Account username. 94 **-s** \| **--scope** *SCOPE* 95 Scope for the token. 96 **-d** \| **--duration** *forever|MICROS* 97 Custom token validity duration. 98 **--description** *DESCRIPTION* 99 Optional token description. 100 **--refreshable** 101 Make the token refreshable into a new token. 102 **--current-token** *TOKEN* 103 Current token to reuse if still valid. 104 **-h** \| **--help** 105 Print short help on options. 106 107 serve 108 ----- 109 110 This command starts the HTTP server. 111 112 Its options are as follows: 113 114 **-c** \| **--config** *config_file* 115 Specifies the configuration file. 116 **-L** \| **--log** *LOGLEVEL* 117 Configure logging to use LOGLEVEL. 118 **-h** \| **--help** 119 Print short help on options. 120 121 create-account 122 -------------- 123 124 This command create a bank account and prints its payto://-URI to STDOUT. 125 126 Its options are as follows: 127 128 **-c** \| **--config** *config_file* 129 Specifies the configuration file. 130 **-L** \| **--log** *LOGLEVEL* 131 Configure logging to use LOGLEVEL. 132 **-u** \| **--user** \| **--username** *USERNAME* 133 Account unique username. 134 **-p** \| **--password** *PASSWORD* 135 Account password used for authentication. 136 **--name** *NAME* 137 Legal name of the account owner. 138 **--public** 139 Make this account visible to anyone. 140 **--exchange** 141 Make this account a taler exchange. 142 **--email** *EMAIL* 143 E-Mail address used for TAN transmission. 144 **--phone** *PHONE_NUMBER* 145 Phone number used for TAN transmission. 146 **--cashout_payto_uri** *PAYTO_URI* 147 Payto URI of a fiant account who receive cashout amount. 148 **--payto_uri** *PAYTO_URI* 149 Payto URI of this account. 150 **--debit_threshold** *AMOUNT* 151 Max debit allowed for this account. 152 **--tan_channel** *TAN_CHANNEL* 153 Enables 2FA and set the TAN channel used for challenges. 154 **-h** \| **--help** 155 Print short help on options. 156 157 edit-account 158 -------------- 159 160 This command edit an existing account. 161 162 It takes one argument, the account username. 163 164 Its options are as follows: 165 166 **-c** \| **--config** *config_file* 167 Specifies the configuration file. 168 **-L** \| **--log** *LOGLEVEL* 169 Configure logging to use LOGLEVEL. 170 **--name** *NAME* 171 Legal name of the account owner. 172 **--public** *true|false* 173 Make this account visible to anyone. 174 **--email** *EMAIL* 175 E-Mail address used for TAN transmission. 176 **--phone** *PHONE_NUMBER* 177 Phone number used for TAN transmission. 178 **--cashout_payto_uri** *PAYTO_URI* 179 Payto URI of this account. 180 **--debit_threshold** *AMOUNT* 181 Max debit allowed for this account. 182 **--tan_channel** *TAN_CHANNEL* 183 Enables 2FA and set the TAN channel used for challenges. 184 **-h** \| **--help** 185 Print short help on options. 186 187 gc 188 -- 189 190 This command performs garbage collection: abort expired operations and clean expired data. 191 192 Its options are as follows: 193 194 **-c** \| **--config** *config_file* 195 Specifies the configuration file. 196 **-L** \| **--log** *LOGLEVEL* 197 Configure logging to use LOGLEVEL. 198 **-h** \| **--help** 199 Print short help on options. 200 201 .. include:: ../frags/common-config-cli.rst 202 203 204 SEE ALSO 205 ======== 206 207 libeufin-bank.conf(5) 208 209 Bugs 210 ==== 211 212 Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.