diff --git a/docs/rolereference.rst b/docs/rolereference.rst index dd96a844ec9f15c710512f2bc2cd460714845d59..c47623001dc4d6cac995935c66b757847d139793 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -239,6 +239,8 @@ The role implements the following: * Configures apt to use caching proxy (if any was specified). * Sets-up umask for all logins to ``0027``. * Installs sudo. +* Sets-up uniform bash prompt for all accounts (optionally coloured and with + identifier). This is useful for distinguishing machines and/or environments. * Installs additional base packages, as configured. * Creates additional operating system groups, as configured. * Creates additional operating system users, as configured. @@ -341,6 +343,22 @@ Parameters higher than ``incoming_connection_limit``), even if it would go above the specified connection limit. +**prompt_colour** (string, optional, ``none``) + Colour for showing the Bash prompt. Supported values are: + + ``black``, ``red``, ``green``, ``brown``, ``blue``, ``purple``, ``cyan``, + ``light_gray``, ``dark_gray``, ``light_red``, ``light_green``, ``yellow``, + ``light_blue``, ``light_purple``, ``light_cyan``, ``white``, ``none``. + + You should probably *not* use the ``black`` colour. Setting affects Bash + shells *only*. Setting the value to ``none`` uses default terminal colour. + +**prompt_id** (string, optional, ``NONE``) + Optional identifier appended to regular Bash prompt, useful for visually + identifying distinct environments. For example, if set to ``test``, resulting + prompt will be similar to ``admin@web[test]:~$``. Setting affects Bash shells + *only*. + Examples ~~~~~~~~ @@ -380,6 +398,10 @@ packages on all servers: incoming_connection_limit_burst: 6 + prompt_colour: light_green + + prompt_id: PROD + .. _ldap_client: LDAP Client