---
myst:
  html_meta:
    "description lang=en": "How to purchase and configure a License for Kasm Workspaces."
    "keywords": "Kasm, Licensing, Registration, Sales, Enterprise"
    "property=og:locale": "en_US"
---
```{title} Licensing
```

# Licensing

Kasm Workspaces Community edition is free to download and install for testing, non-profits and non-commercial activities. It is limited to 5 concurrent sessions and community support via our public issue tracker.

Pricing for Kasm Workspaces Professional and Enterprise tiers are available in two licensing models.

- **Per Named User**
  This license agreement is based upon the number of users registered in the system. This agreement is best for a fixed
  number of high volume users as they will always have access to a kasm provided the server resources are available.
- **Per Concurrent Session**
  This license agreement is based upon the number of sessions run at one time. These licenses are slightly more expensive as they
  do not have a limit on users but are best for situations when many users may need access to sessions but at separate times or not on a regular basis.

For pricing and feature lists please visit [kasmweb.com](https://www.kasmweb.com/pricing.html)

## Buying a License

There are two ways to purchase a Kasm Workspaces license.

1. For most purchasing needs you can use our [checkout process](https://kasmweb.com/checkout.html) which will provide you with an instant {term}`Activation Key <Activation Key>`.

2. Select the Version, License Type and Number of Users and click **CHECKOUT**

```{figure} /images/licenses/checkout.webp
:align: center
:class: has-border
**Checkout**
```

3. After entering your email click **SEND EMAIL VERIFICATION**

```{figure} /images/licenses/checkout2.webp
:align: center
:class: has-border
**Email Verification**
```

4. Kasm Technologies will send you an email with a one time code to verify your email address.

5. Enter the One time code in the space provided and the credit card information section will appear to complete your purchase.

```{figure} /images/licenses/checkout3.webp
:align: center
:class: has-border
**One Time Code**
```

6. Enter your credit card information view and accept the EULA and click **COMPLETE CHECKOUT**

```{figure} /images/licenses/checkout4.webp
:align: center
:class: has-border
**Complete Checkout**
```

1) If you require an invoice for your companies purchase process you can request a [quote](https://kasmweb.com/quote.html)

```{figure} /images/licenses/request_quote.jpg
:align: center
**Request a Quote**
```

(add-license)=
## Adding A License

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

To license an existing Kasm Workspaces installation you will need the activation key that was provided when purchasing your Kasm Workspaces license.

### Getting the license key for an offline Kasm Workspaces installation

If you are licensing an offline Kasm Workspaces installation you will need to use our online activation tool [Kasm Workspaces activation tool](https://kasmweb.com/activate.html) to obtain a {term}`License Key <License Key>` before continuing.

1. First retrieve your {term}`Activation Key <Activation Key>` received at the time of purchase.

2. Second you will need your {term}`Installation ID <Installation ID>`, which can be found from the Kasm Workspaces installation.

   1. Navigate to the {term}`web application <Web Application>`.

   2. Navigate to **Diagnostics** -> **System Info** and locate the entry for **Installation ID**.

```{figure} /images/licenses/installation_id.webp
:align: center
**Installation ID**
```

3. Navigate to [Kasm Workspaces activation tool](https://kasmweb.com/activate.html).

```{figure} /images/licenses/activate1.webp
:align: center
:class: has-border
**Activation**
```

1. Paste in the {term}`Installation ID <Installation ID>` and the {term}`Activation Key <Activation Key>`.
2. Click **Submit**.

```{figure} /images/licenses/activate2.webp
:align: center
:class: has-border
**Activation Complete**
```

### Licensing the Kasm Workspaces installation

1. Navigate to the {term}`web application <Web Application>`.

2. Navigate to **Diagnostics** -> **System Info** -> **Licenses** tab.

3. Select **Add License** from the Licenses tab.

```{figure} /images/licenses/license_card.webp
:align: center
**Licenses**
```

4. Copy the {term}`Activation Key <Activation Key>` or {term}`License Key <License Key>` into the box and click **Add**.

```{figure} /images/licenses/add_license.webp
:align: center
**Adding a License**
```

5. The license information will be shown in the Licenses Card.

```{figure} /images/licenses/complete_license.webp
:align: center
**Activated License**
```

## Programmatically applying a license

In heavily devops focused environments, it may be desired to programmatically apply licenses to new or existing deployments of Workspaces.
The following processes are applicable to systems that have online access to contact the Kasm license servers: `https://license.kasmweb.com`. 

### Programmatically apply a license during install

The following steps can be taken to activate a deployment during installation. If the deployment is
a multi-server installation, this process should be used when installing the **Database Role**. 
See {ref}`Multi-Server Installtion Guide <multi-server-steps>` for more details.

1. Save the **Activation Key** to a file on the deployment server (e.g `/tmp/activation_key.txt`)

2. During the install, add the `--activation-key-file` argument using the location of the activation key file.

```Bash
sudo bash /tmp/kasm_release/install.sh --activation-key-file /tmp/activation_key.txt
```

3. To verify the key was successfully applied, log into the Kasm UI as an administrator.

4. Navigate to **Diagnostics** -> **System Info** -> **Licenses** tab.

5. The license should be visible.

```{figure} /images/licenses/complete_license.webp
:align: center
**Activated License**
```


### Programmatically apply a license after install

The following steps can be used to license an exiting deployment with an **Activation Key**. This process involves utilizing
the {ref}`Licensing Developer API Endoints <devapi-license>`.

1. Log into the Kasm UI as an administrator.

2. Select **Settings** -> **Developers** and click **Add API Key**. Fill out the form to generate an API_KEY and API_KEY_SECRET.

3. Using your preferred method, create a call to the {ref}`/api/public/activate <devapi-license>`. `curl` is shown below:

```Bash
curl -X POST -H "Content-Type: application/json" -d '{
    "api_key": "{{api key}}",
    "api_key_secret": "{{api key secret}}",
    "activation_key": "-----BEGIN ACTIVATION KEY-----eyJ0eXAiOiJ-----END ACTIVATION KEY-----"
}' https://<kasm.server>/api/public/activate
```

````{note}
Kasm partners may be issued special **Activation Keys** that allow for the `seats` and `issued_to` flags in be used in this call.

When an **Activation Key** is purchased, its entitlement has a high water mark of **seats** (e.g 100 concurrent users or 500 concurrent sessions) for example. 
If desired, these seats can be split among multiple Workspaces installtions. For example, one deployment may be licsed for 25 concurrent users, and another 40 concurrent users.
The `issued_to` field is informational and may be helpful to attribute the license key in later reporting.

To achieve this, administrators can specify the number of seats in the API call.

```Bash
curl -X POST -H "Content-Type: application/json" -d '{
    "api_key": "{{api key}}",
    "api_key_secret": "{{api key secret}}",
    "seats": 10,
    "issued_to": "Environment X"
    "activation_key": "-----BEGIN ACTIVATION KEY-----eyJ0eXAiOiJ-----END ACTIVATION KEY-----"
}' https://<kasm.server>/api/public/activate
```

Administrators can use the API multiple times to add more seats to an existing deployment.

````

4. To verify the key was successfully applied, log into the Kasm UI as an administrator.`.

5. Navigate to **Diagnostics** -> **System Info** -> **Licenses** tab.

6. The license should be visible.

```{figure} /images/licenses/complete_license.webp
:align: center
**Activated License**
```