Install with kmq
Keep the KubeMQ server you started with kmq: add a trial or license key, check the license, manage the server and keep kmq up to date.
This page adds a license to the server you started in Try KubeMQ. When you finish, kmq license reports that license adoption is accepted and durable and your data is unchanged. Time: about 10 minutes.
Before you start
- A server from the kmq tab of Try KubeMQ.
- A trial key or a license key: see Plans compared.
Steps
Add your license
Save the request in kubemq-private as trial-request.json. "consent": true records that you accept the trial terms and the privacy notice; an AI agent must ask you before writing it.
{ "email": "YOUR_EMAIL", "name": "YOUR_NAME", "company": "YOUR_COMPANY", "platform": "docker", "consent": true }Replace: YOUR_EMAIL, YOUR_NAME, YOUR_COMPANY — your work email, full name and company.
kmq trial request --input trial-request.jsonYou should see:
HARNESS_OUTPUT_PENDINGType the emailed code yourself, never in chat.
kmq trial verify --request YOUR_REQUEST_IDReplace: YOUR_REQUEST_ID — the request_id printed above.
You should see:
HARNESS_OUTPUT_PENDINGkmq trial claim --request YOUR_REQUEST_IDYou should see:
HARNESS_OUTPUT_PENDINGcredential is YOUR_LICENSE_REF.
Create a private folder, readable only by you, and work inside it:
mkdir -p -m 700 kubemq-privatecd kubemq-privateSave the license key as license.key in this folder. The file holds only the key, on one line, with no quotes and no KUBEMQ_LICENSE_KEY= prefix. Then make it readable by you alone:
chmod 600 license.keyThis file is a secret. Do not commit it, paste it into chat, or attach it to a support ticket.
On Windows, in PowerShell:
New-Item -ItemType Directory -Force kubemq-privateSet-Location kubemq-privateicacls . /inheritance:r /grant:r "${env:USERNAME}:(OI)(CI)F"icacls license.key /inheritance:r /grant:r "${env:USERNAME}:F"Save license.key before the last command. Use a non-administrator window.
In any shell:
kmq license import --file license.keyYou should see:
HARNESS_OUTPUT_PENDINGreference is YOUR_LICENSE_REF.
Apply it to your server
kmq deploy update --installation YOUR_INSTALLATION_ID --credential YOUR_LICENSE_REF --deadline 10mReplace: YOUR_INSTALLATION_ID — the installation_id value that kmq onboard or kmq deploy apply printed; YOUR_LICENSE_REF — the reference from step 1.
You should see:
HARNESS_OUTPUT_PENDINGData stays; the old container is kept, stopped, as kubemq-retained-….
Check the license
In the adoption object, check that state is accepted, durable is true, and the configured and accepted input hashes match. plan and license_expires_at must match your license. stop_cause must be null and over_cap must be false.
kmq licenseYou should see:
{
"server_version": "...",
"adoption": {
"configured_input_sha256": "...",
"accepted_input_sha256": "...",
"state": "accepted",
"durable": true
},
"plan": "trial",
"mode": "online",
"source": "key",
"license_expires_at": "...",
"lease_expires_at": "...",
"run_until": "...",
"over_cap": false,
"stop_cause": null
}Other states: How licensing works.
Replace the license later
Repeat steps 1 to 3 without the folder commands. If it does not show, rerun step 2 with the previous reference; see Troubleshooting. Never start a second installation to extend a license.
Manage your server
To remove the server and keep kubemq-data:
kmq deploy remove --installation YOUR_INSTALLATION_IDReplace: YOUR_INSTALLATION_ID — the installation_id value that kmq onboard or kmq deploy apply printed.
You should see:
HARNESS_OUTPUT_PENDINGUpdate or remove kmq
kmq updateYou should see:
HARNESS_OUTPUT_PENDINGUpgrade KubeMQ then updates your server.
To remove kmq, delete kmq from /usr/local/bin, ~/.local/bin or ~/bin (Windows: %LOCALAPPDATA%\Programs\kmq).
Use kmq from an AI coding agent
kmq skills installIt adds the kmq skill to .claude/skills/kmq and AGENTS.md here; --global installs it for your user (kmq CLI). A starting prompt:
Use kmq to install KubeMQ on this machine. Run `kmq schema -o json` first. Ask me before creating anything. I will type passwords and email codes myself; never ask me to paste them.If something goes wrong
- Try KubeMQ found no evaluation left. Get a reference in step 1 and run
kmq onboard --goal trial --name kubemq --credential YOUR_LICENSE_REF --pull --continue-volume --deadline 10m(firstdocker rm kubemqif needed);--goal trialruns a Docker server on any saved license, trial or paid. Replace:YOUR_LICENSE_REF— as in step 2. Then do Try KubeMQ steps 3 and 4 (kmq auth loginif an administrator exists) and step 3 here. - No email code, or a lost trial key. Run
kmq trial resend-verification --request YOUR_REQUEST_IDorkmq trial resume --request YOUR_REQUEST_ID, orkmq license recover --email YOUR_EMAILfor a lost key, then verify and claim. Replace:YOUR_REQUEST_ID,YOUR_EMAIL— as in step 1. credential_storage_unavailable. On Linux with no keyring, add--credential-backend fileto everykmq trial,kmq license,kmq deploy,kmq authandkmq onboardcommand, and checkchmod 600 license.key.docker volume rm kubemq-datasays the volume is in use. Remove thekubemq-retained-…containers withdocker rm.
Next steps
Was this page helpful?
Requirements and supported setups
Supported KubeMQ setups, Kubernetes and platform requirements, sizing, network access, artifact names and the latest-release version policy.
Install with Docker
Keep the KubeMQ server you started with Docker: add a license key with docker run, Compose or Podman, check the license and remove it safely.