Skip to content

Commit

Permalink
regen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kazuho committed Apr 5, 2021
1 parent 284eb98 commit 85bdbfa
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc/h2o.8
Expand Up @@ -13,7 +13,7 @@ H2O, the optimized HTTP/1.x and HTTP/2 server.
.SH OPTIONS
.TP
.BR \-c ", " \-\-conf =\fIFILE\fR
configuration file (default: /usr/local/h2o-dev/etc/h2o.conf)
configuration file (default: /usr/local/etc/h2o.conf)
.TP
.BR \-m ", " \-\-mode =\fIMODE\fR
specifies one of the following modes:
Expand Down
17 changes: 11 additions & 6 deletions doc/h2o.conf.5
Expand Up @@ -3179,26 +3179,31 @@ The value should be set to something smaller than that being set at the upstream
.RE
.RE

.SS proxy.websocket
A boolean flag (ON or OFF) indicating whether or not to allow upgrading the proxied connection to the WebSocket protocol.
.SS proxy.tunnel
A boolean flag (ON or OFF) indicating whether or not to allow tunnelling to the backend server.

.PP


When set to ON, the proxied connection will be upgraded to a bi-directional tunnel stream if upgrading to WebSocket connection is permitted by the backend server (i.e. if the backend server responds to a WebSocket handshake with 101 status code).
When set to ON, CONNECT requests and WebSocket handshakes are forwarded to the backend server.
Then, if the backend server accepts those requests, H2O forwards the HTTP response to the client and acts as a bi-directional tunnel.


Support for WebSocket is considered experimental for the time being and therefore is not yet turned on by default.
Support for tunnelling is considered experimental for the time being and therefore is not yet turned on by default.


.RE
.RE

.SS proxy.websocket.timeout
Sets idle timeout of a WebSocket connection being proxied.
.SS proxy.tunnel.timeout
Sets the idle timeout of a tunnel.

.PP

.PP
.BR See\ also:
proxy.tunnel

.RE
.RE

Expand Down

0 comments on commit 85bdbfa

Please sign in to comment.