diff --git a/docs/rolereference.rst b/docs/rolereference.rst index 61519d65b941d09cd98a71c1db53f524b579ad73..a77cdc1a8e526e3c29f82e4e36a5d6a44322db85 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -1937,12 +1937,24 @@ Parameters website. This is usually going to be development libraries for building Python packages. -**proxy_headers** (dictionary, optional, ``{}``) - Additional headers to set when proxying request to Gunicorn. Keys are header - names, values are header values. Both should be compatible with Nginx - ``proxy_set_header``. If you need to provide an empty value, use quotes (don't - forget to surround them by another set of quotes for YAML syntax, for example - ``"\"\""`` or ``'""'``). +**http_header_overrides** (dict, optional, ``{}``) + HTTP headers to set/override on the incoming request before passing + it on to the WSGI application. Keys are HTTP header names, values are + header values. + + Double quotes in the value must be escaped with a backslash. Make + sure to take into account the YAML escaping as well. For example, to + set the value to ``this is quote - "``, YAML should look like one of + the following: + + - ``this is double quote - "`` + - ``'this is double quote - \"'`` + - ``"this is double quote - \\\"'`` + + To clear a header value, simply set its value to an empty + string. Nginx variables can be used as well, however keep in mind + that the dollar sign (``$``) *cannot* be used/escaped due to Nginx + configuration file syntax limitations. **rewrites** (list, optional, ``[]``) A list of rewrite rules that are applied to incoming requests. Each element of @@ -2056,8 +2068,8 @@ running a bare Django project): background_colour: "green" text_colour: "black" text: "TEST ENVIRONMENT" - proxy_headers: - Accept-Encoding: '""' + http_header_overrides: + Accept-Encoding: "" # Use wsgi_requirements to deploy Gunicorn. - role: wsgi_website