4.4. Consent for using Cookies#
Both the UCS Portal and the Univention Management Console (UMC) use cookies and store them on the user’s computer. Depending on your use case and the public presence of your UCS Portal, you may have to inform the user about the use of cookies.
When enabled, both the UCS Portal and the UMC show a cookie consent banner that the user must accept to continue. You can configure the content using Univention Configuration Registry Variables.
4.4.1. Usage of the cookie consent banner#
To enable and customize the content of the cookie consent banner, use the following steps:
To enable the cookie consent banner, set the UCR variable
umc/cookie-banner/show
totrue
. The banner then shows the default content.To customize the title and the text, set the UCR variables
umc/cookie-banner/title
andumc/cookie-banner/text
to your liking.Note that both settings allow a language-specific configuration. For more information, see the section UCR reference for cookie consent banner.
You can also optionally set the following variables:
The name of the cookie as UCS stores it on the user’s system with
umc/cookie-banner/cookie
.The domains for which UCS shows the cookie consent banner with
umc/cookie-banner/domains
.
Setting the appropriate UCR variables is sufficient to enable and customize the cookie consent banner.
To restore the default texts, unset the
umc/cookie-banner/title
and
umc/cookie-banner/text
UCR variables.
To turn off the cookie banner completely,
set umc/cookie-banner/show
to false
.
4.4.2. UCR reference for cookie consent banner#
Use the following UCR variables to configure the cookie banner dialog.
- umc/cookie-banner/cookie#
The variable sets the name of the cookie. In the default setting, the value is empty. UCS then uses the name
univentionCookieSettingsAccepted
for the cookie.
- umc/cookie-banner/domains#
Optional setting for the domains for which the cookie consent banner dialog is active. The value is a comma-separated list of domain names, for which UCS shows the cookie consent banner. For an empty list, UCS shows the banner for all domain names. The domain matches from the end of the string.
Examples:
The value
example.com
matchesportal.example.com
andsso.example com
. UCS shows the banner for both domain names.For the value
portal.example.com
UCS doesn’t show the cookie consent banner forsso.example.com
, but forportal.example.com
.
- umc/cookie-banner/show#
The variable controls, if the browser shows the cookie consent banner. The default value is
false
. To show the cookie consent banner, set the variable totrue
.
- umc/cookie-banner/title#
Sets the title for the consent banner dialog. In the default setting, the value is empty and UCS provides a default title for English and German. Use
umc/cookie-banner/title/LANGUAGE
with a two letter language code from ISO 639-1 forLANGUAGE
to set titles for different languages.
- umc/cookie-banner/text#
Sets the text for the cookie consent banner dialog. In the default setting, the value is empty and UCS provides a default text for English and German. Use
umc/cookie-banner/text/LANGUAGE
with a two letter language code from ISO 639-1 forLANGUAGE
to set text content for different languages.