User interface configuration options
Privacy page and Terms of Use
The UI can be configured to show a Privacy Policy and Terms of Use. These are displayed under the Help section of the UI.
For each of these, the content is read from a ConfigMap
. You need to configure
the values in ui.client.privacy.page
to enable the feature and set the reference
ConfigMap name and key. If ui.client.privacy.page.enabled
is true
, then the privacy
policy and terms of use will be shown in the UI, with content taken from the ConfigMap
specified by ui.client.privacy.page.configMapName
at the key
ui.client.privacy.page.configMapPolicyKey
for the privacy policy and
ui.client.privacy.page.configMapTermsKey
for the terms of use.
Note
If you don’t set the ConfigMap name and key, a sample will be used instead. You can start from it as a template to create your customized ConfigMap.
The Markdown syntax is fully supported for the privacy page content.
Dashboard message
The UI can display a configurable message for logged in users on their dashboard page, suited for showing general information about Renku.
This feature can be enabled and configured by editing the values found in
ui.client.dashboardMessage
. Set ui.client.dashboardMessage.enabled
to true
to have the message displayed on the dashboard page.
The content and appearance of the message are configured by editing the other
values in ui.client.dashboardMessage
:
text
: the main message displayed on the dashboard page. It supports Markdown syntax.additionalText
: the additional message which users can read by clicking “Read more” button right below the main message.style
: the appearance of the card used to display the dashboard message. Allowed values are: “plain”, “success”, “info”, “warning” and “danger”.dismissible
: if it is set totrue
, users can dismiss the message and hide it until the tab is closed or refreshed.
An example configuration can be found in values.yaml in the renku-ui repository.