summaryrefslogtreecommitdiff
path: root/doc/taler-exchange-httpd.1
blob: 9cb178abf509e6477a6bd67d0b374b029dd7b6d3 (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
.Dd April 22, 2015
.Dt TALER-EXCHANGE-HTTPD 1
.Os
.Sh NAME
.Nm taler-exchange-httpd
.Nd Run Taler exchange (with RESTful API)
.Sh SYNOPSIS
.Nm
.Op Fl C | -connection-close
.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
.Op Fl f Ar FILENAME | Fl -file-input= Ns Ar FILENAME
.Op Fl h | -help
.Op Fl i | -init-db
.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
.Op Fl t Ar SECONDS | Fl -timeout= Ns Ar SECONDS
.Op Fl v | -version
.Sh DESCRIPTION
.Nm
is a command line tool to run the Taler exchange (HTTP server).
The required configuration, keys and database must exist before
running this command.
.Pp
Its options are as follows:
.Bl -tag -width indent
.It Fl C | -connection-close
Force each HTTP connection to be closed after each request (useful
in combination with
.Fl f
to avoid having to wait for nc to time out).
.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
Use the configuration and other resources for the merchant to operate
from FILENAME.
.It Fl h | -help
Print short help on options.
.It Fl i | -init-db
Initialize the database by creating tables and indices if necessary.
.It Fl v | -version
Print version information.
.It Fl f Ar FILENAME | Fl -file-input= Ns Ar FILENAME
This option is only available if the exchange was compiled with the
configure option --enable-developer-mode.
It is used for generating test cases against the exchange using AFL.
When this option is present, the HTTP server will
.Bl -enum -offset indent -compact
.It
terminate after the first client's HTTP connection is completed, and
.It
automatically start such a client using a helper process based on the
.Xr nc 1
or
.Xr ncat 1
binary using FILENAME as the standard input to the helper process.
.El
As a result, the process will effectively run with
.Ar FILENAME
as the input from an HTTP client and then immediately exit.
This is useful to test taler-exchange-httpd against many different
possible inputs in a controlled way.
.It Fl t Ar SECONDS | Fl -timeout= Ns Ar SECONDS
Specifies the number of SECONDS after which the HTTPD should
close (idle) HTTP connections.
.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
Specifies the log level to use.
Accepted values are: DEBUG, INFO, WARNING, ERROR.
.El
.Sh SIGNALS
.Nm
responds to the following signals:
.Bl -tag -width indent
.It Dv SIGUSR1
Sending a SIGUSR1 to the process will cause it to reload denomination
and signing keys.
.It Dv SIGTERM
Sending a SIGTERM to the process will cause it to shutdown cleanly.
.It Dv SIGHUP
Sending a SIGHUP to the process will cause it to re-execute the
taler-exchange-httpd binary in the PATH, passing it the existing
listen socket.
Then the old server process will automatically exit after it is done
handling existing client connections; the new server process will
accept and handle new client connections.
.El
.Sh SEE ALSO
.Xr taler-exchange-dbinit 1 ,
.Xr taler-exchange-keyup 1 ,
.Xr taler-exchange-reservemod 1 ,
.Xr taler.conf 5 .
.Sh BUGS
Report bugs by using
.Lk https://gnunet.org/bugs
or by sending electronic mail to
.Aq Mt taler@gnu.org .