Quick Start

Welcome to KubeMQ!

In this guide, we’ll walk you through how to install KubeMQ into your Kubernetes cluster.

Before we can do anything, we need to ensure you have access to a Kubernetes cluster running 1.16 or later, and a functioning kubectl command on your local machine. (One easy option is to run Kubernetes on your local machine. We suggest or , but there are .)

Step 0:

Obtain KubeMQ License Key

Please visit: and register for a license token.
Wait for an email confirmation with your license Key

Step 1:

Run:

kubectl apply -f https://deploy.kubemq.io/init

kubectl apply -f https://deploy.kubemq.io/key/<license-key>

Run with default configuration:

docker run -d -p 8080:8080 -p 50000:50000 -p 9090:9090 -e KUBEMQ_TOKEN=<license-key> kubemq/kubemq

Run with configuration file:

docker run -d -p 8080:8080 -p 50000:50000 -p 9090:9090 -v $(pwd)/config.yaml:/kubemq/config.yaml -e KUBEMQ_TOKEN=<license-key> kubemq/kubemq

Step 2:

Install kubemqctl CLI tool

sudo curl -sL https://get.kubemq.io/install | sudo sh

Option 1:

Place the file under e.g. C:\Program Files\kubemqctl\kubemqctl.exe
Add that directory to your system path to access it from any command prompt

Option 2:

Run in PowerShell as administrator:

New-Item -ItemType Directory 'C:\Program Files\kubemqctl'
Invoke-WebRequest https://github.com/kubemq-io/kubemqctl/releases/download/latest/kubemqctl.exe -OutFile 'C:\Program Files\kubemqctl\kubemqctl.exe'
$env:Path += ';C:\Program Files\kubemqctl'

Step 3:

Send 'Hello World'

kubemqctl queue send my-queue hello-world

Get 'Hello World'

kubemqctl queue receive my-queue

Step 4:

Load KubeMQ Dashboard

kubemqctl get dashboard

Quick Start

Welcome to KubeMQ!

Step 0:

Obtain KubeMQ License Key

Step 1:

Step 2:

Install kubemqctl CLI tool

Option 1:

Option 2:

Step 3:

Send 'Hello World'

Get 'Hello World'

Step 4:

Load KubeMQ Dashboard

What's Next

Build & Deploy KubeMQ Components

Learn KubeMQ Basics

Learn KubeMQ Message Patterns

Get started with KubeMQ message patterns

Welcome to KubeMQ!

Step 0:

Obtain KubeMQ License Key

Step 1:

Step 2:

Install kubemqctl CLI tool

Option 1:

Option 2:

Step 3:

Send 'Hello World'

Get 'Hello World'

Step 4:

Load KubeMQ Dashboard

What's Next

Build & Deploy KubeMQ Components

Learn KubeMQ Basics

Learn KubeMQ Message Patterns

Get started with KubeMQ message patterns