Skip to main content

Custom Branding

The vCluster Platform UI can be branded according to your corporate design.

Custom branding can be configured via the vCluster Platform Config:

uiSettings:
  # Terms of Service, Privacy Policy etc.
  # Can be an html string.
  legalTemplate: You agree to the <a href="http://acme.com/">Terms of Service</a>

  # An **accessible** url. Can be in your cluster as long as you make sure the UI can find it
  logoURL: https://acme.com/static/our-logo.svg

  # Primary color
  # Can be `hex`, `rgb` or `rgba` string
  primaryColor: "#1890ff"

  # Sidebar color
  # Can be `hex`, `rgb` or `rgba` string
  sidebarColor: "#001529"

  # Accent color
  # Can be `hex`, `rgb` or `rgba` string
  accentColor: "#00BDFF"

Advanced Custom Branding​

You can extend the primary sidebar with your own navigation items

navBarButtons:
  - text: "My Link"
    icon: "https://acme.com/static/my-icon.svg"
    link: "https://acme.com/my-link"
    position: TopEnd # can be one of TopStart, TopEnd, BottomStart, BottomEnd. Defaults to BottomEnd

If you need even more control, you can use additional javascript and css. The css classes and html ids in the vCluster Platform UI DOM are stable across versions. You are responsible for making sure your files are accessible to the vCluster Platform UI in the same way you'd expose your logo.

customCss:
  - https://your-server.tld/overrides.css
customJavaScript:
  - https://your-server.tld/script.js