---
myst:
  html_meta:
    "description lang=en": "Replace Kasm Workspaces application branding with your own custom logos and information."
    "keywords": "Kasm, How to, How-to, Customization, Logo, Background, Branding"
    "property=og:locale": "en_US"
---
```{title} Custom Branding
```

# Custom Branding

Administrators may choose to add custom branding to their Kasm deployment.

```{figure} /images/branding/default_branding.webp
:align: center
**Default Branding**
```

```{figure} /images/branding/custom_branding.webp
:align: center
**Custom Login Logo Caption and Splash**
```

```{figure} /images/branding/launcher.png
:align: center
**Workspaces launcher supports using a custom background**
```

## Application Branding

Kasm allows administrators to define multiple branding configurations that are chosen by the system based on the URL
hostname the users accesses the system with.

```{tip}
Changes to branding may take up to 90 seconds to be apply since certain requests are cached by the system.
When regularly changing and testing branding settings it is best to use the following steps to observe the changes:
- Wait 90 seconds after the configuration change is made.
- Logout of the Kasm UI.
- Navigate the browser to the login page, and do a hard refesh of the page (Typcially CTRL+F5) or clear the browser cache.
- Login and verify changes.
```

```{note}
This feature is available in Kasm Workspaces Enterprise.
```

**Branding Configs** can be defined in the UI by an administrator under **Settings** -> **Branding**.

```{figure} /images/branding/branding_configs.webp
:align: center
**Branding Config List**
```

```{figure} /images/branding/update_branding_config.webp
:align: center
**Branding Options**
```

```{eval-rst}
.. table::
    :widths: 60

    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Name**                         | **Description**                                                                                                                           |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Name**                         | The name for the configuration.                                                                                                           |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Hostname**                     | The hostname of the URL used to access the Kasm deployment is used to map the appropriate branding config.                                |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Favicon Logo URL**             | URL for the favicon logo image.                                                                                                           |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Header Logo URL**              | URL for the application header logo image.                                                                                                |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Launcher Background URL**      | URL for the background image for the Workspaces launcher. See :ref:`default-backgrounds` for a list of available default images.          |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **HTML Title**                   | HTML document title.                                                                                                                      |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Login Caption**                | Caption displayed under the login logo.                                                                                                   |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Login Logo URL**               | URL for the login logo image. If a custom logo is used, the phrase "Powered By Kasm" will be displayed under the new logo.                |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Login Splash Background URL**  | URL for the login splash background image.                                                                                                |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Loading Session Text**         | The text to display while the user is connecting to a session.                                                                            |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Joining Session Text**         | The text to display while the user is joining a shared session.                                                                           |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Destroying Session Text**      | The text to display when the session is being destroyed.                                                                                  |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **Default**                      | If the configuration is set to Default, this system will use this configuration if the URL hostname does not match another config.        |
    +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+

```

## Session Branding

The default background used within a session container can be adjusted by {doc}`Building a Custom Image <building_images>`
or {ref}`file-mapping-background`.

**Background**

The background can be changed by replacing the following file. Recommended resolution: 1920x1080 px.

```Bash
/usr/share/backgrounds/bg_default.png
```


(default-backgrounds)=

## Default Backgrounds

Workspaces includes a number of default backgrounds by default. Below is a preview of the images and the relative urls
that can be used in the configurations.


```{figure} /images/branding/default_backgrounds/background1.jpg
:align: center
**img/backgrounds/background1.jpg**
```


```{figure} /images/branding/default_backgrounds/background2.jpg
:align: center
**img/backgrounds/background2.jpg**
```

```{figure} /images/branding/default_backgrounds/background3.jpg
:align: center
**img/backgrounds/background3.jpg**
```

```{figure} /images/branding/default_backgrounds/background4.jpg
:align: center
**img/backgrounds/background4.jpg**
```

```{figure} /images/branding/default_backgrounds/background5.jpg
:align: center
**img/backgrounds/background5.jpg**
```

```{figure} /images/branding/default_backgrounds/background6.jpg
:align: center
**img/backgrounds/background6.jpg**
```

```{figure} /images/branding/default_backgrounds/background7.jpg
:align: center
**img/backgrounds/background7.jpg**
```

```{figure} /images/branding/default_backgrounds/background8.jpg
:align: center
**img/backgrounds/background8.jpg**
```

```{figure} /images/branding/default_backgrounds/background9.jpg
:align: center
**img/backgrounds/background9.jpg**
```

```{figure} /images/branding/default_backgrounds/background10.jpg
:align: center
**img/backgrounds/background10.jpg**
```

```{figure} /images/branding/default_backgrounds/background11.jpg
:align: center
**img/backgrounds/background11.jpg**
```

```{figure} /images/branding/default_backgrounds/background12.jpg
:align: center
**img/backgrounds/background12.jpg**
```