Images

Kasm server allows administrators to specify images that users can provision. These images can provide a full desktop or a single application.

Default Images

Kasm comes by default with a base images that are maintained by Kasm Technologies. The advantage of using these images directly is that when they are updated, your Kasm installation will pull them down immediately and start using them for newly created Kasms. This ensures images are always up to date with the latest security patches. The following are the Kasm maintained images.

Default Kasm Images

kasmweb/desktop:1.6.0

A standard desktop with minimal software. This image is open source.

DockerHub BitBucket

kasmweb/desktop-deluxe:1.6.0

A desktop with additional software such as Libre Office, Visual Studio code, and more.

DockerHub

kasmweb/firefox:1.6.0

A firefox browser only, no desktop. This image is open source.

DockerHub BitBucket

kasmweb/firefox-mobile:1.6.0

A firefox browser only, no desktop. This image is optimized for mobile devices.

DockerHub

kasmweb/chrome:1.6.0

A chrome browser only, no desktop. This image is open source.

DockerHub BitBucket

kasmweb/tor-browser:1.6.0

Tor-browser only, no desktop.

DockerHub

Custom Kasm Images

Administrators can create their own images, they must be based off kasmweb/core. See the open source project at https://bitbucket.org/kasmtech/kasm_release/src to see the dockerfile for kasmweb/desktop and kasmweb/firefox. Pull down our code to modify kasmweb/desktop, or create your own based off kasmweb/core and then build locally.

sudo docker build -t kasmweb/desktop:custom -f dockerfile-kasm-desktop .

It is highly recommended to use a docker registry. It can be Docker Hub or a private registry. However, you can run images built locally on the server that houses the Agent role.

Add/Edit Kasm Images

From the Images menu you can edit existing images or add new images. There are a number of properties that can be defined for an image.

Name

Image Name

Description

Description of Image

Friendly Name

Image name shown to user

Thumbnail URL

(Optional) Address of container icon

Cores

Amount of CPU cores allocated per Image

Memory

Amount of Memory allocated per Image, in megabytes

Enabled

The image is enabled for use. If unchecked the image will not be available for users to provision. Agents will not be given instructions to download Images that are disabled.

Docker Registry

The docker registry to pull the images from For Docker Hub use https://index.docker.io/v1/ Leave this option blank if you intend to use local images built directly on the Agent server.

Docker Token

(Optional) Password

Docker User

(Optional) Username

Hash

(Optional) hash of image

Persistent Profile Path

(Optional) Absolute path of the location to store user’s persistent profile. See Persistent Profiles for more details.

Volume Mappings

(Optional) Json data for Volume Mappings

Docker Run Config Override

(Optional) Json data for specifying additional docker run arguments, see Python Docker API for json format https://docker-py.readthedocs.io/en/stable/

Docker Exec Config

(Optional) Json data for specifying commands to executed when a Kasm is started or resumed. See the Docker Exec Config for details

Restrict Image to Docker Network

(Optional) Instances of this image will only be created on agent servers with this docker network.

Restrict Image to Kasm Agent

(Optional) Instances of this image will only be created on this agent server.

Restrict Image to Zone

(Optional) Instances of this image will only be created on Agents within the selected Deployment Zone

Note

The Images are by default added to the all users group. This behavior can be changed with the Add Images To Default Group server setting.

Docker Exec Config

The Docker Exec configurations allow administrators to configure custom commands to be executed when a user creates or resumes a Kasm.

This JSON dictionary configuration accepts two top-level keys first_launch, and go.

  • first_launch

    This command is executed after the Kasm is launched.

  • go

    This command is executed when the user requests to create or resume a Kasm via the /go url. If the Kasm doesnt exists yet, and will be created for the first time, the first_launch command will take priority.

The following example demonstrates how to use the Docker Exex Config for the default kasmweb/chrome Image for a seamless browser isolation configuration.

See Browser Isolation for more details.

{
    "first_launch": {
        "cmd": "bash -c 'google-chrome --start-maximized \"$KASM_URL\"'",
        "environment": {
            "LAUNCH_URL": ""
        }
    },
    "go": {
        "cmd": "bash -c 'google-chrome --start-maximized \"$KASM_URL\"'"
    }
}