Skip to main content
Version: 1.19.0 (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.19.0.tar.gz7b801cb0579a7867df46b6da873fe8dd631db07d4c05349e5bd1aea27130c37d
ContentsURLSHA256
Serviceshttps://kasm-static-content.s3.amazonaws.com/kasm_release_service_images_amd64_1.19.0.tar.gzc8697a7d6db6d6c2cd685cf431977e79bb4adfa35d91d6fab455e70f4441e46d
Workspaceshttps://kasm-static-content.s3.amazonaws.com/kasm_release_workspace_images_amd64_1.19.0.tar.gz2338ed95653cf37b41c32c4202c38b507fd94a745dc81a303402e20f292486da
Network Pluginhttps://kasm-static-content.s3.amazonaws.com/kasm_release_network_plugin_images_amd64_1.5.tar.gzbd13ce71737cebf2e7559c01c2dbff657a52505c771fce450a32bed36ef3056d
Logging Pluginhttps://kasm-static-content.s3.amazonaws.com/kasm_release_logging_plugin_images_amd64_1.1.tar.gzfe5d1d6d1acd42ea89e15e375d0d6719f9d6cbf1f9c6943c4fda901a3d529135
ContentsURLSHA256
Serviceshttps://kasm-static-content.s3.amazonaws.com/kasm_release_service_images_arm64_1.19.0.tar.gzf7975cecf89fc5b1e3886c09178047e7d6f092344ab15f9babfdeaeeb8d01801
Workspaceshttps://kasm-static-content.s3.amazonaws.com/kasm_release_workspace_images_arm64_1.19.0.tar.gz5ee92ebac22c7399694c9a7eef4d0baddc98c315c2d78848fa3a757d66bcd2c4
Network Pluginhttps://kasm-static-content.s3.amazonaws.com/kasm_release_network_plugin_images_arm64_1.5.tar.gz59d23f6765f26be86a00fed31b38873d36f9b7b7ecf608a2efb270d969621ae6
Logging Pluginhttps://kasm-static-content.s3.amazonaws.com/kasm_release_logging_plugin_images_arm64_1.1.tar.gz1d720994c141fe9743b566ea2affeee77759e272ad777d0257ed6a089dd3b802
cd /tmp \
&& curl --fail-early \
    -fO https://kasm-static-content.s3.amazonaws.com/kasm_release_1.19.0-latest.tar.gz \
    -fO https://kasm-static-content.s3.amazonaws.com/kasm_release_1.19.0-latest.tar.gz.sha256sum \
&& sha256sum --check *.sha256sum \
&& tar -xf kasm_release_1.19.0-latest.tar.gz \
&& sudo bash kasm_release/install.sh
Note

Starting in 1.19.0, the default installation uses rolling images to deliver ongoing security fixes and updates. For static images with manual update control, pass in the -f or --use-static-images arguments during the installation or upgrade process.

sudo bash kasm_release/install.sh -f

or

sudo bash kasm_release/upgrade.sh -f

Refer to Rolling Image Management for more information about rolling images.

  • 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

All install options
FlagDescription
-v, --verboseVerbose output
-e, --accept-eulaAccept End User License Agreement
-D, --no-startDon't start services at the end of installation
-W, --default-imagesSeed and Download default Workspaces Images
-L, --proxy-portDefault Proxy Listening Port (e.g., 8443 for HTTPS on alternate port)
-U, --user-passwordDefault User Password
-P, --admin-passwordDefault Admin Password
-a, --activation-key-fileLicense Activation key file path
-w, --offline-workspacesPath to the tar.gz workspace images offline installer
-s, --offline-servicePath to the tar.gz service images offline installer
-x, --offline-network-pluginPath to the tar.gz network plugin images offline installer
--offline-logger-pluginPath to the tar.gz logger plugin images offline installer
-O, --use-rolling-imagesUse rolling Workspaces images
-f, --use-static-imagesUse static version Workspaces images
-A, --enable-losslessEnable lossless streaming option
-H, --no-swap-checkDisable check for swapfile
-J, --swap-sizeCreate swap if none exists in megabytes (e.g., 4096)
-B, --no-check-portsDo not check for open ports
-b, --no-check-diskDo not check disk space
-X, --skip-v4l2loopbackSkip v4l2loopback installation
--skip-egressDo not install egress network plugin or dependencies
--enable-epelEnable EPEL repo to install packages not in default RHEL repos. Required for WireGuard on RHEL/Rocky/AlmaLinux/Oracle 8 — pass this flag explicitly or respond y to the interactive prompt.
--ignore-dep-failuresContinue installation even if optional dependencies fail to install
--install-dependsForce dependency installation even during offline installs. Has no effect on online installs (deps always run by default).
--ssl-public-certCopy the public SSL certificate from this path during install
--ssl-private-keyCopy the private SSL key from this path during install

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.