Update man pages
This commit is contained in:
Tatsuhiro Tsujikawa
parent
d8c8a4631d
commit
5f1866fd6b
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "H2LOAD" "1" "February 07, 2016" "1.8.0-DEV" "nghttp2"
|
.TH "H2LOAD" "1" "February 14, 2016" "1.8.0-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
h2load \- HTTP/2 benchmarking tool
|
h2load \- HTTP/2 benchmarking tool
|
||||||
.
|
.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTP" "1" "February 07, 2016" "1.8.0-DEV" "nghttp2"
|
.TH "NGHTTP" "1" "February 14, 2016" "1.8.0-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttp \- HTTP/2 client
|
nghttp \- HTTP/2 client
|
||||||
.
|
.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTPD" "1" "February 07, 2016" "1.8.0-DEV" "nghttp2"
|
.TH "NGHTTPD" "1" "February 14, 2016" "1.8.0-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttpd \- HTTP/2 server
|
nghttpd \- HTTP/2 server
|
||||||
.
|
.
|
||||||
|
|
|
||||||
102
doc/nghttpx.1
102
doc/nghttpx.1
|
|
@ -1,6 +1,6 @@
|
||||||
.\" Man page generated from reStructuredText.
|
.\" Man page generated from reStructuredText.
|
||||||
.
|
.
|
||||||
.TH "NGHTTPX" "1" "February 07, 2016" "1.8.0-DEV" "nghttp2"
|
.TH "NGHTTPX" "1" "February 14, 2016" "1.8.0-DEV" "nghttp2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
nghttpx \- HTTP/2 proxy
|
nghttpx \- HTTP/2 proxy
|
||||||
.
|
.
|
||||||
|
|
@ -136,13 +136,13 @@ Default: \fB512\fP
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
.B \-\-backend\-ipv4
|
.B \-\-backend\-address\-family=(auto|IPv4|IPv6)
|
||||||
Resolve backend hostname to IPv4 address only.
|
Specify address family of backend connections. If
|
||||||
.UNINDENT
|
"auto" is given, both IPv4 and IPv6 are considered. If
|
||||||
.INDENT 0.0
|
"IPv4" is given, only IPv4 address is considered. If
|
||||||
.TP
|
"IPv6" is given, only IPv6 address is considered.
|
||||||
.B \-\-backend\-ipv6
|
.sp
|
||||||
Resolve backend hostname to IPv6 address only.
|
Default: \fBauto\fP
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
|
@ -534,16 +534,27 @@ required.
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
.B \-\-tls\-ticket\-key\-memcached=<HOST>,<PORT>
|
.B \-\-tls\-ticket\-key\-memcached=<HOST>,<PORT>
|
||||||
Specify address of memcached server to store session
|
Specify address of memcached server to get TLS ticket
|
||||||
cache. This enables shared TLS ticket key between
|
keys for session resumption. This enables shared TLS
|
||||||
multiple nghttpx instances. nghttpx does not set TLS
|
ticket key between multiple nghttpx instances. nghttpx
|
||||||
ticket key to memcached. The external ticket key
|
does not set TLS ticket key to memcached. The external
|
||||||
generator is required. nghttpx just gets TLS ticket
|
ticket key generator is required. nghttpx just gets TLS
|
||||||
keys from memcached, and use them, possibly replacing
|
ticket keys from memcached, and use them, possibly
|
||||||
current set of keys. It is up to extern TLS ticket key
|
replacing current set of keys. It is up to extern TLS
|
||||||
generator to rotate keys frequently. See "TLS SESSION
|
ticket key generator to rotate keys frequently. See
|
||||||
TICKET RESUMPTION" section in manual page to know the
|
"TLS SESSION TICKET RESUMPTION" section in manual page
|
||||||
data format in memcached entry.
|
to know the data format in memcached entry.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-tls\-ticket\-key\-memcached\-address\-family=(auto|IPv4|IPv6)
|
||||||
|
Specify address family of memcached connections to get
|
||||||
|
TLS ticket keys. If "auto" is given, both IPv4 and IPv6
|
||||||
|
are considered. If "IPv4" is given, only IPv4 address
|
||||||
|
is considered. If "IPv6" is given, only IPv6 address is
|
||||||
|
considered.
|
||||||
|
.sp
|
||||||
|
Default: \fBauto\fP
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
|
@ -581,6 +592,24 @@ aes\-128\-cbc is used.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
.B \-\-tls\-ticket\-key\-memcached\-tls
|
||||||
|
Enable SSL/TLS on memcached connections to get TLS
|
||||||
|
ticket keys.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-tls\-ticket\-key\-memcached\-cert\-file=<PATH>
|
||||||
|
Path to client certificate for memcached connections to
|
||||||
|
get TLS ticket keys.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-tls\-ticket\-key\-memcached\-private\-key\-file=<PATH>
|
||||||
|
Path to client private key for memcached connections to
|
||||||
|
get TLS ticket keys.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
.B \-\-fetch\-ocsp\-response\-file=<PATH>
|
.B \-\-fetch\-ocsp\-response\-file=<PATH>
|
||||||
Path to fetch\-ocsp\-response script file. It should be
|
Path to fetch\-ocsp\-response script file. It should be
|
||||||
absolute path.
|
absolute path.
|
||||||
|
|
@ -608,6 +637,35 @@ multiple nghttpx instances.
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.TP
|
.TP
|
||||||
|
.B \-\-tls\-session\-cache\-memcached\-address\-family=(auto|IPv4|IPv6)
|
||||||
|
Specify address family of memcached connections to store
|
||||||
|
session cache. If "auto" is given, both IPv4 and IPv6
|
||||||
|
are considered. If "IPv4" is given, only IPv4 address
|
||||||
|
is considered. If "IPv6" is given, only IPv6 address is
|
||||||
|
considered.
|
||||||
|
.sp
|
||||||
|
Default: \fBauto\fP
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-tls\-session\-cache\-memcached\-tls
|
||||||
|
Enable SSL/TLS on memcached connections to store session
|
||||||
|
cache.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-tls\-session\-cache\-memcached\-cert\-file=<PATH>
|
||||||
|
Path to client certificate for memcached connections to
|
||||||
|
store session cache.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
|
.B \-\-tls\-session\-cache\-memcached\-private\-key\-file=<PATH>
|
||||||
|
Path to client private key for memcached connections to
|
||||||
|
store session cache.
|
||||||
|
.UNINDENT
|
||||||
|
.INDENT 0.0
|
||||||
|
.TP
|
||||||
.B \-\-tls\-dyn\-rec\-warmup\-threshold=<SIZE>
|
.B \-\-tls\-dyn\-rec\-warmup\-threshold=<SIZE>
|
||||||
Specify the threshold size for TLS dynamic record size
|
Specify the threshold size for TLS dynamic record size
|
||||||
behaviour. During a TLS session, after the threshold
|
behaviour. During a TLS session, after the threshold
|
||||||
|
|
@ -1251,6 +1309,10 @@ insert serialized session data to memcached with
|
||||||
\fBnghttpx:tls\-session\-cache:\fP + lowercased hex string of session ID
|
\fBnghttpx:tls\-session\-cache:\fP + lowercased hex string of session ID
|
||||||
as a memcached entry key, with expiry time 12 hours. Session timeout
|
as a memcached entry key, with expiry time 12 hours. Session timeout
|
||||||
is set to 12 hours.
|
is set to 12 hours.
|
||||||
|
.sp
|
||||||
|
By default, connections to memcached server are not encrypted. To
|
||||||
|
enable encryption, use \fI\%\-\-tls\-session\-cache\-memcached\-tls\fP
|
||||||
|
option.
|
||||||
.SS TLS SESSION TICKET RESUMPTION
|
.SS TLS SESSION TICKET RESUMPTION
|
||||||
.sp
|
.sp
|
||||||
By default, session ticket is shared by all worker threads. The
|
By default, session ticket is shared by all worker threads. The
|
||||||
|
|
@ -1295,6 +1357,10 @@ used, LEN must be 48. If
|
||||||
keys. The key appeared first is used as encryption key. All the
|
keys. The key appeared first is used as encryption key. All the
|
||||||
remaining keys are used as decryption only.
|
remaining keys are used as decryption only.
|
||||||
.sp
|
.sp
|
||||||
|
By default, connections to memcached server are not encrypted. To
|
||||||
|
enable encryption, use \fI\%\-\-tls\-ticket\-key\-memcached\-tls\fP
|
||||||
|
option.
|
||||||
|
.sp
|
||||||
If \fI\%\-\-tls\-ticket\-key\-file\fP is given, encryption key is read
|
If \fI\%\-\-tls\-ticket\-key\-file\fP is given, encryption key is read
|
||||||
from the given file. In this case, nghttpx does not rotate key
|
from the given file. In this case, nghttpx does not rotate key
|
||||||
automatically. To rotate key, one has to restart nghttpx (see
|
automatically. To rotate key, one has to restart nghttpx (see
|
||||||
|
|
|
||||||
|
|
@ -116,13 +116,14 @@ Connections
|
||||||
|
|
||||||
Default: ``512``
|
Default: ``512``
|
||||||
|
|
||||||
.. option:: --backend-ipv4
|
.. option:: --backend-address-family=(auto|IPv4|IPv6)
|
||||||
|
|
||||||
Resolve backend hostname to IPv4 address only.
|
Specify address family of backend connections. If
|
||||||
|
"auto" is given, both IPv4 and IPv6 are considered. If
|
||||||
|
"IPv4" is given, only IPv4 address is considered. If
|
||||||
|
"IPv6" is given, only IPv6 address is considered.
|
||||||
|
|
||||||
.. option:: --backend-ipv6
|
Default: ``auto``
|
||||||
|
|
||||||
Resolve backend hostname to IPv6 address only.
|
|
||||||
|
|
||||||
.. option:: --backend-http-proxy-uri=<URI>
|
.. option:: --backend-http-proxy-uri=<URI>
|
||||||
|
|
||||||
|
|
@ -477,16 +478,26 @@ SSL/TLS
|
||||||
|
|
||||||
.. option:: --tls-ticket-key-memcached=<HOST>,<PORT>
|
.. option:: --tls-ticket-key-memcached=<HOST>,<PORT>
|
||||||
|
|
||||||
Specify address of memcached server to store session
|
Specify address of memcached server to get TLS ticket
|
||||||
cache. This enables shared TLS ticket key between
|
keys for session resumption. This enables shared TLS
|
||||||
multiple nghttpx instances. nghttpx does not set TLS
|
ticket key between multiple nghttpx instances. nghttpx
|
||||||
ticket key to memcached. The external ticket key
|
does not set TLS ticket key to memcached. The external
|
||||||
generator is required. nghttpx just gets TLS ticket
|
ticket key generator is required. nghttpx just gets TLS
|
||||||
keys from memcached, and use them, possibly replacing
|
ticket keys from memcached, and use them, possibly
|
||||||
current set of keys. It is up to extern TLS ticket key
|
replacing current set of keys. It is up to extern TLS
|
||||||
generator to rotate keys frequently. See "TLS SESSION
|
ticket key generator to rotate keys frequently. See
|
||||||
TICKET RESUMPTION" section in manual page to know the
|
"TLS SESSION TICKET RESUMPTION" section in manual page
|
||||||
data format in memcached entry.
|
to know the data format in memcached entry.
|
||||||
|
|
||||||
|
.. option:: --tls-ticket-key-memcached-address-family=(auto|IPv4|IPv6)
|
||||||
|
|
||||||
|
Specify address family of memcached connections to get
|
||||||
|
TLS ticket keys. If "auto" is given, both IPv4 and IPv6
|
||||||
|
are considered. If "IPv4" is given, only IPv4 address
|
||||||
|
is considered. If "IPv6" is given, only IPv6 address is
|
||||||
|
considered.
|
||||||
|
|
||||||
|
Default: ``auto``
|
||||||
|
|
||||||
.. option:: --tls-ticket-key-memcached-interval=<DURATION>
|
.. option:: --tls-ticket-key-memcached-interval=<DURATION>
|
||||||
|
|
||||||
|
|
@ -518,6 +529,21 @@ SSL/TLS
|
||||||
either aes-128-cbc or aes-256-cbc. By default,
|
either aes-128-cbc or aes-256-cbc. By default,
|
||||||
aes-128-cbc is used.
|
aes-128-cbc is used.
|
||||||
|
|
||||||
|
.. option:: --tls-ticket-key-memcached-tls
|
||||||
|
|
||||||
|
Enable SSL/TLS on memcached connections to get TLS
|
||||||
|
ticket keys.
|
||||||
|
|
||||||
|
.. option:: --tls-ticket-key-memcached-cert-file=<PATH>
|
||||||
|
|
||||||
|
Path to client certificate for memcached connections to
|
||||||
|
get TLS ticket keys.
|
||||||
|
|
||||||
|
.. option:: --tls-ticket-key-memcached-private-key-file=<PATH>
|
||||||
|
|
||||||
|
Path to client private key for memcached connections to
|
||||||
|
get TLS ticket keys.
|
||||||
|
|
||||||
.. option:: --fetch-ocsp-response-file=<PATH>
|
.. option:: --fetch-ocsp-response-file=<PATH>
|
||||||
|
|
||||||
Path to fetch-ocsp-response script file. It should be
|
Path to fetch-ocsp-response script file. It should be
|
||||||
|
|
@ -541,6 +567,31 @@ SSL/TLS
|
||||||
cache. This enables shared session cache between
|
cache. This enables shared session cache between
|
||||||
multiple nghttpx instances.
|
multiple nghttpx instances.
|
||||||
|
|
||||||
|
.. option:: --tls-session-cache-memcached-address-family=(auto|IPv4|IPv6)
|
||||||
|
|
||||||
|
Specify address family of memcached connections to store
|
||||||
|
session cache. If "auto" is given, both IPv4 and IPv6
|
||||||
|
are considered. If "IPv4" is given, only IPv4 address
|
||||||
|
is considered. If "IPv6" is given, only IPv6 address is
|
||||||
|
considered.
|
||||||
|
|
||||||
|
Default: ``auto``
|
||||||
|
|
||||||
|
.. option:: --tls-session-cache-memcached-tls
|
||||||
|
|
||||||
|
Enable SSL/TLS on memcached connections to store session
|
||||||
|
cache.
|
||||||
|
|
||||||
|
.. option:: --tls-session-cache-memcached-cert-file=<PATH>
|
||||||
|
|
||||||
|
Path to client certificate for memcached connections to
|
||||||
|
store session cache.
|
||||||
|
|
||||||
|
.. option:: --tls-session-cache-memcached-private-key-file=<PATH>
|
||||||
|
|
||||||
|
Path to client private key for memcached connections to
|
||||||
|
store session cache.
|
||||||
|
|
||||||
.. option:: --tls-dyn-rec-warmup-threshold=<SIZE>
|
.. option:: --tls-dyn-rec-warmup-threshold=<SIZE>
|
||||||
|
|
||||||
Specify the threshold size for TLS dynamic record size
|
Specify the threshold size for TLS dynamic record size
|
||||||
|
|
@ -1134,6 +1185,10 @@ insert serialized session data to memcached with
|
||||||
as a memcached entry key, with expiry time 12 hours. Session timeout
|
as a memcached entry key, with expiry time 12 hours. Session timeout
|
||||||
is set to 12 hours.
|
is set to 12 hours.
|
||||||
|
|
||||||
|
By default, connections to memcached server are not encrypted. To
|
||||||
|
enable encryption, use :option:`--tls-session-cache-memcached-tls`
|
||||||
|
option.
|
||||||
|
|
||||||
TLS SESSION TICKET RESUMPTION
|
TLS SESSION TICKET RESUMPTION
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
@ -1173,6 +1228,10 @@ used, LEN must be 48. If
|
||||||
keys. The key appeared first is used as encryption key. All the
|
keys. The key appeared first is used as encryption key. All the
|
||||||
remaining keys are used as decryption only.
|
remaining keys are used as decryption only.
|
||||||
|
|
||||||
|
By default, connections to memcached server are not encrypted. To
|
||||||
|
enable encryption, use :option:`--tls-ticket-key-memcached-tls`
|
||||||
|
option.
|
||||||
|
|
||||||
If :option:`--tls-ticket-key-file` is given, encryption key is read
|
If :option:`--tls-ticket-key-file` is given, encryption key is read
|
||||||
from the given file. In this case, nghttpx does not rotate key
|
from the given file. In this case, nghttpx does not rotate key
|
||||||
automatically. To rotate key, one has to restart nghttpx (see
|
automatically. To rotate key, one has to restart nghttpx (see
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue