Getting Started

Kasm Server provides remote access to on-demand Linux desktops or single application containers called Kasms. Users access Kasms via most modern browsers and require no additional browser plugins or software.

More information is available at www.kasmweb.com

Standard Installation

This simplest way to install Kasms Server s to install all application services on a single server. End-user Kasms will also be provisioned on this server. All interior docker communication occurs within the single server and there are no special configurations required.

_images/single_install2.png

Single Server Architecture

Ports and Protocols

In the Single Server configurations all services communicate via internal docker networks. Only access to the Web Application needs to be exposed.

Source

Destination

Port

Notes

End User

Kasm Server

443

Web Application

System Requirements

Please review the System Requirements before beginning.

Resource Allocation

Administrators can configures Kasms to provision with with any amount of cpu or memory allocations by editing the in the Kasm Image Settings. However, even a host with more than enough system memory can run into stability issues without enabling a swap partition. For this reason, the Kasm installation requires a swap partition to be present.

Warning

Install Swap partition for best stability of end user Kasms. For additional details on docker resource constraints see the folowing link: Docker Resource Constraints

Creating A Swap Partition

For general information on swap partitions check out the Ubuntu Documentation

The following steps will create a 1 gigabyte (1g) Swap partition. It is recommended to allocate 1 gigabyte per concurrent Kasm you expect to run at any given time. Please adjust according to your needs.

sudo fallocate -l 1g /mnt/1GiB.swap
sudo chmod 600 /mnt/1GiB.swap
sudo mkswap /mnt/1GiB.swap
sudo swapon /mnt/1GiB.swap

Verify swap file exists

cat /proc/swaps

To make the swap file available on boot

echo '/mnt/1GiB.swap swap swap defaults 0 0' | sudo tee -a /etc/fstab

Installation Guide

  • Download the latest version of Kasm Server to /tmp

  • Extract the package and run the installation script.

cd /tmp
tar -xf kasm_release*.tar.gz
sudo bash kasm_release/install.sh

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

Default Login

  • Access the Web Application running on port 443 at https://<WEBAPP_SERVER>

  • Log into the Web Application as the Administrator using the default credentials produced during the install.

Note

By default, the Administrators group has a 2 hours daily usage limit defined. This can be changed or removed by altering the usage_limit Group Setting on the Administrators group.

_images/login.png

Uninstall

  • Stop All Kasm services.

sudo /opt/kasm/current/bin/stop

  • Remove any Kasm user session containers.

sudo docker rm -f $(sudo docker container ls -qa --filter="label=kasm.kasmid")

  • Remove Kasm service containers.

export KASM_UID=$(id kasm -u)
export KASM_GID=$(id kasm -g)
sudo -E docker-compose -f /opt/kasm/current/docker/docker-compose.yaml rm

  • Remove the Kasm docker network.

sudo docker network rm kasm_default_network

  • Remove the Kasm database docker volume.

sudo docker volume rm kasm_db_1.8.0

  • Remove the Kasm docker images.

sudo docker rmi redis:5-alpine
sudo docker rmi postgres:9.5-alpine
sudo docker rmi nginx:alpine
sudo docker rmi kasmweb/tor-browser:1.8.0
sudo docker rmi kasmweb/desktop-deluxe:1.8.0
sudo docker rmi kasmweb/chrome:1.8.0
sudo docker rmi kasmweb/firefox:1.8.0
sudo docker rmi kasmweb/desktop:1.8.0
sudo docker rmi kasmweb/share:1.8.0
sudo docker rmi kasmweb/agent:1.8.0
sudo docker rmi kasmweb/manager:1.8.0
sudo docker rmi kasmweb/api:1.8.0

  • Remove the Kasm installation directory structure.

sudo rm -rf /opt/kasm/

Documentation: