---
title: Custom Branding
---

<head>
  <link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/custom-branding"/>
</head>

## Prerequisite

You will need to have at least cluster member permissions.

## Brand Configuration

To configure the brand settings,

1. Click **☰ > Global settings**.
2. Click **Branding**.

### Private Label Company Name

This option replaces "Rancher" with the value you provide in most places. Files that need to have Rancher in the name, such as `rancher-compose.yml`, won't be changed.

### Support Links

Use a url address to send new "File an Issue" reports instead of sending users to the GitHub issues page. Optionally show Rancher community support links.

### Logo

Upload light and dark logos to replace the Rancher logo in the top-level navigation header.

### Primary Color

You can override the primary color used throughout the UI with a custom color of your choice.

### Fixed Banners

Display a custom fixed banner in the header, footer, or both.

To configure banner settings,

1. Click **☰ > Global settings**.
2. Click **Banners**.

## Custom Navigation Links

In this section, you'll learn how to configure the links in the left navigation bar of the **Cluster Dashboard**. To get to the cluster dashboard,

1. In the upper left corner, click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the cluster where you want custom navigation links and click **Explore**.

It can be useful to add a link for quick access to services installed on a cluster. For example, you could add a link to the Kiali UI for clusters with Istio installed, or you could add a link to the Grafana UI for clusters with Rancher monitoring installed.

The custom links don't affect who has access to each service.

Links can be created at the top level and multiple links can be grouped together.

### Adding a Custom Navigation Link

:::note Prerequisite:

You will need to have at least cluster member or project member permissions.

:::

1. Click **☰ > Cluster Management**.
1. On the **Clusters** page, go to the cluster where you would like to add custom navigation links and click **Explore**.
2. In the top navigation menu, click **🔍 (Resource Search)**.
3. Type **Nav** and click **Nav Links**.
4. Click **Create from YAML**.
5. The simplest way to create a navigation link is to add these fields:

        name: linkname
        toURL: https://example.com

    For more details on setting up links, including optional fields, see [Link Configuration.](#link-configuration)
6. Click **Create**.

## Link Configuration

### `name`

Display name for the link. Required.

### `group`

Name of a group of links that expands when clicked.

Optional. If not provided, the link appears standalone.

Groups are displayed separately from standalone links, as shown below:

![Screenshot of group and standalone link](/img/grouped-vs-standalone-links.png)

### `iconSrc`

Icon source in in base64 format.

Below is an example of the Grafana logo in base64 format:

```
data:image/png;base64,[encoded data, 80540 characters]
```

### `annotation`

A Kubernetes annotation for the NavLink custom resource.

### `label`

A Kubernetes label for the NavLink custom resource.

### `sideLabel`

Label that appears in the left navigation bar

### `target`

Sets the target property of the link's anchor tag (`<a>`), which (depending on browsers) determines if it opens in a new window or in an existing tab.

The default value is `_self`, which opens the link on the current tab. To open the link in a new window or tab, set the target to `_blank`.

For more information about the target property, see [this page.](https://www.w3schools.com/tags/att_a_target.asp)

### `toService`

Has five fields that are constructed to create a URL like the following: `https://<RANCHER_SERVER_URL>/k8s/clusters/<CLUSTER>/k8s/namespace/<NAMESPACE>/service/<SCHEME>:<NAME>:<PORT>/proxy/<PATH>`

For example, a link to a monitoring service can be set up as follows:

- name: `rancher-monitoring-grafana`
- namespace: `cattle-monitoring-system`
- path: `proxy/?orgId=1`
- port: `"80"`
- scheme: `http`

It is required to provide either the `toService` directive or the `toURL` directive.

### `toUrl`

Can be any link, even to links outside of the cluster.

It is required to provide either the `toService` directive or the `toURL` directive.

## Link Examples

### Example of Link with `toUrl`

This example NavLink YAML shows an example of configuring a NavLink to a Grafana dashboard:

```yaml
apiVersion: ui.cattle.io/v1
kind: NavLink
metadata:
  name: grafana
spec:
  group: "Monitoring Dashboards"
  toURL: https://<RANCHER_SERVER_URL>/api/v1/namespaces/cattle-monitoring-system/services/http:rancher-monitoring-grafana:80/proxy/?orgId=1
```

Adding the above YAML results in a link to Grafana being created, as shown in the following screenshot:

![Screenshot of Grafana Link](/img/example-grafana-link.png)

### Example of Link with `toService`

This example YAML shows an example of `toService` used for the link target:

```yaml
apiVersion: ui.cattle.io/v1
kind: NavLink
metadata:
  annotations:
    key: annotation
    labels:
      key: label
  name: navlinkname
spec:
  description: This is a description field # Optional.
  group: "group1" # Optional. If not provided, the links appear standalone.
  iconSrc: data:image/jpeg;base64,[icon source string is clipped for brevity]
  label: This is a label # Optional.
  sideLabel: A side label. # Optional.
  target: _blank #Optional. _blank opens the link in a new tab or window.
  toService: # toService or #toUrl needs to be provided.
    name: rancher-monitoring-grafana
    namespace: cattle-monitoring-system
    path: proxy/?orgId=1
    port: "80"
    scheme: http
```

Adding the `toService` parameters above results in a link to Grafana being created, as shown in the following screenshot:

![Screenshot of Grafana Link](/img/example-service-link.png)

