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