.. title:: Custom Branding Custom Branding --------------- Administrators may choose to add custom branding to their Kasm deployment. .. figure:: /images/branding/default_branding.png :width: 90% :align: center **Default Branding** .. figure:: /images/branding/custom_branding.png :width: 90% :align: center **Custom Login Logo Caption and Splash** 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 :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. | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | **Splash Background URL** | URL for the splash backround image that is used when a user loads a session. | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | **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 and loading logo can be adjusted by :doc:`Building a Custom Image ` **Background** The background can be changed by replacing the following file. Recommended resolution: 1920x1080 px. .. code-block:: Bash /usr/share/extra/backgrounds/bg_default.png