Logo
0.17.0
  • About Renku
  • Tutorials
  • How-to Guides
    • General
    • RenkuLab
    • Renku on your Own Machine
    • Contributing to Renku
    • Guides for Administrators
      • Deploy Renku
      • Enable notebooks for anonymous users
      • Run the platform
      • Configure privacy page and cookie banner
        • Privacy page
        • Cookie banner
      • Troubleshoot a Renku deployment
  • Topic guides
  • Reference
  • Get in touch
  • Release Notes
  • License
Renku
Join us on GitHub
  • »
  • How-to guides »
  • Guides for Administrators »
  • Deploy Renku »
  • Configure privacy page and cookie banner
  • Edit on GitHub

Configure privacy page and cookie banner¶

Privacy page¶

The UI has a privacy page with a completely configurable content, suited for showing any policy/terms related information, like the Privacy Policy Statement or the Terms of Use.

The content is read from a ConfigMap. You need to configure the values in ui.privacy.page to enable the feature and set the reference ConfigMap name and key. Both ui.privacy.enabled and ui.privacy.page.enabled need to be true for enabling the privacy page.

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.

Cookie banner¶

Since RenkuLab requires user identification and implements a login system, cookies are required at all levels to provide basic functionality. Please mind that cookies are also used for anonymous users (i.e. without an account or not currently logged in). To comply with international laws, it’s strongly advised to explicitly require consent to the user for storing these data and using cookies.

To activate this feature, please set ui.privacy.enabled: true. We have already configured a default cookie banner to inform the users about the aforementioned requirements and points to point them to the privacy page for further details.

It’s possible to customize the banner to your own needs, changing both the appearance and the content. We use cookie consent to create the banner and we support customization of all the properties exposed by the library. All the adjustments should be provided as values in ui.privacy.banner as follows:

  1. content: The HTML content of the cookie banner. Please mind that links should point to local content. Use the privacy page to add references to third party sites.

  2. layout: The list of properties for the cookies consent plugin. We use Bootstrap for the UI, therefore all the Bootstrap classes can be used to customize the appearance.

You can refer to the current values.yaml in the renku-ui repository to check the default values and to find an example of how to apply different settings.

Next Previous

© Copyright 2017-2022, Swiss Data Science Center Revision 0ecda9ce.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: 0.17.0
Versions
latest
stable
0.17.0
0.16.0
0.15.0
0.14.1
0.14.0
0.13.0
0.12.17
0.12.16
0.12.15
0.12.14
0.12.13
0.12.12
0.12.11
0.12.10
0.12.9
0.12.8
0.12.7
0.12.6
0.12.5
0.12.4
0.12.3
0.12.2
0.12.1
0.12.0
Downloads
On Read the Docs
Project Home
Builds