diff options
| author | Loïc Hoguin <[email protected]> | 2018-11-14 12:32:31 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-11-14 12:32:31 +0100 |
| commit | ef05956a5a32d78119d41de663a741104764c8b1 (patch) | |
| tree | 310aae0c2cd32bbaac928b83684fd32d71737fdb /doc/src/manual/cowboy_http2.asciidoc | |
| parent | f9d689f9fd17c2e09b414ac974cc20a57a2256fd (diff) | |
| download | cowboy-ef05956a5a32d78119d41de663a741104764c8b1.tar.gz cowboy-ef05956a5a32d78119d41de663a741104764c8b1.tar.bz2 cowboy-ef05956a5a32d78119d41de663a741104764c8b1.zip | |
Document the proxy_header protocol option
Diffstat (limited to 'doc/src/manual/cowboy_http2.asciidoc')
| -rw-r--r-- | doc/src/manual/cowboy_http2.asciidoc | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_http2.asciidoc b/doc/src/manual/cowboy_http2.asciidoc index ea7110b..014fa9c 100644 --- a/doc/src/manual/cowboy_http2.asciidoc +++ b/doc/src/manual/cowboy_http2.asciidoc @@ -30,6 +30,7 @@ opts() :: #{ max_frame_size_sent => 16384..16777215 | infinity, middlewares => [module()], preface_timeout => timeout(), + proxy_header => boolean(), sendfile => boolean(), settings_timeout => timeout(), shutdown_timeout => timeout(), @@ -120,6 +121,12 @@ preface_timeout (5000):: Time in ms Cowboy is willing to wait for the connection preface. +proxy_header (false):: + +Whether incoming connections have a PROXY protocol header. The +proxy information will be passed forward via the `proxy_header` +key of the Req object. + sendfile (true):: Whether the sendfile syscall may be used. It can be useful to disable |