Skip to main content
Version: 1.18.1 (latest)

Single Server Installation

The simplest way to deploy Kasm Workspaces is to install all application services on a single server. End-user sessions will also be provisioned on this server. All interior docker communication occurs within the single server and there are no special configurations required.

Please read through the entire process before getting started.

For help please see Help and Support.

Single Server Architecture
Single Server Architecture
Ports and Protocols

In the Single Server configurations all services communicate via internal docker networks. Only access to the Web Application and port 3389 for RDP gateway access (if desired) needs to be exposed.

SourceDestinationPortNotes
End UserKasm Workspaces443Web Application
End UserKasm RDP Gateway3389RDP Thick Client Access

Installation Guide

Please review the System Requirements before beginning.

tip

Kasm provides a Sizing and Deployment Guide to aid in determining hardware specifications for large scale deployments.

  • Download the latest version of Kasm Workspaces to /tmp
  • Extract the package and run the installation script.
Install Files
ContentsURLSHA256
Installer Bundlehttps://kasm-static-content.s3.amazonaws.com/kasm_release_1.18.1.tar.gz83d3b1d61a32f283b1b8e415ee4d1bbb02184930d00f6885f9799e001e677135
ContentsURLSHA256
Serviceshttps://kasm-static-content.s3.amazonaws.com/kasm_release_service_images_amd64_1.18.1.tar.gzaceb278607094227f33f98a30d69262ea6ab2989c132aeba583e12ab7cc9441a
Workspaceshttps://kasm-static-content.s3.amazonaws.com/kasm_release_workspace_images_amd64_1.18.1.tar.gz684ef2372c23acc0a16c49048a0c22de43aad6bb42f53860ba0f489c55b3c4db
Network Pluginhttps://kasm-static-content.s3.amazonaws.com/kasm_release_network_plugin_images_amd64_1.18.1.tar.gz2eca9c97875a7227f9f116ba0374189f8b0cb2e932a75acfe7cb9b5befd4fce6
Logging Pluginhttps://kasm-static-content.s3.amazonaws.com/kasm_release_logging_plugin_images_amd64_1.18.1.tar.gz7bce430646270b6d3679cc8b1f2bf836bab1c0b96ec5625d524d20b1d7afb25a
ContentsURLSHA256
Serviceshttps://kasm-static-content.s3.amazonaws.com/kasm_release_service_images_arm64_1.18.1.tar.gzd3323b18b25fba3037893970b5cd019d19ba3110684abb814993b536464f2550
Workspaceshttps://kasm-static-content.s3.amazonaws.com/kasm_release_workspace_images_arm64_1.18.1.tar.gza1f16d39101046f2150108872cc9100d5dff944d98df56f3f13c750f44cb66d6
Network Pluginhttps://kasm-static-content.s3.amazonaws.com/kasm_release_network_plugin_images_arm64_1.18.1.tar.gze202152b6ef1ae7c0013a3d62d15de1152ade9204346358bace46918597f2533
Logging Pluginhttps://kasm-static-content.s3.amazonaws.com/kasm_release_logging_plugin_images_arm64_1.18.1.tar.gz8b9e70e00de4c1c2f45b53df74c9034523542e1773921a1f2964b963e54ceb6b
cd /tmp
curl -O https://kasm-static-content.s3.amazonaws.com/kasm_release_1.18.1.tar.gz
tar -xf kasm_release_1.18.1.tar.gz
sudo bash kasm_release/install.sh
  • Log into the Web Application running on port 443 at https://<WEBAPP_SERVER>
  • The Default usernames are admin@kasm.local and user@kasm.local. The passwords will be randomly generated and presented at the end of the install unless the --admin-password or/and --user-password are specified.

Default Login Window

Default Login Window
Licensing the server during install?
Note

If you have an activation key it can be passed to the installation script and activation will be completed on your behalf as part of the install. Create a file for the activation key e.g. activation_key.txt and paste in the activation key you received in you confirmation email. When running the install.sh use the parameter -a or --activation-key-file so your command might look something like this sudo bash kasm_release/install.sh -a activation_key.txt. This will not work with an offline air-gapped install, as Kasm Workspaces must contact an activation server to complete licensing your installation. In a multi server install this option only applies to the database role.

Need to install Kasm on a different port?
Note

If you would like to run the Web Application on a different port pass the -L flag when calling the installer. e.g sudo bash kasm_release/install.sh -L 8443

Install Video Tutorial

This video walks through installing Kasm Workspaces on a single system.

Install troubleshooting

The install.sh script creates a log file as it runs, this file is removed upon completion of a successful installation. However, if something does go wrong the logfile will be available from the directory the install.sh script was executed from in the format kasm_install_${TIMESTAMP}.log. This file will be important for diagnosing the error that caused the installation to fail and will be requested when submitting a support ticket with Kasm Technologies. Kasm Technologies.