Skip to content

Docker

The complete ControlGuard vX solution can be deployed using Docker.

We provide several Docker images to accommodate different deployment scenarios:

  • All-in-one standalone image that bundle every components and modules.
  • Individual component images available separately for the engine, connectors, the captive portal, and other modules.

This flexibility allows you to choose the deployment approach that best fits your environment and needs.

Prerequisites

For a Docker based installation, the following prerequisites must be met:

Downloading Docker Files

Go to the Software Downloads Portal, select ControlGuard, then choose ControlGuard vX for Docker. Follow the provided link to download the latest version of the container image file.

Additionally, download and save the Docker Compose Package on your installation host.

Container Image Installation

To import the container image into Docker, use the docker load command:

docker load --input ControlGuard-vX-2025.20.0240b1-docker-x64.tar.gz

Replace the filename with the exact name of the tarball you downloaded. After the import completes, verify that the image has been loaded successfully by running:

docker images

Starting ControlGuard vX

To start the ControlGuard vX services, we leverage Docker Compose, a docker client enabling easy management of docker containers.

Extract the downloaded Docker Compose Package to the /opt/controlguard directory:

mkdir -p /opt/controlguard
mv ControlGuard-vX-2025.20.0240b1-docker-compose-x64-tar.bz2 /opt/controlguard/
cd /opt/controlguard
tar -xvjf ControlGuard-vX-2025.20.0240b1-docker-compose-x64-tar.bz2

Then start the services in detached mode:

docker compose up -d

The containers will be created and the ControlGuard services will start automatically.

Setup Wizard

Upon the first launch of the containers, the initial configuration must be performed through a web-based setup wizard accessible at: https://<DOCKER-HOST-IP>:8443

Replace <DOCKER-HOST-IP> with the actual IP address of your Docker host.

Accessibility Delay

After starting the containers, the web interface and setup wizard may take several minutes to become fully accessible. Please wait 1–3 minutes before attempting to access the web interface.

Log in to the setup wizard using the default credentials:

  • Username: admin
  • Password: controlguard

Follow the instructions to complete the initial configuration. During the process, you will be required to change the administrator password and will have the option to modify the containers hostnames, the DNS settings, and other parameters.

After completing the wizard, the containers will automatically restart to apply the new configuration.