---
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.png
:align: center
:width: 90%

**Default Branding**
```

```{figure} /images/branding/custom_branding.png
:align: center
:width: 90%

**Custom Login Logo Caption and Splash**
```

```{figure} /images/branding/launcher.png
:align: center
:width: 90%

**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.

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

**Branding Configs** can be defined in the UI by an administrator.

```{figure} /images/branding/branding_configs.png
:align: center
:width: 90%

**Branding Config List**
```

```{figure} /images/branding/update_branding_config.png
:align: center
:width: 90%

**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>`

**Background**

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

```Bash
/usr/share/extra/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
:width: 80%

**img/backgrounds/background1.jpg**
```


```{figure} /images/branding/default_backgrounds/background2.jpg
:align: center
:width: 80%

**img/backgrounds/background2.jpg**
```

```{figure} /images/branding/default_backgrounds/background3.jpg
:align: center
:width: 80%

**img/backgrounds/background3.jpg**
```

```{figure} /images/branding/default_backgrounds/background4.jpg
:align: center
:width: 80%

**img/backgrounds/background4.jpg**
```

```{figure} /images/branding/default_backgrounds/background5.jpg
:align: center
:width: 80%

**img/backgrounds/background5.jpg**
```

```{figure} /images/branding/default_backgrounds/background6.jpg
:align: center
:width: 80%

**img/backgrounds/background6.jpg**
```

```{figure} /images/branding/default_backgrounds/background7.jpg
:align: center
:width: 80%

**img/backgrounds/background7.jpg**
```

```{figure} /images/branding/default_backgrounds/background8.jpg
:align: center
:width: 80%

**img/backgrounds/background8.jpg**
```

```{figure} /images/branding/default_backgrounds/background9.jpg
:align: center
:width: 80%

**img/backgrounds/background9.jpg**
```

```{figure} /images/branding/default_backgrounds/background10.jpg
:align: center
:width: 80%

**img/backgrounds/background10.jpg**
```

```{figure} /images/branding/default_backgrounds/background11.jpg
:align: center
:width: 80%

**img/backgrounds/background11.jpg**
```

```{figure} /images/branding/default_backgrounds/background12.jpg
:align: center
:width: 80%

**img/backgrounds/background12.jpg**
```