# KCM License

Starting with Keeper Connection Manager version 2.19, customers are required to obtain a license key from Keeper in order to continue the use of the application.

{% hint style="warning" %}
Before installing KCM 2.19 or newer versions, please ensure you have a valid license key. **Without a valid license key, users and administrators will be unable to use KCM after the update is applied**
{% endhint %}

### KCM License Requirements

Prior to obtaining a KCM license key, the following are required:

* [KeeperPAM License](https://www.keepersecurity.com/privileged-access-management/) or
* [Keeper Business](https://www.keepersecurity.com/business.html) or [Keeper Enterprise](https://www.keepersecurity.com/enterprise.html) license with the KCM On-Prem Add-on

### Obtaining License Key 

To obtain the KCM License Key:

1. Log on to the Keeper Admin Console
2. Navigate to the Connection Manager Tab 
3. Click on "On-Prem License Key"

<figure><img src="https://3357255970-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fb7weUpu7VBcMnESSH8vG%2Fuploads%2FYMPR0PcycCwheoy1GSy7%2FScreenshot%202025-02-15%20at%2010.34.14%E2%80%AFPM.png?alt=media&#x26;token=e8c9b644-2963-4a8a-a0d1-b577cf91135d" alt=""><figcaption><p>On-Prem License Key</p></figcaption></figure>

A new license key will be automatically generated and displayed on your screen:

<figure><img src="https://3357255970-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fb7weUpu7VBcMnESSH8vG%2Fuploads%2FytuK9HtX5mBtnJOIAPCi%2FScreenshot%202025-02-15%20at%2010.34.22%E2%80%AFPM.png?alt=media&#x26;token=a816474e-0829-410f-89af-4e1c75d3d406" alt=""><figcaption><p>License Key Download</p></figcaption></figure>

### Installing License Key

To install your license key, follow the steps below:

#### New Customers&#x20;

During the installation process, you will be prompted to input the license key.

#### Existing Customers

If using the [Auto Docker Install](/keeper-connection-manager/installation/auto-docker-install.md) or [Docker Compose](/keeper-connection-manager/installation/docker-compose-install.md) Install method, simply update the `keeper/guacamole` container definition with the license as the value of the **`KCM_LICENSE`** environment variable.

<figure><img src="https://3357255970-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fb7weUpu7VBcMnESSH8vG%2Fuploads%2Fqz3m0Ps8K8QtuKdue2WZ%2FKCM_LICENSE_1.gif?alt=media&#x26;token=76952c14-8e12-4443-8114-65884fd1d783" alt=""><figcaption><p>How to add your KCM license key to your docker-compose.yml</p></figcaption></figure>

Example:

```
    guacamole:
        image: keeper/guacamole:2
        restart: unless-stopped
        environment:
            ACCEPT_EULA: "Y"
            .
            .
            .
            KCM_LICENSE: "XXXXXXXXXXXXXXXXXXXXXXXXXX"
        volumes:
            - "common-storage:/var/lib/guacamole:rw"
```

* (Optional) If the license will be present within a file in your container, you may alternatively use the **`KCM_LICENSE_FILE`** environment variable to point to that file.
* (Optional) If using the RPM packages, you must provide the license as the sole contents of `/etc/guacamole/kcm.license`, which must be readable by the guacamole group.

After adding the license key, restarting the container is necessary. If using the Auto Docker Install method, simply run:

```
sudo ./kcm-setup.run apply
```

### Troubleshooting&#x20;

If you need assistance, you can contact Keeper Support at: <https://www.keepersecurity.com/support.html>

Upon request, Keeper staff will generate your KCM on-prem license key. Once generated, the key can be accessed directly from the Keeper Admin Console.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keeper.io/keeper-connection-manager/installation/license-key.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.