> For the complete documentation index, see [llms.txt](https://docs.keeper.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keeper.io/keeper-connection-manager/installation/auto-docker-install/service-management.md).

# 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.                          |
| version     | Print out the version of each component of your KCM instance (`db`, `guacamole`, `guacd`, `ssl`)                    |

## 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.keeper.io/keeper-connection-manager/installation/auto-docker-install/service-management.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.