Deployment Overview of Kasm Workspaces on Server¶

Prerequisites and Basic Requirements¶

To ensure a successful deployment, the server must meet the following requirements:

Operating System: Debian or Ubuntu (specifically Jammy Jellyfish for certain Docker version locks).
Privileges: Root or sudo access is required for package installation and service management.
Dependencies: The system requires ca-certificates, curl, gnupg, python3-pip, python3-requests, and python3-docker.
Docker Requirements: A specific version of Docker CE (e.g., 5:28.5.2-1~ubuntu.22.04~jammy) may be required on Ubuntu systems to ensure compatibility, with the package held to prevent unintended upgrades.

The application is accessible via a specific subdomain template based on the server ID.

The application utilizes the following directory structure for configuration, data, and certificates:

The installation method varies depending on the operating system:

The system packages are updated via apt.
A specific version of Docker CE is installed and "held" to prevent automatic updates that might cause incompatibility.
An official Kasm release archive (kasm_release_1.17.0.bbc15c.tar.gz) is downloaded and extracted in the /root directory.
The installation script ./install.sh is executed from the /root/kasm_release directory with parameters for administrative credentials, public hostname, EULA acceptance, and a swap size of 8192MB.

Docker is installed to provide the container runtime.
Data directories (/data, /data/kasm/, and /data/kasm/profiles) are created with restricted permissions (0640).
The application is deployed as a Docker container using the lscr.io/linuxserver/kasm:latest image.

Firewall: Ensure that the Kasm port (as defined in configuration) and standard web ports are open.
Permissions: Data directories are owned by root with mode 0640.
SSL/TLS: SSL certificates are obtained via Certbot using the --standalone method to secure the connection.

The deployment utilizes Docker for service orchestration.

The following actions are performed during the setup process:

Docker Configuration: A custom daemon.json is deployed to /etc/docker/.
Compose Plugin Management: Older versions of Docker Compose (1.42) are removed, and version 1.52 is installed into /usr/local/lib/docker/.
SSL Certificate Integration: After obtaining certificates via Certbot, the existing Kasm Nginx certificates (kasm_nginx.key and kasm_nginx.crt) are backed up and replaced with the Let's Encrypt full chain and private key files.

To update the application:

Docker-based deployments: Use the following command to pull the latest images and restart services:
```
docker compose pull && docker compose up -d
```
Script-based deployments: Re-run the installation script located in the /root/kasm_release directory.

The following commands are used to manage the Kasm services: