mcpField
K
kasm

kasm

github.com/evolv3-aiCloud & DevOps141 installsUpdated 14w ago
Repository

About kasm

kasm is a skill for installing, configuring, managing, and troubleshooting KASM Workspaces on Linux servers. It directs tasks to focused guidance for areas such as networking, backups, and API automation.

Key features

  1. 01Installation and service management
  2. 02Workspace and profile configuration
  3. 03Troubleshooting guidance
  4. 04Backup and recovery procedures
  5. 05Networking and API operations

Use cases

  1. 01Installing KASM Workspaces on a Linux server
  2. 02Configuring workspace profiles and volumes
  3. 03Investigating service errors and logs
  4. 04Automating tasks through the API

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/evolv3-ai/vibe-skills --skill kasm

After installing, type/kasmin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

assets/
env-template
references/
api-reference.md
backup-recovery.md
cloudflare-tunnel.md
database-operations.md
installation.md
networking.md
service-management.md
troubleshooting.md
workspace-configuration.md

Details

From the project README

KASM Workspaces

CRITICAL: Secrets and .env

  • NEVER store live .env files or credentials inside any skill folder.
  • .env.template files belong only in assets/ within a skill.
  • Store live secrets in ~/.admin/.env and reference from there.

Purpose: Install, configure, manage, and troubleshoot KASM Workspaces on Linux servers.

Step 0: Determine What the User Needs

Ask the user which task they need help with:

TaskReference
Fresh installationreferences/installation.md
Workspace configuration (profiles, volumes, Docker overrides)references/workspace-configuration.md
Troubleshooting errorsreferences/troubleshooting.md
Backup and recoveryreferences/backup-recovery.md
Cloudflare Tunnel or reverse proxyreferences/networking.md
Database queries or maintenancereferences/database-operations.md
API calls or automationreferences/api-reference.md
Service management (start/stop/logs)references/service-management.md

Read the appropriate reference file and follow its instructions.


Quick Reference

System Requirements
  • Docker >= 25.0.5, Docker Compose >= 2.40.2
  • Minimum: 2 cores, 4GB RAM, 75GB SSD
  • Per session default: 2,768MB RAM + 2 cores
  • Swap partition strongly recommended
  • Supported: Ubuntu 22.04/24.04, Debian 11/12, RHEL 8/9/10, Oracle Linux 8/9, AlmaLinux/Rocky 8/9, Raspberry Pi OS 11/12
  • Architectures: amd64 and arm64
Key Paths
PathPurpose
/opt/kasm/current/Installation root
/opt/kasm/current/bin/startStart all services
/opt/kasm/current/bin/stopStop all services
/opt/kasm/current/log/Log files (raw + JSON)
/mnt/kasm_profiles/Persistent profiles (volume mount)
/var/lib/dockerDocker storage
Key Containers
ContainerRole
kasm_apiAPI server
kasm_agentAgent (runs workspace containers)
kasm_managerManager (orchestration)
kasm_proxyHTTPS proxy
kasm_dbPostgreSQL database (user: kasmapp, db: kasm)
Service Control
sudo /opt/kasm/current/bin/stop     # Stop all
sudo /opt/kasm/current/bin/start    # Start all
sudo docker restart kasm_api        # Restart single service
sudo docker logs -f kasm_api        # Live logs

Critical Rules

  • Always install Docker CE + Compose plugin BEFORE KASM.
  • Always configure swap - KASM can be unstable without it even with sufficient RAM.
  • Each concurrent session needs ~2-4GB RAM. Size the server accordingly.
  • Do not expose port 8443 publicly without HTTPS.
  • KASM API uses JSON payload auth (NOT HTTP Basic Auth). See references/api-reference.md.
  • The API calls workspaces "images" - get_images not get_workspaces.
  • For S3 persistent profiles, always include @endpoint in the path. Missing it causes excessive API calls.

Related Skills

  • devops for server inventory and provisioning
  • backblaze-b2 for S3-compatible storage
  • Provider skills (oci, hetzner, contabo, etc.) for server setup
  • cloudflare-worker-base for Cloudflare integrations

References

Comments

Markdown supported