summaryrefslogtreecommitdiff
path: root/manpages/libeufin-bank.1.rst
blob: 681eb3ab5a3844afa83379b5ebdf4c7d36b9a184 (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
libeufin-bank(1)
#################

.. only:: html

   Name
   ====

   **libeufin-bank** - LibEuFin Bank


Synopsis
========

**libeufin-bank**
[**-h** | **--help**]
[**--version**]
COMMAND [ARGS...]

Subcommands: **serve**, **dbinit**, **passwd**, **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.
**-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.

passwd
------

This command change any account password.

It takes two arguments, the account login and the account new password.

Its options are as follows:

**-h** \| **--help**
   Print short help on options.
**-c** \| **--config** \ ‌\ *FILENAME*
   Specifies the configuration file.

config
------

TODO

SEE ALSO
========

libeufin-bank.conf(5)

Bugs
====

Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.