Service Management

Auto Docker Install service management

Overview

The Auto Docker Method installs Docker and 4 containers (if you selected all options) which start up automatically after the installer completes:

  • Database (MySQL or PostgreSQL depending on selection)

  • Guacamole (Tomcat)

  • Guacd

  • SSL (NGINX)

The installer also creates a docker-compose.yml file that can be found in the filesystem:

/etc/kcm-setup/docker-compose.yml

This Docker Compose file is the configuration file which manages the multi-docker container system. If you need to make further changes to the environment, you can modify this file and restart the docker services using the kcm-setup.run script or by directly using Docker functionality.

Managing the Service

When using the Docker Simple Install method, the kcm-setup.run script can be used to manage the entire service and the underlying docker containers. The purpose of this script is to make management of the Keeper Connection Manager platform very simple.

Usage:

sudo ./kcm-setup.run [OPTIONS] [COMMAND] [ARG...]

Install, maintain, or uninstall Keeper Connection Manager automatically.

Command
Description

backup

Backup all database data to a file.

check

Perform an automated self-check of all services.

install

Install Keeper Connection Manager (DEFAULT).

logs

Display the log files from all installed services.

reconfigure

Modify the configuration of an existing KCM installation.

restart

Restart all installed services, starting any that are stopped.

restore

Restore database data from a prior backup.

start

Start all installed services that are not started.

status

Display the status of installed services.

stop

Stop all installed services that are not stopped.

uninstall

Completely remove the existing installation. This will delete all stored data in the database.

upgrade

Upgrade the existing installation by pulling the latest docker images. Your data stored in the service is retained.

apply

Strictly apply changes made externally to docker-compose.yml and do not pull new images.

Shared Volume

When using the Auto Docker Install method, a shared volume is automatically added to store file transfers and session recordings. The created volumes are located at /var/lib/guacamole/ which contains the drives and recordings.

Last updated