Optional Configuration

Monitoring

MACMA logs on std:out. Monitoring solutions as e.g. the ELK stack can be attached.

SMTP

Via the Keycloak Admin UI it is possible to configure an SMTP server. Login to Keycloak Admin UI and configure for the particular tenant the SMTP setup via Realm Settings → Email.

Keycloak guide: https://www.keycloak.org/docs/latest/server_admin/#_email

Internationalization

It is possible to configure internationalization for the Keycloak identity provider via the Keycloak admin UI: switch on the Theme tab you can choose which locales you want to support and what the default locale will be. By default, the browser language is used.

Keycloak guide: https://www.keycloak.org/docs/latest/server_admin/#_themes

Footer Configuration

For customer hosted environments the footer is in the responsibility of the customer. The current default configuration does not offer any legal guidance. The default configuration is an example to explain how the configuration works. These links can be configured using environment variables.

Links

The links are indexed starting with 0. Up to 10 links can be defined. Two environment variables, one for the title and one for the URL, are required to define a link.

MACMA_FOOTER_LINKS_<index>_TITLE MACMA_FOOTER_LINKS_<index>_URL

Example 1. Example for the links

MACMA_FOOTER_LINKS_0_TITLE=First Label MACMA_FOOTER_LINKS_0_URL=https://example.com

MACMA_FOOTER_LINKS_1_TITLE=Second Label MACMA_FOOTER_LINKS_1_URL=/example.html

Further environment variables can be defined to localize the links. The localizations are indexed starting with 0. For every link up to 10 localizations can be defined. The language of each localization must be defined, the title and URL are optional. Therefore, it is possible as well to only localize the title or the URL.

Example 2. Example for the first localization for the first link

MACMA_FOOTER_LINKS_0_LOCALIZATIONS_0_LANGUAGE=de MACMA_FOOTER_LINKS_0_LOCALIZATIONS_0_TITLE=Erste Beschriftung MACMA_FOOTER_LINKS_0_LOCALIZATIONS_0_URL=https://example.de

Copyright

The footer shows a copyright statement. This copyright statement can be configured by environment variables as well.

Example 3. Copyright text configuration

Localization is possible as well for example in German:

Example 4. Copyright text localization

The localizations are indexed starting by 0.

Cookie Banner / Privacy Settings

For customer hosted environments the cookie banner / privacy settings are in the responsibility of the customer. The current default configuration does not offer any legal guidance. The default configuration is an example to explain how the configuration works. These links can be configured using environment variables. For Docker Compose based deployment, the env-file application-macma-footer-config.env is offered to configure the cookie banner / privacy settings in addition to the footer.

To enable, set the environment variable MACMA_FOOTER_SHOWPRIVACYSETTINGS to true. Note, that the footer must be enabled for the privacy settings to be accessible. To enable the marketing consent option in the MACMA cookie banner, the environment variable NEXEED_MACMA_FOOTER_PRIVACYSETTINGS_ENABLEMARKETINGCONSENT can be set to true.

Footer link text

The footer shows a copyright statement. This copyright statement can be configured by environment variables as well.

Example 5. Copyright text configuration

MACMA_FOOTER_PRIVACYSETTINGSTEXT=Privacy settings

Localization is possible as well for example in German:

MACMA_FOOTER_LOCALIZATIONS_0_LANGUAGE=de MACMA_FOOTER_LOCALIZATIONS_0_PRIVACYSETTINGSTEXT=Privatsphäreeinstellungen

The localizations are indexed starting by 0.

The contents of the cookie banner and privacy settings can be configured as well. The following options are available:

Example 6. Example for the links

MACMA_FOOTER_PRIVACYSETTINGS_COMFORTCOOKIELINK=page1.html MACMA_FOOTER_PRIVACYSETTINGS_MARKETINGCOOKIELINK=/page2.html MACMA_FOOTER_PRIVACYSETTINGS_DATAPROTECTIONINFOLINK=page3.html MACMA_FOOTER_PRIVACYSETTINGS_CORPORATEINFORMATIONLINK=/page4.html

These links can be relative or absolute and may contain complete URLs like https://bosch.com as well.

Further environment variables can be defined for localization. The localizations are indexed starting with 0. Up to 10 localizations can be defined. The language of each localization must be defined, the specific properties are optional. Therefore, it is possible as well to only localize specific properties like a single link.

Example 7. Example for the first localization for the first link

MACMA_FOOTER_PRIVACYSETTINGS_LOCALIZATIONS_0_LANGUAGE=de MACMA_FOOTER_PRIVACYSETTINGS_LOCALIZATIONS_0_COMFORTCOOKIELINK=page1-de.html MACMA_FOOTER_PRIVACYSETTINGS_LOCALIZATIONS_0_MARKETINGCOOKIELINK=/page2-de.html

Again, these links can be relative or absolute and may contain complete URLs like https://bosch.com as well.