summaryrefslogtreecommitdiffstats
path: root/doc/nghttpx.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 08:52:50 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 08:52:50 +0000
commit9752fb8037bf6856aad9c51a1a7370ffc866f201 (patch)
tree054ae5378aa8919e67fa610a348b5f4e8ef9de3b /doc/nghttpx.1
parentAdding upstream version 1.60.0. (diff)
downloadnghttp2-9752fb8037bf6856aad9c51a1a7370ffc866f201.tar.xz
nghttp2-9752fb8037bf6856aad9c51a1a7370ffc866f201.zip
Adding upstream version 1.61.0.upstream/1.61.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--doc/nghttpx.138
-rw-r--r--doc/nghttpx.1.rst34
2 files changed, 44 insertions, 28 deletions
diff --git a/doc/nghttpx.1 b/doc/nghttpx.1
index ba40059..6b9f54b 100644
--- a/doc/nghttpx.1
+++ b/doc/nghttpx.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "NGHTTPX" "1" "Mar 01, 2024" "1.60.0" "nghttp2"
+.TH "NGHTTPX" "1" "Apr 04, 2024" "1.61.0" "nghttp2"
.SH NAME
nghttpx \- HTTP/2 proxy
.SH SYNOPSIS
@@ -555,27 +555,24 @@ this option will be simply ignored.
.SS Timeout
.INDENT 0.0
.TP
-.B \-\-frontend\-http2\-read\-timeout=<DURATION>
-Specify read timeout for HTTP/2 frontend connection.
+.B \-\-frontend\-http2\-idle\-timeout=<DURATION>
+Specify idle timeout for HTTP/2 frontend connection. If
+no active streams exist for this duration, connection is
+closed.
.sp
Default: \fB3m\fP
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-frontend\-http3\-read\-timeout=<DURATION>
-Specify read timeout for HTTP/3 frontend connection.
+.B \-\-frontend\-http3\-idle\-timeout=<DURATION>
+Specify idle timeout for HTTP/3 frontend connection. If
+no active streams exist for this duration, connection is
+closed.
.sp
Default: \fB3m\fP
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-frontend\-read\-timeout=<DURATION>
-Specify read timeout for HTTP/1.1 frontend connection.
-.sp
-Default: \fB1m\fP
-.UNINDENT
-.INDENT 0.0
-.TP
.B \-\-frontend\-write\-timeout=<DURATION>
Specify write timeout for all frontend connections.
.sp
@@ -591,6 +588,17 @@ Default: \fB1m\fP
.UNINDENT
.INDENT 0.0
.TP
+.B \-\-frontend\-header\-timeout=<DURATION>
+Specify duration that the server waits for an HTTP
+request header fields to be received completely. On
+timeout, HTTP/1 and HTTP/2 connections are closed. For
+HTTP/3, the stream is shutdown, and the connection
+itself is left intact.
+.sp
+Default: \fB1m\fP
+.UNINDENT
+.INDENT 0.0
+.TP
.B \-\-stream\-read\-timeout=<DURATION>
Specify read timeout for HTTP/2 streams. 0 means no
timeout.
@@ -1846,12 +1854,12 @@ as QUIC keying materials. It is used to derive keys for
encrypting tokens and Connection IDs. It is not used to
encrypt QUIC packets. Each line of this file must
contain exactly 136 bytes hex\-encoded string (when
-decoded the byte string is 68 bytes long). The first 2
+decoded the byte string is 68 bytes long). The first 3
bits of decoded byte string are used to identify the
keying material. An empty line or a line which starts
\(aq#\(aq is ignored. The file can contain more than one
-keying materials. Because the identifier is 2 bits, at
-most 4 keying materials are read and the remaining data
+keying materials. Because the identifier is 3 bits, at
+most 8 keying materials are read and the remaining data
is discarded. The first keying material in the file is
primarily used for encryption and decryption for new
connection. The other ones are used to decrypt data for
diff --git a/doc/nghttpx.1.rst b/doc/nghttpx.1.rst
index 03109e4..cee23f2 100644
--- a/doc/nghttpx.1.rst
+++ b/doc/nghttpx.1.rst
@@ -522,24 +522,22 @@ Performance
Timeout
~~~~~~~
-.. option:: --frontend-http2-read-timeout=<DURATION>
+.. option:: --frontend-http2-idle-timeout=<DURATION>
- Specify read timeout for HTTP/2 frontend connection.
+ Specify idle timeout for HTTP/2 frontend connection. If
+ no active streams exist for this duration, connection is
+ closed.
Default: ``3m``
-.. option:: --frontend-http3-read-timeout=<DURATION>
+.. option:: --frontend-http3-idle-timeout=<DURATION>
- Specify read timeout for HTTP/3 frontend connection.
+ Specify idle timeout for HTTP/3 frontend connection. If
+ no active streams exist for this duration, connection is
+ closed.
Default: ``3m``
-.. option:: --frontend-read-timeout=<DURATION>
-
- Specify read timeout for HTTP/1.1 frontend connection.
-
- Default: ``1m``
-
.. option:: --frontend-write-timeout=<DURATION>
Specify write timeout for all frontend connections.
@@ -553,6 +551,16 @@ Timeout
Default: ``1m``
+.. option:: --frontend-header-timeout=<DURATION>
+
+ Specify duration that the server waits for an HTTP
+ request header fields to be received completely. On
+ timeout, HTTP/1 and HTTP/2 connections are closed. For
+ HTTP/3, the stream is shutdown, and the connection
+ itself is left intact.
+
+ Default: ``1m``
+
.. option:: --stream-read-timeout=<DURATION>
Specify read timeout for HTTP/2 streams. 0 means no
@@ -1686,12 +1694,12 @@ HTTP/3 and QUIC
encrypting tokens and Connection IDs. It is not used to
encrypt QUIC packets. Each line of this file must
contain exactly 136 bytes hex-encoded string (when
- decoded the byte string is 68 bytes long). The first 2
+ decoded the byte string is 68 bytes long). The first 3
bits of decoded byte string are used to identify the
keying material. An empty line or a line which starts
'#' is ignored. The file can contain more than one
- keying materials. Because the identifier is 2 bits, at
- most 4 keying materials are read and the remaining data
+ keying materials. Because the identifier is 3 bits, at
+ most 8 keying materials are read and the remaining data
is discarded. The first keying material in the file is
primarily used for encryption and decryption for new
connection. The other ones are used to decrypt data for