From ef05956a5a32d78119d41de663a741104764c8b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 14 Nov 2018 12:32:31 +0100 Subject: Document the proxy_header protocol option --- doc/src/manual/cowboy_http2.asciidoc | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/src/manual/cowboy_http2.asciidoc') 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 -- cgit v1.2.3