Skip to main content

Legal Notices and Configurable Links

OLIVE shows legal links in two places that end users actually see — the login page and the application — and both are configurable. Who has to publish what behind those links depends on who operates the installation, and that is the distinction this page exists to make.

Whose notices apply​

SurfaceWho operates itWhose Impressum and privacy notice belongs there
This documentation siteBOC Products & Services AGBOC's — see Legal. These cover the documentation itself
An OLIVE installation operated by BOCBOCBOC's, which is the default the charts ship
An OLIVE installation you operateYouYours. You are the controller for the data your tenants process, so the notices behind these links must be yours
The defaults are BOC's notices, and they are wrong for a customer-operated installation

global.keycloakLegal defaults to BOC's URLs, because that is correct for the installations BOC operates. On an installation you run, leaving the default means your users are shown someone else's Impressum and privacy notice on the page where they sign in and hand over credentials.

Replace them as part of the deployment, not afterwards.

The two configuration points​

The two surfaces are configured separately, in different charts, and both have to be set — a user who signs in and then opens the application passes through both.

1. The login page (Keycloak)​

The keycloak-infra chart mounts an olive login theme that inherits keycloak.v2 and adds an Impressum and privacy footer:

global:
keycloakLegal:
enabled: true
impressumUrl: 'https://example.com/impressum'
privacyUrl: 'https://example.com/privacy'

Both must be public HTTPS links — the login page is reached before authentication, so a link behind a login is not reachable from it.

The theme restarts Keycloak when these change

The theme mount carries a checksum annotation, and that checksum is what rolls Keycloak when the theme content or the links change. If you override keycloakx.extraVolumes, extraVolumeMounts or podAnnotations, preserve the mount and the annotation, or a link change will not take effect. Before disabling the theme entirely, select another installed theme on every realm using it. See Infrastructure Prerequisites → The OLIVE login theme.

2. The application (the editor)​

The editor reads its own two environment variables, and they are not derived from the Keycloak values:

editor:
express:
env:
LEGAL_IMPRESSUM_URL: 'https://example.com/impressum'
LEGAL_PRIVACY_URL: 'https://example.com/privacy'

Set them to the same URLs as the Keycloak values. Setting one pair and not the other produces an installation whose login page and whose application disagree about who operates it — which is the state most likely to be noticed by the wrong person.

Because these are injected as environment variables, they are read at pod start: changing them needs a restart of the editor, and nothing restarts it for you.

Before you enable either​

Publish the notices first. Both values point at pages you host. Enabling the links before the pages exist gives users a footer that 404s on the sign-in screen, which is worse than no footer.

What those notices have to say is a question for whoever owns data protection in your organisation, not for OLIVE. What this manual can tell you is what the platform does with personal data, which is the input they will ask for:

  • The security log stream deliberately records the source IP address, user name and tenant of each security event. It is personal data, and it is there so that an event can say who did something from where. See Security Logging.
  • Retention and access for that stream are yours to set, per stream, in your log platform. OLIVE prescribes no period.
  • The tenant ID is mandatory metadata on every log record, which is what makes a data subject request answerable per tenant.
  • Credentials, tokens, secrets and request or response bodies are never logged.

Checklist​

  • The Impressum and privacy notices are published, at public HTTPS URLs
  • global.keycloakLegal.impressumUrl and privacyUrl point at them
  • editor.express.env.LEGAL_IMPRESSUM_URL and LEGAL_PRIVACY_URL point at the same two URLs
  • The login page footer resolves — checked in a browser, signed out
  • The application footer resolves — checked signed in
  • Log retention per stream is decided, recorded, and configured in the log platform