### Shell: Make KCM Installer Executable

Source: https://docs.keeper.io/keeper-connection-manager/installation/auto-docker-install

This command uses chmod to grant execute permissions to the downloaded KCM setup file ('kcm-setup.run'). This is a necessary step before the installer can be run on the system.

```shell
chmod +x kcm-setup.run
```

--------------------------------

### Shell: Run Keeper Connection Manager Installer

Source: https://docs.keeper.io/keeper-connection-manager/installation/auto-docker-install

This command executes the Keeper Connection Manager (KCM) setup script using sudo, which provides administrative privileges. This is the primary command to initiate the installation process.

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

--------------------------------

### New Machine Installation Setup

Source: https://docs.keeper.io/en/llms-full.txt/1

Commands to set up KCM containers on a new machine. It exports an image pattern and then executes the kcm-setup.run script with elevated privileges. A license key will be prompted.

```bash
export KCM_SETUP_IMAGE_PATTERN="keepersecurityinc/%s-dev"
sudo -E ./kcm-setup.run
```

--------------------------------

### Enable Verbose Logging in KCM Setup

Source: https://docs.keeper.io/en/llms-full.txt/1

This snippet demonstrates how to enable verbose logging for the kcm-setup.run script. The KCM_SETUP_DEBUG environment variable can be set to a file path to redirect output, or left unset to print to the terminal. This is useful for debugging installation and setup processes.

```shell
export KCM_SETUP_DEBUG=/path/to/file
sudo -E ./kcm-setup.run
```

--------------------------------

### Inspect Docker Containers with kcm-setup.run Script (Auto Docker)

Source: https://docs.keeper.io/en/llms-full.txt/1

These commands help inspect the running Docker containers for KCM when using the Auto Docker Install method. They allow you to list processes within the Docker Compose setup and view general Docker processes.

```bash
sudo docker-compose -p "kcm" -f /etc/kcm-setup/docker-compose.yml ps
sudo docker ps
```

--------------------------------

### Shell: Install and Enable Haveged for Entropy

Source: https://docs.keeper.io/kcm-linux-rpm-method/installation/advanced-linux-install

This sequence of commands installs the 'haveged' package, which generates additional entropy for the system's random number generator. It then starts the 'haveged' service and configures it to launch automatically on system boot.

```shell
sudo yum install epel-release
sudo yum install haveged
sudo systemctl start haveged
sudo systemctl enable haveged
```

--------------------------------

### Shell: Download Keeper Connection Manager Installer

Source: https://docs.keeper.io/keeper-connection-manager/installation/auto-docker-install

This command downloads the Keeper Connection Manager (KCM) setup executable file from the specified URL using curl. The '-O' flag ensures that the file is saved with its original name in the current directory.

```shell
curl -O https://keepersecurity.com/kcm/kcm-setup.run
```

--------------------------------

### Update Docker Compose File for Existing Installation

Source: https://docs.keeper.io/en/llms-full.txt/1

Configuration snippet for the docker-compose.yml file, showing example image replacements and the addition of 'shm_size' and 'security_opt' for the guacd service. It also shows how to set the KCM_LICENSE environment variable.

```yaml
version: "3"
services:
  guacd:
    image: keepersecurityinc/guacd-dev
    restart: unless-stopped
    shm_size: 2007372k
    security_opt:
      - "seccomp:/etc/kcm-setup/guacd-docker-seccomp.json"
    ...
  db:
    image: keepersecurityinc/guacamole-db-mysql-dev
    ...
  guacamole:
    image: keepersecurityinc/guacamole-dev
    restart: unless-stopped
    ...
    environment:
      KCM_LICENSE: "XXXXXXXXXXXXXX"
    ...
  ssl:
    image: keepersecurityinc/guacamole-ssl-nginx-dev
```

--------------------------------

### Shell: Start and Enable Guacamole Services

Source: https://docs.keeper.io/kcm-linux-rpm-method/installation/advanced-linux-install

These commands start the 'guacd' and 'guacamole' services and configure them to start automatically when the system boots. Guacamole is a clientless remote desktop gateway.

```shell
$ sudo systemctl start guacd guacamole
$ sudo systemctl enable guacd guacamole
```

--------------------------------

### View KCM Logs with docker-compose (Custom Docker)

Source: https://docs.keeper.io/en/llms-full.txt/1

For KCM installations using the Custom Docker Install method, these commands demonstrate how to view logs for specific services using docker-compose.

```bash
sudo docker-compose logs guacd
sudo docker-compose logs guacamole
sudo docker-compose logs db
sudo docker-compose logs ssl
```

--------------------------------

### Install python3-pip on CentOS/RHEL

Source: https://docs.keeper.io/en/llms-full.txt/1

Commands to install the 'python3-pip' package on CentOS/RHEL systems. This is required to install Python packages using pip.

```bash
sudo dnf install python3-pip
```

```bash
sudo yum install python3-pip
```

--------------------------------

### Install Python Modules for Database Connection

Source: https://docs.keeper.io/en/llms-full.txt/1

Installs necessary Python modules for connecting to MySQL or PostgreSQL databases and for handling YAML files. 'mysql-connector' or 'psycopg2-binary' is required for database interaction, and 'pyYAML' is for YAML parsing.

```bash
pip3 install mysql-connector
pip3 install pyYAML
```

```bash
pip3 install psycopg2-binary
pip3 install pyYAML
```

--------------------------------

### Install Python Pip for CentOS/Ubuntu

Source: https://docs.keeper.io/en/llms-full.txt/1

Installs the Python 3 pip package manager on CentOS and Ubuntu systems. Pip is required to install Python libraries needed by the export script.

```bash
sudo yum install python3-pip
```

```bash
sudo apt install python3-pip
```

--------------------------------

### Example CSV Format for Connection Import

Source: https://docs.keeper.io/en/llms-full.txt/1

Demonstrates the structure of a CSV file for importing connections into Keeper Connection Manager. It includes essential fields like connection name and protocol, along with optional fields for group, users, and encryption.

```csv
name,protocol,username,password,private-key,hostname,group,users,groups,guacd-encryption (attribute)
conn1,vnc,alice,pass1,,conn1.web.com,ROOT,guac user
```

--------------------------------

### Apply Docker Compose Changes

Source: https://docs.keeper.io/en/llms-full.txt/1

Commands to apply updates to the Docker Compose configuration. The first command is for the auto-docker install script, while the second is for a standard Docker Compose installation.

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

```bash
docker compose up -d
```

--------------------------------

### Example Output for Listing Secrets

Source: https://docs.keeper.io/secrets-manager/secrets-manager/quick-start-guide

Demonstrates the expected output format when listing secrets using the `ksm secret list` command, showing UID, Record Type, and Title for each secret.

```text
UID                     Record Type          Title
----------------------- -------------------- ---------------
bf3dg-99-JuhoaeswgtFxg  login                My Secret
3FXqmP5nFKwju0H8pl0DmQ  databaseCredentials  MySQL Credentials
```

--------------------------------

### Database Setup for Guacamole

Source: https://docs.keeper.io/kcm-linux-rpm-method/installation/advanced-linux-install

This section describes the database setup required for the Apache Guacamole web application. The database is used for authentication and storing application data. Specific database technologies are not detailed here, but the context implies a relational database is needed.

```text
A database, used by the Guacamole web application for authentication and storage.
```

--------------------------------

### Shell: Install Keeper Connection Manager

Source: https://docs.keeper.io/kcm-linux-rpm-method/installation/advanced-linux-install

This command installs the Keeper Connection Manager (KCM) package using YUM. It assumes the Keeper Security repository has already been added to the system.

```shell
$ sudo yum install @kcm
```