walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2017-02-20 00:16:44 +09:00
parent 102b98813f
commit 12f9b09845
5 changed files with 124 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "Feb 14, 2017" "1.20.0-DEV" "nghttp2" .TH "H2LOAD" "1" "Feb 20, 2017" "1.20.0-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "Feb 14, 2017" "1.20.0-DEV" "nghttp2" .TH "NGHTTP" "1" "Feb 20, 2017" "1.20.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

2
doc/nghttpd.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "Feb 14, 2017" "1.20.0-DEV" "nghttp2" .TH "NGHTTPD" "1" "Feb 20, 2017" "1.20.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

92
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "Feb 14, 2017" "1.20.0-DEV" "nghttp2" .TH "NGHTTPX" "1" "Feb 20, 2017" "1.20.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -121,12 +121,12 @@ Several parameters <PARAM> are accepted after <PATTERN>.
The parameters are delimited by ";". The available The parameters are delimited by ";". The available
parameters are: "proto=<PROTO>", "tls", parameters are: "proto=<PROTO>", "tls",
"sni=<SNI_HOST>", "fall=<N>", "rise=<N>", "sni=<SNI_HOST>", "fall=<N>", "rise=<N>",
"affinity=<METHOD>", "dns", and "frontend\-tls". The "affinity=<METHOD>", "dns", and "redirect\-if\-not\-tls".
parameter consists of keyword, and optionally followed The parameter consists of keyword, and optionally
by "=" and value. For example, the parameter "proto=h2" followed by "=" and value. For example, the parameter
consists of the keyword "proto" and value "h2". The "proto=h2" consists of the keyword "proto" and value
parameter "tls" consists of the keyword "tls" without "h2". The parameter "tls" consists of the keyword "tls"
value. Each parameter is described as follows. without value. Each parameter is described as follows.
.sp .sp
The backend application protocol can be specified using The backend application protocol can be specified using
optional "proto" parameter, and in the form of optional "proto" parameter, and in the form of
@ -183,16 +183,18 @@ frequently. If "dns" is given, name resolution of
backend host name at start up, or reloading backend host name at start up, or reloading
configuration is skipped. configuration is skipped.
.sp .sp
If "frontend\-tls" parameter is used, the matched backend If "redirect\-if\-not\-tls" parameter is used, the matched
requires frontend TLS connection. In other words, even backend requires that frontend connection is TLS
if pattern is matched, frontend connection is not TLS encrypted. If it isn\(aqt, nghttpx responds to the request
protected, the request is forwarded to one of catch\-all with 308 status code, and https URI the client should
backends. For this reason, catch\-all backend cannot use instead is included in Location header field. The
have "frontend\-tls" parameter. If at least one backend port number in redirect URI is 443 by default, and can
has "frontend\-tls" parameter, this feature is enabled be changed using \fI\%\-\-redirect\-https\-port\fP option. If at
for all backend servers sharing the same <PATTERN>. It least one backend has "redirect\-if\-not\-tls" parameter,
is advised to set "frontend\-tls" parameter to all this feature is enabled for all backend servers sharing
backends explicitly if this feature is desired. the same <PATTERN>. It is advised to set
"redirect\-if\-no\-tls" parameter to all backends
explicitly if this feature is desired.
.sp .sp
Since ";" and ":" are used as delimiter, <PATTERN> must Since ";" and ":" are used as delimiter, <PATTERN> must
not contain these characters. Since ";" has special not contain these characters. Since ";" has special
@ -654,26 +656,26 @@ backend client authentication.
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-tls\-min\-proto\-version=<VER> .B \-\-tls\-min\-proto\-version=<VER>
Specify minimum SSL/TLS protocol. The following Specify minimum SSL/TLS protocol. The name matching is
protocols are available: TLSv1.2, TLSv1.1 and TLSv1.0. done in case\-insensitive manner. The versions between
The name matching is done in case\-insensitive manner. \fI\%\-\-tls\-min\-proto\-version\fP and \fI\%\-\-tls\-max\-proto\-version\fP are
The versions between \fI\%\-\-tls\-min\-proto\-version\fP and enabled. If the protocol list advertised by client does
\fI\%\-\-tls\-max\-proto\-version\fP are enabled. If the protocol not overlap this range, you will receive the error
list advertised by client does not overlap this range, message "unknown protocol". The available versions are:
you will receive the error message "unknown protocol". TLSv1.2, TLSv1.1, and TLSv1.0
.sp .sp
Default: \fBTLSv1.1\fP Default: \fBTLSv1.1\fP
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-tls\-max\-proto\-version=<VER> .B \-\-tls\-max\-proto\-version=<VER>
Specify maximum SSL/TLS protocol. The following Specify maximum SSL/TLS protocol. The name matching is
protocols are available: TLSv1.2, TLSv1.1 and TLSv1.0. done in case\-insensitive manner. The versions between
The name matching is done in case\-insensitive manner. \fI\%\-\-tls\-min\-proto\-version\fP and \fI\%\-\-tls\-max\-proto\-version\fP are
The versions between \fI\%\-\-tls\-min\-proto\-version\fP and enabled. If the protocol list advertised by client does
\fI\%\-\-tls\-max\-proto\-version\fP are enabled. If the protocol not overlap this range, you will receive the error
list advertised by client does not overlap this range, message "unknown protocol". The available versions are:
you will receive the error message "unknown protocol". TLSv1.2, TLSv1.1, and TLSv1.0
.sp .sp
Default: \fBTLSv1.2\fP Default: \fBTLSv1.2\fP
.UNINDENT .UNINDENT
@ -1349,6 +1351,15 @@ Don\(aqt rewrite server header field in default mode. When
\fI\%\-\-http2\-proxy\fP is used, these headers will not be altered \fI\%\-\-http2\-proxy\fP is used, these headers will not be altered
regardless of this option. regardless of this option.
.UNINDENT .UNINDENT
.INDENT 0.0
.TP
.B \-\-redirect\-https\-port=<PORT>
Specify the port number which appears in Location header
field when redirect to HTTPS URI is made due to
"redirect\-if\-not\-tls" parameter in \fI\%\-\-backend\fP option.
.sp
Default: \fB443\fP
.UNINDENT
.SS API .SS API
.INDENT 0.0 .INDENT 0.0
.TP .TP
@ -2090,6 +2101,9 @@ The request was failed. No change has been made.
HTTP status code HTTP status code
.UNINDENT .UNINDENT
.sp .sp
Additionally, depending on the API endpoint, \fBdata\fP key may be
present, and its value contains the API endpoint specific data.
.sp
We wrote "normally", since nghttpx may return ordinal HTML response in We wrote "normally", since nghttpx may return ordinal HTML response in
some cases where the error has occurred before reaching API endpoint some cases where the error has occurred before reaching API endpoint
(e.g., header field is too large). (e.g., header field is too large).
@ -2117,6 +2131,22 @@ The one limitation is that only numeric IP address is allowd in
\fI\%backend\fP in request body unless "dns" parameter \fI\%backend\fP in request body unless "dns" parameter
is used while non numeric hostname is allowed in command\-line or is used while non numeric hostname is allowed in command\-line or
configuration file is read using \fI\%\-\-conf\fP\&. configuration file is read using \fI\%\-\-conf\fP\&.
.SS GET /api/v1beta1/configrevision
.sp
This API returns configuration revision of the current nghttpx. The
configuration revision is opaque string, and it changes after each
reloading by SIGHUP. With this API, an external application knows
that whether nghttpx has finished reloading its configuration by
comparing the configuration revisions between before and after
reloading.
.sp
This API returns response including \fBdata\fP key. Its value is JSON
object, and it contains at least the following key:
.INDENT 0.0
.TP
.B configRevision
The configuration revision of the current nghttpx
.UNINDENT
.SH SEE ALSO .SH SEE ALSO
.sp .sp
\fBnghttp(1)\fP, \fBnghttpd(1)\fP, \fBh2load(1)\fP \fBnghttp(1)\fP, \fBnghttpd(1)\fP, \fBh2load(1)\fP

90
doc/nghttpx.1.rst
View File

@ -105,12 +105,12 @@ Connections
The parameters are delimited by ";". The available The parameters are delimited by ";". The available
parameters are: "proto=<PROTO>", "tls", parameters are: "proto=<PROTO>", "tls",
"sni=<SNI_HOST>", "fall=<N>", "rise=<N>", "sni=<SNI_HOST>", "fall=<N>", "rise=<N>",
"affinity=<METHOD>", "dns", and "frontend-tls". The "affinity=<METHOD>", "dns", and "redirect-if-not-tls".
parameter consists of keyword, and optionally followed The parameter consists of keyword, and optionally
by "=" and value. For example, the parameter "proto=h2" followed by "=" and value. For example, the parameter
consists of the keyword "proto" and value "h2". The "proto=h2" consists of the keyword "proto" and value
parameter "tls" consists of the keyword "tls" without "h2". The parameter "tls" consists of the keyword "tls"
value. Each parameter is described as follows. without value. Each parameter is described as follows.
The backend application protocol can be specified using The backend application protocol can be specified using
optional "proto" parameter, and in the form of optional "proto" parameter, and in the form of
@ -167,16 +167,18 @@ Connections
backend host name at start up, or reloading backend host name at start up, or reloading
configuration is skipped. configuration is skipped.
If "frontend-tls" parameter is used, the matched backend If "redirect-if-not-tls" parameter is used, the matched
requires frontend TLS connection. In other words, even backend requires that frontend connection is TLS
if pattern is matched, frontend connection is not TLS encrypted. If it isn't, nghttpx responds to the request
protected, the request is forwarded to one of catch-all with 308 status code, and https URI the client should
backends. For this reason, catch-all backend cannot use instead is included in Location header field. The
have "frontend-tls" parameter. If at least one backend port number in redirect URI is 443 by default, and can
has "frontend-tls" parameter, this feature is enabled be changed using :option:`--redirect-https-port` option. If at
for all backend servers sharing the same <PATTERN>. It least one backend has "redirect-if-not-tls" parameter,
is advised to set "frontend-tls" parameter to all this feature is enabled for all backend servers sharing
backends explicitly if this feature is desired. the same <PATTERN>. It is advised to set
"redirect-if-no-tls" parameter to all backends
explicitly if this feature is desired.
Since ";" and ":" are used as delimiter, <PATTERN> must Since ";" and ":" are used as delimiter, <PATTERN> must
not contain these characters. Since ";" has special not contain these characters. Since ";" has special
@ -600,25 +602,25 @@ SSL/TLS
.. option:: --tls-min-proto-version=<VER> .. option:: --tls-min-proto-version=<VER>
Specify minimum SSL/TLS protocol. The following Specify minimum SSL/TLS protocol. The name matching is
protocols are available: TLSv1.2, TLSv1.1 and TLSv1.0. done in case-insensitive manner. The versions between
The name matching is done in case-insensitive manner. :option:`--tls-min-proto-version` and :option:`\--tls-max-proto-version` are
The versions between :option:`--tls-min-proto-version` and enabled. If the protocol list advertised by client does
:option:`--tls-max-proto-version` are enabled. If the protocol not overlap this range, you will receive the error
list advertised by client does not overlap this range, message "unknown protocol". The available versions are:
you will receive the error message "unknown protocol". TLSv1.2, TLSv1.1, and TLSv1.0
Default: ``TLSv1.1`` Default: ``TLSv1.1``
.. option:: --tls-max-proto-version=<VER> .. option:: --tls-max-proto-version=<VER>
Specify maximum SSL/TLS protocol. The following Specify maximum SSL/TLS protocol. The name matching is
protocols are available: TLSv1.2, TLSv1.1 and TLSv1.0. done in case-insensitive manner. The versions between
The name matching is done in case-insensitive manner. :option:`--tls-min-proto-version` and :option:`\--tls-max-proto-version` are
The versions between :option:`--tls-min-proto-version` and enabled. If the protocol list advertised by client does
:option:`--tls-max-proto-version` are enabled. If the protocol not overlap this range, you will receive the error
list advertised by client does not overlap this range, message "unknown protocol". The available versions are:
you will receive the error message "unknown protocol". TLSv1.2, TLSv1.1, and TLSv1.0
Default: ``TLSv1.2`` Default: ``TLSv1.2``
@ -1222,6 +1224,14 @@ HTTP
:option:`--http2-proxy` is used, these headers will not be altered :option:`--http2-proxy` is used, these headers will not be altered
regardless of this option. regardless of this option.
.. option:: --redirect-https-port=<PORT>
Specify the port number which appears in Location header
field when redirect to HTTPS URI is made due to
"redirect-if-not-tls" parameter in :option:`--backend` option.
Default: ``443``
API API
~~~ ~~~
@ -1907,6 +1917,9 @@ status
code code
HTTP status code HTTP status code
Additionally, depending on the API endpoint, ``data`` key may be
present, and its value contains the API endpoint specific data.
We wrote "normally", since nghttpx may return ordinal HTML response in We wrote "normally", since nghttpx may return ordinal HTML response in
some cases where the error has occurred before reaching API endpoint some cases where the error has occurred before reaching API endpoint
(e.g., header field is too large). (e.g., header field is too large).
@ -1938,6 +1951,23 @@ The one limitation is that only numeric IP address is allowd in
is used while non numeric hostname is allowed in command-line or is used while non numeric hostname is allowed in command-line or
configuration file is read using :option:`--conf`. configuration file is read using :option:`--conf`.
GET /api/v1beta1/configrevision
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This API returns configuration revision of the current nghttpx. The
configuration revision is opaque string, and it changes after each
reloading by SIGHUP. With this API, an external application knows
that whether nghttpx has finished reloading its configuration by
comparing the configuration revisions between before and after
reloading.
This API returns response including ``data`` key. Its value is JSON
object, and it contains at least the following key:
configRevision
The configuration revision of the current nghttpx
SEE ALSO SEE ALSO
-------- --------