> For the complete documentation index, see [llms.txt](https://learn.netmaker.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.netmaker.io/getting-started/server-and-client-management/server-installation/ui-branding.md).

# UI Branding

## Modifying the UI with whitelabeling

Netmaker UI allows resellers to whitelabel and customize branding by building a custom docker image with the environment variables below set.

Recommended: use logos with an aspect ratio of 4:3.

{% stepper %}
{% step %}

### VITE\_PRODUCT\_NAME

The name of the product. This is the name that will appear in the UI.
{% endstep %}

{% step %}

### VITE\_TENANT\_LOGO\_DARK\_URL

Logo to be used in dark mode.
{% endstep %}

{% step %}

### VITE\_TENANT\_LOGO\_LIGHT\_URL

Logo to be used in light mode.
{% endstep %}

{% step %}

### VITE\_TENANT\_LOGO\_DARK\_SMALL\_URL

Small variant of the logo to be used in dark mode (e.g., when the sidenav is collapsed). Optional.
{% endstep %}

{% step %}

### VITE\_TENANT\_LOGO\_LIGHT\_SMALL\_URL

Small variant of the logo to be used in light mode (e.g., when the sidenav is collapsed). Optional.
{% endstep %}

{% step %}

### VITE\_TENANT\_LOGO\_ALT\_TEXT

Alternative text for the logo.
{% endstep %}

{% step %}

### VITE\_TENANT\_FAVICON\_LOGO

Favicon to use in the web browser’s tab. Defaults to the light logo if not specified. Recommended to use a 32x32px .ico image.
{% endstep %}

{% step %}

### VITE\_TENANT\_PRIMARY\_COLOR

UI primary color. Replace this with your brand color (examples: red, green, "#F00", "#00FF00"). Note: hex values need quoting.
{% endstep %}
{% endstepper %}

You can use URLs to host the logos, or place the logos in the /public directory before building the docker image.

Reference: <https://github.com/gravitl/netmaker-ui-2/blob/master/Dockerfile.standalone>

For more information on how to go about whitelabelling, reach out to us at <https://www.netmaker.io/contact>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://learn.netmaker.io/getting-started/server-and-client-management/server-installation/ui-branding.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
