Getting Started

Kasm Workspaces provides browser-based access to on-demand containerized desktops and applications.

General information about the Workspaces platform is available at https://kasmweb.com

Help and Support Resources

There is a wealth of self-help, guided and community resources available should you get stuck.

• Frequently Asked Questions - Please see our FAQ for commonly questions.

• Troubleshooting Guide - The troubleshooting guide may be able to help with common connectivity and configuration items.

• Knowledge Base - A comprehensive resource for How-To and troubleshooting guides.

• YouTube Instructional Videos - We have a library of helpful video tutorials for admins and end users alike.

• Community Issue Tracker - Search for issues reported by others or submit your own feature request / bug report.

• Reddit - Join our community to discuss use-cases, questions, and related technology.

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

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.

Source	Destination	Port	Notes
End User	Kasm Workspaces	443	Web Application
End User	Kasm RDP gateway	3389	RDP 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

Installer

Contents	URL	SHA256
Installer Bundle	https://kasm-static-content.s3.amazonaws.com/kasm_release_1.17.0.7f020d.tar.gz	22a293ea52b2adb7f3f72a2de8e9be799f443b9da040e066df403478da77f62d

Offline AMD Images

Contents	URL	SHA256
Services	https://kasm-static-content.s3.amazonaws.com/kasm_release_service_images_amd64_1.17.0.7f020d.tar.gz	325229ed79d957d15d42cd80d75c3e59766d8953df49810fa42f09db34660a86
Workspaces	https://kasm-static-content.s3.amazonaws.com/kasm_release_workspace_images_amd64_1.17.0.7f020d.tar.gz	647a2c9a8113588c592a1d6f8b7017ac747d50f3179394912b3f6b5ab645120b
Plugin	https://kasm-static-content.s3.amazonaws.com/kasm_release_plugin_images_amd64_1.17.0.7f020d.tar.gz	0a8ca7a990663821c8fae356583160cde6517bedbbb920f05a75b91fdc14b3a9

Offline ARM Images

Contents	URL	SHA256
Services	https://kasm-static-content.s3.amazonaws.com/kasm_release_service_images_arm64_1.17.0.7f020d.tar.gz	01c1936685552836f126b5be8f3480e22b5187fd008b2266f60f2722569fa38d
Workspaces	https://kasm-static-content.s3.amazonaws.com/kasm_release_workspace_images_arm64_1.17.0.7f020d.tar.gz	08df2344b95af83f5d06ddc9f4f3c772e50618b2de7dcedd2016bddfaa9b70c9
Plugin	https://kasm-static-content.s3.amazonaws.com/kasm_release_plugin_images_arm64_1.17.0.7f020d.tar.gz	37a7645588cde806dda6d84dc13acc13d0fae9ae15bd9669c8229f82f1fde95d

Standard InstallOffline Install x86-64Offline Install arm64

cd /tmp
curl -O https://kasm-static-content.s3.amazonaws.com/kasm_release_1.17.0.7f020d.tar.gz
tar -xf kasm_release_1.17.0.7f020d.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

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.