Installation Guide

Kublr-in-a-Box is a simple and convenient demo version of Kublr, running in Docker, that allows you set-up Kubernetes clusters. You can also use Kublr-in-a-Box to install a non-production licensed version of the full Kublr Platform.

Please register at kublr.com to receive your Kublr license and instruction how to run by email.

By using and downloading Kublr-in-a-Box and Kublr, you agree to the Terms of Use and Privacy Policy.

Important information about Kublr-in-a-Box

Kublr-in-a-Box is lightweight tool for running demo or limited-functionality Kublr inside a Docker container. It could be used to:

  • Manage a standalone Kubernetes cluster;
  • Manage a fully featured Kublr Platform;

Kublr-in-a-Box stores all data about the created clusters inside the Docker container. If you delete the Docker container, you will lose all data about the created clusters and Kublr platforms. You will not lose the cluster and platform itself. The Kublr team recommends using Kublr-in-a-Box to check that a Kubernetes cluster can be created in your environment, and as a trial before creating a fully featured and durable Kublr Platform, in any cloud or on-premise environment, with a full power Kublr platform to manage your Kubernetes clusters.

Prerequisites for Kublr-in-a-Box Installation

  1. Download and install Docker
  2. 64-bit operating system to run Kublr-in-a-Box
  3. To deploy a Kubernetes cluster or the full Kublr Platform, you’ll need an AWS, Azure, GCP account or an on-premise environment. For more details, check out our Quick start

Running Kublr

Open terminal and launch following command:

sudo docker run --name kublr -d --restart=unless-stopped -p 9080:9080 -e KUBLR_LICENSE=<KublrLicense> kublr/kublr:1.11.1
  • KublrLicense is provided in an email, upon registration. To register: kublr.com;
  • KublrVersion is provided in an email, or check the latest version Releases;
  • HOST_PORT is a port available both on you workstation for the browser and available outside, from the network;

Kublr UI will be available on http://localhost:9080 (admin/kublrbox)

If you are going to set up a bare metal cluster on the Kublr platform, please add this additional parameter KUBLR_HOST, where HOST_IP is external and available from the network IP address workstation which is being used to run Kublr-in-a-Box:

sudo docker run --name kublr -d --restart=unless-stopped -p HOST_PORT:9080 -e KUBLR_HOST=HOST_IP:HOST_PORT -e KUBLR_LICENSE=<KublrLicense> kublr/kublr:KublrVersion

If you have already started Kublr-in-a-Box without the option KUBLR_HOST or your IP address has been changed (for example to switch networks), please this command to correct the KUBLR_HOST:

docker exec -i kublr /bin/bash -c 'echo "KUBLR_HOST=HOST_IP:HOST_PORT" > /ip.external'; docker restart kublr

Kublr UI

By default, Kublr UI, Keycloak UI and API will be available on the exposed port 9080. After the Docker image is downloaded, it will take less than a minute for Kublr to start and be viewable.

If you use KUBLR_HOST to define the public IP address and public port number of the host running Kublr (e.g., then run this command:

sudo docker run --name kublr -d --restart=unless-stopped -p HOST_PORT:9080 -e KUBLR_HOST=HOST_IP:HOST_PORT -e KUBLR_LICENSE='KublrLicense' kublr/kublr:KublrVersion

Navigate to the following URLs:

Questions? Suggestions? Need help? Contact us.