.. title:: Custom Branding

Custom Branding
---------------
Administrators and developers may choose to add custom branding to their Kasm deployment.

.. figure:: /images/branding/custom_login_logo.png
    :width: 90%
    :align: center

    **Custom Login Logo and Caption**

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 Cloud and Kasm Server Enterprise.


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

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

    **Branding Config List**


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

    **Branding Options**


.. 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.                                                                                                |
    +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **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.                |
    +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    | **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 and loading logo can be adjusted by creating a custom `Kasm Image <../guide/custom_images.html#custom-kasm-images>`_

**Background**
    The background can be changed by replacing the following file:

.. code-block:: Bash

  $HOME/.config/bg_kasm.png

**Loading Logo**
    The logo that is displayed when loading a Kasm Session can be changed by replacing the following file:

.. code-block:: Bash

  $STARTUPDIR/kasmrx/app/images/icons/kasm_logo.png