diff --git a/docs/rolereference.rst b/docs/rolereference.rst index a21b98b6edf52cb8bd66b46e88181ab4d9b111d6..61519d65b941d09cd98a71c1db53f524b579ad73 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -1661,6 +1661,31 @@ Parameters succession, until the first match, or until it runs out of matches, when a client requests an URI pointing to directory. +**http_header_overrides** (dict, optional, ``{}``) + HTTP headers to set/override on the incoming request before passing + it on to the PHP application. Keys are HTTP header names, values are + header values. + + .. note:: + Role takes care of prefixing the headers with ``HTTP_``, + converting them to upper-case, and replacing dashes with + underscores - simply pass in the official HTTP header name, no + extra precautions are required for PHP specifics. + + 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. + **https_tls_certificate** (string, mandatory) X.509 certificate used for TLS for HTTPS service. The file will be stored in directory ``/etc/ssl/certs/`` under name ``{{ fqdn }}_https.pem``.