---
myst:
  html_meta:
    "description lang=en": "Kasm Workspaces system requirements. Operating system support, Docker, and web browser support."
    "keywords": "Kasm, Requirements, System"
    "property=og:locale": "en_US"
---
```{title} System Requirements
```

# Kasm Workspaces Requirements

Kasm Workspaces can be installed in a {doc}`single server <single_server_install>` or {doc}`multi server <multi_server_install>` setup.

## Operating System

Kasm Services and end user sessions are {term}`Docker` containers. Access to the Docker registry is required for
installation.

Kasm Workspaces can be installed on a Virtual Machine or directly on bare metal. We do not recommend running Kasm in LXC or WSL/WSL2. 

Installation is supported on the following operating systems:

```{eval-rst}
.. table:: **Supported Operating Systems**
    :widths: 100

    +-------------------------------------------------------+
    | Ubuntu 20.04 / 22.04 / 24.04 (amd64/arm64)            |
    +-------------------------------------------------------+
    | Debian 11 / 12 (amd64/arm64)                          |
    +-------------------------------------------------------+
    | Oracle Linux 8 / 9 (amd64/arm64)                      |
    +-------------------------------------------------------+
    | Red Hat Enterprise Linux 8 / 9 (amd64/arm64)          |
    +-------------------------------------------------------+
    | Raspberry Pi OS (Debian) 11 / 12 (arm64)              |
    +-------------------------------------------------------+
    | AlmaLinux 8 / 9 (amd64/arm64)                         |
    +-------------------------------------------------------+
    | Rocky Linux 8 / 9 (amd64/arm64)                       |
    +-------------------------------------------------------+
    | :doc:`Other <../how_to/other_operating_systems>`      |
    +-------------------------------------------------------+
```

```{note}
Not all published Workspaces Docker Images are available on all architectures. Please see {doc}`Default Images <../guide/custom_images>` for the support matrix.
```

## Resource Requirements

```{eval-rst}
.. table:: **Minimum Requirements**
    :widths: 100,100

    +-------------+------------+
    | **CPU**     | 2 cores    |
    +-------------+------------+
    | **Memory**  |        4GB |
    +-------------+------------+
    | **Storage** | 50GB (SSD) |
    +-------------+------------+

```

```{include} /install/sizing_guide_tip.md
```

Although the requirements for the Kasm services are quite modest, provisioning each end-user session
requires additional compute resources as specified in the {term}`Workspace<Workspace>` configuration. The default Kasm
Workspaces are {doc}`configured <../guide/workspaces>` to require 2768MB of memory and 2 cores. Sessions will not be
provisioned if the minimum resources requirements on the {term}`Agent` are not met.
Storage requirements are related directly to using the default set of Workspaces optionally downloaded during installation. 

Kasm can only assess the available storage space within the volume where the default docker directory (/var/lib/docker) exists. If you have unallocated free space in a different volume and want to use it for Kasm, you can extend your root volume to incorporate this unallocated space. If not enough space is available in Docker's storage directory (default /var/lib/docker) this can potentially block the entire installation and lead to undesired behavior. Please review the partition layout for the host operating system and ensure this requirement is met. When using a custom set of Workspaces this storage requirement can vary.

<iframe src='https://www.youtube.com/embed/lv85XZ8EdjY' frameborder='0' allowfullscreen></iframe>



```{include} /install/swap_warning.md
```


(docker-versions)=

## Docker and Docker Compose

During the installation, the installer will install known compatible versions of {code}`docker` and
{code}`docker compose` if the programs do not already exist on the machine. However, if the programs already exist,
the installer will not replace them.

It is recommended that you install Kasm on a single-purpose machine and let the installer install the {code}`docker` and
{code}`docker compose` programs. Below are the minimum requirements.

```{eval-rst}
.. table:: **Minimum Version Requirements**
    :widths: 100,100

    +----------------------+------------+
    | **docker**           | > 18.06    |
    +----------------------+------------+
    | **docker compose**   | > 2.1.1    |
    +----------------------+------------+
```

Run the following commands to check the versions of the programs if installed.

```bash
sudo docker --version
sudo docker info | grep "Docker Compose"
```

# End User Requirements

End-users access the Kasm Workspaces via the web ui. Most modern browsers are supported.

```{eval-rst}
+--------------------------+
| **Browsers**             |
+--------------------------+
| Chrome 72+               |
+--------------------------+
| Edge 80+                 |
+--------------------------+
| Firefox 75+              |
+--------------------------+
| Safari 14+               |
+--------------------------+
```

**Caveats**

- Audio is not supported on mobile browsers.
- Seamless Clipboard ( Copying and Pasting without using the control panel ) is only supported on Chrome and Chromium-based client browsers.