diff --git a/docs/rolereference.rst b/docs/rolereference.rst index 95f17efbe44fc45134adca31e59c774c324dc26c..4230cb8c0f9db3bdbab8d128761a3a594563278d 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -1448,6 +1448,28 @@ Parameters Private key used for TLS for HTTPS service. The file will be stored in directory ``/etc/ssl/private/`` under name ``{{ ansible_fqdn }}_https.key``. +**environment_indicator** (dictionary, optional, ``null``) + Specify configuration for including environment indicator on all HTML + pages. Indicator is a simple strip at bottom of a page with custom background + colour, text colour, and text. + + Specifying environment indicator is useful for avoiding mistakes when testing + by having better visibility what environment you are in + (production/staging/test). + + The following keys need to be specified: + + **background_colour** (string, mandatory) + Background colour to use for the strip at bottom. This should be value + compatible with CSS ``background-color`` attribute. + + **text_colour** (string, mandatory) + Text colour to use for the strip at bottom. This should be value compatible + with CSS ``color`` attribute. + + **text** (string, mandatory) + Text to show in show in the strip at bottom. + **web_default_title** (string, optional, ``Welcome``) Title for the default web page shown to users (if no other vhosts were matched). @@ -1605,7 +1627,7 @@ Parameters Background colour to use for the strip at bottom. This should be value compatible with CSS ``background-color`` attribute. - **text_colour** (string, mandatory + **text_colour** (string, mandatory) Text colour to use for the strip at bottom. This should be value compatible with CSS ``color`` attribute. @@ -1842,7 +1864,7 @@ Parameters Background colour to use for the strip at bottom. This should be value compatible with CSS ``background-color`` attribute. - **text_colour** (string, mandatory + **text_colour** (string, mandatory) Text colour to use for the strip at bottom. This should be value compatible with CSS ``color`` attribute.