2015-01-09 16:37:42 +01:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
.
|
2015-01-11 11:03:45 +01:00
|
|
|
.TH "NGHTTPX" "1" "January 11, 2015" "0.7.1" "nghttp2"
|
2014-02-15 08:46:11 +01:00
|
|
|
.SH NAME
|
2014-05-16 16:54:09 +02:00
|
|
|
nghttpx \- HTTP/2 experimental proxy
|
2015-01-09 16:37:42 +01:00
|
|
|
.
|
|
|
|
.nr rst2man-indent-level 0
|
|
|
|
.
|
|
|
|
.de1 rstReportMargin
|
|
|
|
\\$1 \\n[an-margin]
|
|
|
|
level \\n[rst2man-indent-level]
|
|
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
-
|
|
|
|
\\n[rst2man-indent0]
|
|
|
|
\\n[rst2man-indent1]
|
|
|
|
\\n[rst2man-indent2]
|
|
|
|
..
|
|
|
|
.de1 INDENT
|
|
|
|
.\" .rstReportMargin pre:
|
|
|
|
. RS \\$1
|
|
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
|
|
. nr rst2man-indent-level +1
|
|
|
|
.\" .rstReportMargin post:
|
|
|
|
..
|
|
|
|
.de UNINDENT
|
|
|
|
. RE
|
|
|
|
.\" indent \\n[an-margin]
|
|
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
.nr rst2man-indent-level -1
|
|
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
|
|
..
|
2014-02-15 08:46:11 +01:00
|
|
|
.SH SYNOPSIS
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
\fBnghttpx\fP [OPTIONS]... [<PRIVATE_KEY> <CERT>]
|
2014-02-15 08:46:11 +01:00
|
|
|
.SH DESCRIPTION
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
2014-05-16 16:54:09 +02:00
|
|
|
A reverse proxy for HTTP/2, HTTP/1 and SPDY.
|
2015-01-09 16:37:42 +01:00
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B <PRIVATE_KEY>
|
|
|
|
Set path to server\(aqs private key. Required
|
|
|
|
unless \fI\%\-p\fP, \fI\%\-\-client\fP or \fI\%\-\-frontend\-no\-tls\fP are
|
2014-05-16 16:54:09 +02:00
|
|
|
given.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B <CERT>
|
|
|
|
Set path to server\(aqs certificate. Required
|
|
|
|
unless \fI\%\-p\fP, \fI\%\-\-client\fP or \fI\%\-\-frontend\-no\-tls\fP are
|
2014-05-16 16:54:09 +02:00
|
|
|
given.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.SH OPTIONS:
|
|
|
|
.sp
|
2014-05-16 16:54:09 +02:00
|
|
|
The options are categorized into several groups.
|
2015-01-09 16:37:42 +01:00
|
|
|
.SS Connections:
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-b, \-\-backend=<HOST,PORT>
|
2014-12-06 15:03:50 +01:00
|
|
|
Set backend host and port. For HTTP/1 backend,
|
|
|
|
multiple backend addresses are accepted by
|
|
|
|
repeating this option. HTTP/2 backend does not
|
|
|
|
support multiple backend addresses and the first
|
|
|
|
occurrence of this option is used.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB127.0.0.1,80\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-f, \-\-frontend=<HOST,PORT>
|
|
|
|
Set frontend host and port. If <HOST> is \(aq*\(aq, it
|
2014-06-02 15:36:22 +02:00
|
|
|
assumes all addresses including both IPv4 and
|
|
|
|
IPv6.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB*,3000\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backlog=<NUM>
|
|
|
|
Set listen backlog size. If \fI\-1\fP is given,
|
2014-05-16 16:54:09 +02:00
|
|
|
libevent will choose suitable value.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB128\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-ipv4
|
2014-05-16 16:54:09 +02:00
|
|
|
Resolve backend hostname to IPv4 address only.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-ipv6
|
2014-05-16 16:54:09 +02:00
|
|
|
Resolve backend hostname to IPv6 address only.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-29 17:15:31 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-http\-proxy\-uri=<URI>
|
2014-08-29 17:15:31 +02:00
|
|
|
Specify proxy URI in the form
|
2015-01-09 16:37:42 +01:00
|
|
|
\fI\%http:/\fP/[<USER>:<PASS>@]<PROXY>:<PORT>. If a
|
2014-08-29 17:15:31 +02:00
|
|
|
proxy requires authentication, specify <USER> and
|
|
|
|
<PASS>. Note that they must be properly
|
|
|
|
percent\-encoded. This proxy is used when the
|
|
|
|
backend connection is HTTP/2. First, make a
|
|
|
|
CONNECT request to the proxy and it connects to
|
|
|
|
the backend on behalf of nghttpx. This forms
|
|
|
|
tunnel. After that, nghttpx performs SSL/TLS
|
|
|
|
handshake with the downstream through the tunnel.
|
|
|
|
The timeouts when connecting and making CONNECT
|
|
|
|
request can be specified by
|
2015-01-09 16:37:42 +01:00
|
|
|
\fI\%\-\-backend\-read\-timeout\fP and
|
|
|
|
\fI\%\-\-backend\-write\-timeout\fP options.
|
|
|
|
.UNINDENT
|
|
|
|
.SS Performance:
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-n, \-\-workers=<CORES>
|
2014-02-15 08:46:11 +01:00
|
|
|
Set the number of worker threads.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB1\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-read\-rate=<RATE>
|
2014-08-29 17:15:31 +02:00
|
|
|
Set maximum average read rate on frontend
|
|
|
|
connection. Setting 0 to this option means read
|
|
|
|
rate is unlimited.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-29 17:15:31 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-read\-burst=<SIZE>
|
2014-08-29 17:15:31 +02:00
|
|
|
Set maximum read burst size on frontend
|
2015-01-06 17:40:55 +01:00
|
|
|
connection. Setting 0 to this option means read
|
|
|
|
burst size is unlimited.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-29 17:15:31 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-write\-rate=<RATE>
|
2014-08-29 17:15:31 +02:00
|
|
|
Set maximum average write rate on frontend
|
|
|
|
connection. Setting 0 to this option means write
|
|
|
|
rate is unlimited.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-29 17:15:31 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-write\-burst=<SIZE>
|
2014-08-29 17:15:31 +02:00
|
|
|
Set maximum write burst size on frontend
|
|
|
|
connection. Setting 0 to this option means write
|
|
|
|
burst size is unlimited.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-29 17:15:31 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-worker\-read\-rate=<RATE>
|
2014-05-16 16:54:09 +02:00
|
|
|
Set maximum average read rate on frontend
|
|
|
|
connection per worker. Setting 0 to this option
|
2015-01-06 17:40:55 +01:00
|
|
|
means read rate is unlimited. Not implemented
|
|
|
|
yet.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-worker\-read\-burst=<SIZE>
|
2014-05-16 16:54:09 +02:00
|
|
|
Set maximum read burst size on frontend
|
|
|
|
connection per worker. Setting 0 to this option
|
2015-01-06 17:40:55 +01:00
|
|
|
means read burst size is unlimited. Not
|
|
|
|
implemented yet.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-worker\-write\-rate=<RATE>
|
2014-05-16 16:54:09 +02:00
|
|
|
Set maximum average write rate on frontend
|
|
|
|
connection per worker. Setting 0 to this option
|
2015-01-06 17:40:55 +01:00
|
|
|
means write rate is unlimited. Not implemented
|
|
|
|
yet.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-worker\-write\-burst=<SIZE>
|
2014-05-16 16:54:09 +02:00
|
|
|
Set maximum write burst size on frontend
|
|
|
|
connection per worker. Setting 0 to this option
|
2015-01-06 17:40:55 +01:00
|
|
|
means write burst size is unlimited. Not
|
|
|
|
implemented yet.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-07-08 17:38:43 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-worker\-frontend\-connections=<NUM>
|
2014-07-08 17:38:43 +02:00
|
|
|
Set maximum number of simultaneous connections
|
|
|
|
frontend accepts. Setting 0 means unlimited.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-16 15:54:15 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-http1\-connections\-per\-host=<NUM>
|
2014-12-06 15:03:50 +01:00
|
|
|
Set maximum number of backend concurrent HTTP/1
|
|
|
|
connections per host. This option is meaningful
|
2015-01-09 16:37:42 +01:00
|
|
|
when \fI\%\-s\fP option is used. To limit the number of
|
2015-01-06 17:40:55 +01:00
|
|
|
connections per frontend for default mode, use
|
2015-01-09 16:37:42 +01:00
|
|
|
\fI\%\-\-backend\-http1\-connections\-per\-frontend\fP\&.
|
|
|
|
.sp
|
|
|
|
Default: \fB8\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2015-01-06 17:40:55 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-http1\-connections\-per\-frontend=<NUM>
|
2015-01-06 17:40:55 +01:00
|
|
|
Set maximum number of backend concurrent HTTP/1
|
|
|
|
connections per frontend. This option is only
|
|
|
|
used for default mode. 0 means unlimited. To
|
|
|
|
limit the number of connections per host for
|
2015-01-09 16:37:42 +01:00
|
|
|
HTTP/2 or SPDY proxy mode (\-s option), use
|
|
|
|
\fI\%\-\-backend\-http1\-connections\-per\-host\fP\&.
|
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
2015-01-11 09:34:43 +01:00
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-rlimit\-nofile=<N>
|
|
|
|
Set maximum number of open files (RLIMIT_NOFILE)
|
|
|
|
to <N>. If 0 is given, nghttpx does not set the
|
|
|
|
limit.
|
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
2015-01-09 16:37:42 +01:00
|
|
|
.SS Timeout:
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-frontend\-http2\-read\-timeout=<SEC>
|
2014-05-16 16:54:09 +02:00
|
|
|
Specify read timeout for HTTP/2 and SPDY frontend
|
|
|
|
connection.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB180\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-frontend\-read\-timeout=<SEC>
|
2014-05-16 16:54:09 +02:00
|
|
|
Specify read timeout for HTTP/1.1 frontend
|
|
|
|
connection.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB180\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-frontend\-write\-timeout=<SEC>
|
2014-05-16 16:54:09 +02:00
|
|
|
Specify write timeout for all frontend
|
|
|
|
connections.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB30\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-16 15:54:15 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-stream\-read\-timeout=<SEC>
|
2014-08-16 15:54:15 +02:00
|
|
|
Specify read timeout for HTTP/2 and SPDY streams.
|
|
|
|
0 means no timeout.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-16 15:54:15 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-stream\-write\-timeout=<SEC>
|
2014-08-16 15:54:15 +02:00
|
|
|
Specify write timeout for HTTP/2 and SPDY
|
|
|
|
streams. 0 means no timeout.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-read\-timeout=<SEC>
|
2014-02-15 08:46:11 +01:00
|
|
|
Specify read timeout for backend connection.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB180\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-write\-timeout=<SEC>
|
2014-05-16 16:54:09 +02:00
|
|
|
Specify write timeout for backend connection.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB30\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-keep\-alive\-timeout=<SEC>
|
2014-05-16 16:54:09 +02:00
|
|
|
Specify keep\-alive timeout for backend
|
|
|
|
connection.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB600\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-listener\-disable\-timeout=<SEC>
|
2014-08-29 17:15:31 +02:00
|
|
|
After accepting connection failed, connection
|
|
|
|
listener is disabled for a given time in seconds.
|
|
|
|
Specifying 0 disables this feature.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB0\fP
|
|
|
|
.UNINDENT
|
|
|
|
.SS SSL/TLS:
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-ciphers=<SUITE>
|
2014-05-16 16:54:09 +02:00
|
|
|
Set allowed cipher list. The format of the
|
2014-07-08 17:38:43 +02:00
|
|
|
string is described in OpenSSL ciphers(1).
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-k, \-\-insecure
|
|
|
|
Don\(aqt verify backend server\(aqs certificate if \fI\%\-p\fP,
|
|
|
|
\fI\%\-\-client\fP or \fI\%\-\-http2\-bridge\fP are given and
|
|
|
|
\fI\%\-\-backend\-no\-tls\fP is not given.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-cacert=<PATH>
|
|
|
|
Set path to trusted CA certificate file if \fI\%\-p\fP,
|
|
|
|
\fI\%\-\-client\fP or \fI\%\-\-http2\-bridge\fP are given and
|
|
|
|
\fI\%\-\-backend\-no\-tls\fP is not given. The file must be
|
2014-05-16 16:54:09 +02:00
|
|
|
in PEM format. It can contain multiple
|
|
|
|
certificates. If the linked OpenSSL is
|
|
|
|
configured to load system wide certificates, they
|
|
|
|
are loaded at startup regardless of this option.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-private\-key\-passwd\-file=<FILEPATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Path to file that contains password for the
|
2015-01-09 16:37:42 +01:00
|
|
|
server\(aqs private key. If none is given and the
|
|
|
|
private key is password protected it\(aqll be
|
2014-05-16 16:54:09 +02:00
|
|
|
requested interactively.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-subcert=<KEYPATH>:<CERTPATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Specify additional certificate and private key
|
|
|
|
file. nghttpx will choose certificates based on
|
|
|
|
the hostname indicated by client using TLS SNI
|
|
|
|
extension. This option can be used multiple
|
|
|
|
times.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-tls\-sni\-field=<HOST>
|
2014-05-16 16:54:09 +02:00
|
|
|
Explicitly set the content of the TLS SNI
|
|
|
|
extension. This will default to the backend HOST
|
|
|
|
name.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-dh\-param\-file=<PATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Path to file that contains DH parameters in PEM
|
|
|
|
format. Without this option, DHE cipher suites
|
|
|
|
are not available.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-npn\-list=<LIST>
|
2014-06-02 15:36:22 +02:00
|
|
|
Comma delimited list of ALPN protocol identifier
|
|
|
|
sorted in the order of preference. That means
|
|
|
|
most desirable protocol comes first. This is
|
|
|
|
used in both ALPN and NPN. The parameter must be
|
|
|
|
delimited by a single comma only and any white
|
|
|
|
spaces are treated as a part of protocol string.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fBh2\-16,h2\-14,spdy/3.1,http/1.1\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-verify\-client
|
2014-02-15 08:46:11 +01:00
|
|
|
Require and verify client certificate.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-verify\-client\-cacert=<PATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Path to file that contains CA certificates to
|
|
|
|
verify client certificate. The file must be in
|
|
|
|
PEM format. It can contain multiple
|
|
|
|
certificates.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-client\-private\-key\-file=<PATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Path to file that contains client private key
|
|
|
|
used in backend client authentication.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-client\-cert\-file=<PATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Path to file that contains client certificate
|
|
|
|
used in backend client authentication.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-tls\-proto\-list=<LIST>
|
2014-05-16 16:54:09 +02:00
|
|
|
Comma delimited list of SSL/TLS protocol to be
|
|
|
|
enabled. The following protocols are available:
|
2014-10-27 16:35:44 +01:00
|
|
|
TLSv1.2, TLSv1.1 and TLSv1.0. The name matching
|
|
|
|
is done in case\-insensitive manner. The
|
2014-05-16 16:54:09 +02:00
|
|
|
parameter must be delimited by a single comma
|
|
|
|
only and any white spaces are treated as a part
|
|
|
|
of protocol string.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fBTLSv1.2,TLSv1.1\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-\-tls\-ticket\-key\-file=<FILE>
|
|
|
|
Path to file that contains 48 bytes random data
|
|
|
|
to construct TLS session ticket parameters. This
|
|
|
|
options can be used repeatedly to specify
|
|
|
|
multiple ticket parameters. If several files are
|
|
|
|
given, only the first key is used to encrypt TLS
|
|
|
|
session tickets. Other keys are accepted but
|
|
|
|
server will issue new session ticket with first
|
|
|
|
key. This allows session key rotation. Please
|
|
|
|
note that key rotation does not occur
|
|
|
|
automatically. User should rearrange files or
|
|
|
|
change options values and restart nghttpx
|
|
|
|
gracefully. If opening or reading given file
|
|
|
|
fails, all loaded keys are discarded and it is
|
|
|
|
treated as if none of this option is given. If
|
|
|
|
this option is not given or an error occurred
|
|
|
|
while opening or reading a file, key is generated
|
|
|
|
automatically and renewed every 12hrs. At most 2
|
|
|
|
keys are stored in memory.
|
|
|
|
.UNINDENT
|
|
|
|
.SS HTTP/2 and SPDY:
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \-c, \-\-http2\-max\-concurrent\-streams=<NUM>
|
2014-05-16 16:54:09 +02:00
|
|
|
Set the maximum number of the concurrent streams
|
|
|
|
in one HTTP/2 and SPDY session.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB100\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-frontend\-http2\-window\-bits=<N>
|
2014-05-16 16:54:09 +02:00
|
|
|
Sets the per\-stream initial window size of HTTP/2
|
|
|
|
SPDY frontend connection. For HTTP/2, the size
|
|
|
|
is 2**<N>\-1. For SPDY, the size is 2**<N>.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB16\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-frontend\-http2\-connection\-window\-bits=<N>
|
2014-05-16 16:54:09 +02:00
|
|
|
Sets the per\-connection window size of HTTP/2 and
|
|
|
|
SPDY frontend connection. For HTTP/2, the size
|
|
|
|
is 2**<N>\-1. For SPDY, the size is 2**<N>.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB16\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-frontend\-no\-tls
|
2014-02-15 08:46:11 +01:00
|
|
|
Disable SSL/TLS on frontend connections.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-http2\-window\-bits=<N>
|
2014-05-16 16:54:09 +02:00
|
|
|
Sets the initial window size of HTTP/2 backend
|
|
|
|
connection to 2**<N>\-1.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB16\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-http2\-connection\-window\-bits=<N>
|
2014-05-16 16:54:09 +02:00
|
|
|
Sets the per\-connection window size of HTTP/2
|
2014-02-15 08:46:11 +01:00
|
|
|
backend connection to 2**<N>\-1.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB16\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-backend\-no\-tls
|
2014-02-15 08:46:11 +01:00
|
|
|
Disable SSL/TLS on backend connections.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-http2\-no\-cookie\-crumbling
|
|
|
|
Don\(aqt crumble cookie header field.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-padding=<N>
|
2014-05-16 16:54:09 +02:00
|
|
|
Add at most <N> bytes to a HTTP/2 frame payload
|
|
|
|
as padding. Specify 0 to disable padding. This
|
|
|
|
option is meant for debugging purpose and not
|
|
|
|
intended to enhance protocol security.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.SS Mode:
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B (default mode)
|
2014-05-16 16:54:09 +02:00
|
|
|
Accept HTTP/2, SPDY and HTTP/1.1 over SSL/TLS.
|
2015-01-09 16:37:42 +01:00
|
|
|
If \fI\%\-\-frontend\-no\-tls\fP is used, accept HTTP/2 and
|
2014-05-16 16:54:09 +02:00
|
|
|
HTTP/1.1. The incoming HTTP/1.1 connection can
|
|
|
|
be upgraded to HTTP/2 through HTTP Upgrade. The
|
|
|
|
protocol to the backend is HTTP/1.1.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-s, \-\-http2\-proxy
|
2014-02-15 08:46:11 +01:00
|
|
|
Like default mode, but enable secure proxy mode.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-http2\-bridge
|
2014-05-16 16:54:09 +02:00
|
|
|
Like default mode, but communicate with the
|
|
|
|
backend in HTTP/2 over SSL/TLS. Thus the
|
|
|
|
incoming all connections are converted to HTTP/2
|
|
|
|
connection and relayed to the backend. See
|
2015-01-09 16:37:42 +01:00
|
|
|
\fI\%\-\-backend\-http\-proxy\-uri\fP option if you are behind
|
2014-05-16 16:54:09 +02:00
|
|
|
the proxy and want to connect to the outside
|
|
|
|
HTTP/2 proxy.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-client
|
2014-05-16 16:54:09 +02:00
|
|
|
Accept HTTP/2 and HTTP/1.1 without SSL/TLS. The
|
|
|
|
incoming HTTP/1.1 connection can be upgraded to
|
|
|
|
HTTP/2 connection through HTTP Upgrade. The
|
|
|
|
protocol to the backend is HTTP/2. To use
|
2015-01-09 16:37:42 +01:00
|
|
|
nghttpx as a forward proxy, use \fI\%\-p\fP option
|
2014-05-16 16:54:09 +02:00
|
|
|
instead.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-p, \-\-client\-proxy
|
|
|
|
Like \fI\%\-\-client\fP option, but it also requires the
|
2014-05-16 16:54:09 +02:00
|
|
|
request path from frontend must be an absolute
|
|
|
|
URI, suitable for use as a forward proxy.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.SS Logging:
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-L, \-\-log\-level=<LEVEL>
|
2014-05-16 16:54:09 +02:00
|
|
|
Set the severity level of log output. <LEVEL>
|
2014-11-08 14:55:24 +01:00
|
|
|
must be one of INFO, NOTICE, WARN, ERROR and
|
|
|
|
FATAL.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fBNOTICE\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-accesslog\-file=<PATH>
|
2014-07-08 17:38:43 +02:00
|
|
|
Set path to write access log. To reopen file,
|
|
|
|
send USR1 signal to nghttpx.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-07-08 17:38:43 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-accesslog\-syslog
|
2014-07-08 17:38:43 +02:00
|
|
|
Send access log to syslog. If this option is
|
2015-01-09 16:37:42 +01:00
|
|
|
used, \fI\%\-\-accesslog\-file\fP option is ignored.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-07-08 17:38:43 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-accesslog\-format=<FORMAT>
|
2014-11-24 07:27:41 +01:00
|
|
|
Specify format string for access log. The
|
|
|
|
default format is combined format. The following
|
|
|
|
variables are available:
|
2015-01-09 16:37:42 +01:00
|
|
|
.INDENT 7.0
|
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$remote_addr: client IP address.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$time_local: local time in Common Log format.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$time_iso8601: local time in ISO 8601 format.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$request: HTTP request line.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$status: HTTP response status code.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$body_bytes_sent: the number of bytes sent to
|
|
|
|
client as response body.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$http_<VAR>: value of HTTP request header <VAR>
|
2015-01-09 16:37:42 +01:00
|
|
|
where \(aq_\(aq in <VAR> is replaced with \(aq\-\(aq.
|
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$remote_port: client port.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$server_port: server port.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$request_time: request processing time in
|
|
|
|
seconds with milliseconds resolution.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
2014-11-24 07:27:41 +01:00
|
|
|
$pid: PID of the running process.
|
2015-01-09 16:37:42 +01:00
|
|
|
.IP \(bu 2
|
|
|
|
$alpn: ALPN identifier of the protocol which
|
|
|
|
generates the response. For HTTP/1, ALPN is
|
2014-11-24 07:27:41 +01:00
|
|
|
always http/1.1, regardless of minor version.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.sp
|
|
|
|
Default: \fB$remote_addr \- \- [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-11-24 07:27:41 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-errorlog\-file=<PATH>
|
2014-07-08 17:38:43 +02:00
|
|
|
Set path to write error log. To reopen file,
|
|
|
|
send USR1 signal to nghttpx.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB/dev/stderr\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-errorlog\-syslog
|
2014-07-08 17:38:43 +02:00
|
|
|
Send error log to syslog. If this option is
|
2015-01-09 16:37:42 +01:00
|
|
|
used, \fI\%\-\-errorlog\-file\fP option is ignored.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-syslog\-facility=<FACILITY>
|
2014-05-16 16:54:09 +02:00
|
|
|
Set syslog facility to <FACILITY>.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fBdaemon\fP
|
|
|
|
.UNINDENT
|
|
|
|
.SS Misc:
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-add\-x\-forwarded\-for
|
2014-05-16 16:54:09 +02:00
|
|
|
Append X\-Forwarded\-For header field to the
|
2014-02-15 08:46:11 +01:00
|
|
|
downstream request.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-strip\-incoming\-x\-forwarded\-for
|
2014-10-27 16:35:44 +01:00
|
|
|
Strip X\-Forwarded\-For header field from inbound
|
|
|
|
client requests.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-10-27 16:35:44 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-no\-via
|
|
|
|
Don\(aqt append to Via header field. If Via header
|
2014-05-16 16:54:09 +02:00
|
|
|
field is received, it is left unaltered.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-no\-location\-rewrite
|
|
|
|
Don\(aqt rewrite location header field on
|
|
|
|
\fI\%\-\-http2\-bridge\fP, \fI\%\-\-client\fP and default mode. For
|
|
|
|
\fI\%\-\-http2\-proxy\fP and \fI\%\-\-client\-proxy\fP mode, location
|
2014-08-16 15:54:15 +02:00
|
|
|
header field will not be altered regardless of
|
|
|
|
this option.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-08-16 15:54:15 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-altsvc=<PROTOID,PORT[,HOST,[ORIGIN]]>
|
2014-05-16 16:54:09 +02:00
|
|
|
Specify protocol ID, port, host and origin of
|
|
|
|
alternative service. <HOST> and <ORIGIN> are
|
|
|
|
optional. They are advertised in alt\-svc header
|
|
|
|
field or HTTP/2 ALTSVC frame. This option can be
|
|
|
|
used multiple times to specify multiple
|
2015-01-09 16:37:42 +01:00
|
|
|
alternative services. Example: \fI\%\-\-altsvc\fP=h2,443
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-add\-response\-header=<HEADER>
|
2014-05-16 16:54:09 +02:00
|
|
|
Specify additional header field to add to
|
|
|
|
response header set. This option just appends
|
2015-01-09 16:37:42 +01:00
|
|
|
header field and won\(aqt replace anything already
|
2014-05-16 16:54:09 +02:00
|
|
|
set. This option can be used several times to
|
|
|
|
specify multiple header fields.
|
2015-01-09 16:37:42 +01:00
|
|
|
Example: \fI\%\-\-add\-response\-header\fP="foo: bar"
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-frontend\-http2\-dump\-request\-header=<PATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Dumps request headers received by HTTP/2 frontend
|
|
|
|
to the file denoted in <PATH>. The output is
|
|
|
|
done in HTTP/1 header field format and each
|
|
|
|
header block is followed by an empty line. This
|
|
|
|
option is not thread safe and MUST NOT be used
|
2015-01-09 16:37:42 +01:00
|
|
|
with option \fI\%\-n\fP<N>, where <N> >= 2.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-frontend\-http2\-dump\-response\-header=<PATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Dumps response headers sent from HTTP/2 frontend
|
|
|
|
to the file denoted in <PATH>. The output is
|
|
|
|
done in HTTP/1 header field format and each
|
|
|
|
header block is followed by an empty line. This
|
|
|
|
option is not thread safe and MUST NOT be used
|
2015-01-09 16:37:42 +01:00
|
|
|
with option \fI\%\-n\fP<N>, where <N> >= 2.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-05-16 16:54:09 +02:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-o, \-\-frontend\-frame\-debug
|
2014-05-16 16:54:09 +02:00
|
|
|
Print HTTP/2 frames in frontend to stderr. This
|
|
|
|
option is not thread safe and MUST NOT be used
|
2015-01-09 16:37:42 +01:00
|
|
|
with option \fI\%\-n\fP=N, where N >= 2.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-D, \-\-daemon
|
|
|
|
Run in a background. If \fI\%\-D\fP is used, the current
|
|
|
|
working directory is changed to \(aq\fI/\fP\(aq.
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-pid\-file=<PATH>
|
2014-02-15 08:46:11 +01:00
|
|
|
Set path to save PID of this program.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-user=<USER>
|
2014-05-16 16:54:09 +02:00
|
|
|
Run this program as <USER>. This option is
|
2014-02-15 08:46:11 +01:00
|
|
|
intended to be used to drop root privileges.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-\-conf=<PATH>
|
2014-05-16 16:54:09 +02:00
|
|
|
Load configuration from <PATH>.
|
2015-01-09 16:37:42 +01:00
|
|
|
.sp
|
|
|
|
Default: \fB/etc/nghttpx/nghttpx.conf\fP
|
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-v, \-\-version
|
2014-02-15 08:46:11 +01:00
|
|
|
Print version and exit.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.INDENT 0.0
|
2014-02-15 08:46:11 +01:00
|
|
|
.TP
|
2015-01-09 16:37:42 +01:00
|
|
|
.B \-h, \-\-help
|
2014-02-15 08:46:11 +01:00
|
|
|
Print this help and exit.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.SH FILES
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B \fI/etc/nghttpx/nghttpx.conf\fP
|
|
|
|
The default configuration file path nghttpx searches at startup.
|
|
|
|
The configuration file path can be changed using \fI\%\-\-conf\fP
|
|
|
|
option.
|
2015-01-11 09:34:43 +01:00
|
|
|
.sp
|
|
|
|
Those lines which are staring \fB#\fP are treated as comment.
|
|
|
|
.sp
|
|
|
|
The option name in the configuration file is the long command\-line
|
|
|
|
option name with leading \fB\-\-\fP stripped (e.g., \fBfrontend\fP). Put
|
|
|
|
\fB=\fP between option name and value. Don\(aqt put extra leading or
|
|
|
|
trailing spaces.
|
|
|
|
.sp
|
|
|
|
The options which do not take argument in the command\-line \fItake\fP
|
|
|
|
argument in the configuration file. Specify \fByes\fP as an argument
|
|
|
|
(e.g., \fBhttp2\-proxy=yes\fP). If other string is given, it is
|
|
|
|
ignored.
|
|
|
|
.sp
|
|
|
|
To specify private key and certificate file which are given as
|
|
|
|
positional arguments in commnad\-line, use \fBprivate\-key\-file\fP and
|
|
|
|
\fBcertificate\-file\fP\&.
|
|
|
|
.sp
|
|
|
|
\fI\%\-\-conf\fP option cannot be used in the configuration file and
|
|
|
|
will be ignored if specified.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.SH SIGNALS
|
|
|
|
.INDENT 0.0
|
|
|
|
.TP
|
|
|
|
.B SIGQUIT
|
|
|
|
Shutdown gracefully. First accept pending connections and stop
|
|
|
|
accepting connection. After all connections are handled, nghttpx
|
|
|
|
exits.
|
|
|
|
.TP
|
|
|
|
.B SIGUSR1
|
|
|
|
Reopen log files.
|
|
|
|
.TP
|
|
|
|
.B SIGUSR2
|
|
|
|
Fork and execute nghttpx. It will execute the binary in the same
|
2015-01-10 09:12:24 +01:00
|
|
|
path with same command\-line arguments and environment variables.
|
|
|
|
After new process comes up, sending SIGQUIT to the original process
|
|
|
|
to perform hot swapping.
|
2015-01-09 16:37:42 +01:00
|
|
|
.UNINDENT
|
|
|
|
.SH SEE ALSO
|
|
|
|
.sp
|
|
|
|
\fInghttp(1)\fP, \fInghttpd(1)\fP, \fIh2load(1)\fP
|
|
|
|
.SH AUTHOR
|
|
|
|
Tatsuhiro Tsujikawa
|
|
|
|
.SH COPYRIGHT
|
2015-01-10 09:12:24 +01:00
|
|
|
2012, 2015, Tatsuhiro Tsujikawa
|
2015-01-09 16:37:42 +01:00
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
.
|