diff --git a/docs/rolereference.rst b/docs/rolereference.rst index d869acac5d554a0113b00fd6427109cda7b3efc2..83ec8f7eda2450471e27cb0136d4bc979268fdd2 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -1288,6 +1288,28 @@ Parameters be served with ``Strict-Transport-Security`` header with value of ``max-age=31536000; includeSubDomains``. +**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. + **fqdn** (string, mandatory) Fully-qualified domain name where the website is reachable. This value is used for calculating the user/group name for dedicated website user, as well as @@ -1376,6 +1398,10 @@ running *ownCloud* and *The Bug Genie* applications): additional_fpm_config: "env[PATH]": "\"/usr/local/bin:/usr/bin:/bin\"" website_mail_recipients: "root john.doe@example.com" + environment_indicator: + background_colour: "green" + text_colour: "black" + text: "TEST ENVIRONMENT" - role: php_website deny_files_regex: - ^\..* @@ -1491,6 +1517,28 @@ Parameters be served with ``Strict-Transport-Security`` header with value of ``max-age=31536000; includeSubDomains``. +**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. + **environment_variables** (dict, optional, ``{}``) Specify additional environment variables that should be set for running the service. Environment variables will be set in both the systemd service and for @@ -1589,6 +1637,10 @@ running a bare Django project): - comment: Use custom page for non-existing locations/files. value: error_page 404 /static/404.html; website_mail_recipients: "root john.doe@example.com" + environment_indicator: + background_colour: "green" + text_colour: "black" + text: "TEST ENVIRONMENT" Database Server