KLYRN VM
Install free

5 guides · from the product's own repository

The documentation, as the product ships it.

These are the operator guides that live beside the code, published as they are. When the product changes, the guide changes in the same commit and this section is rebuilt from it.

Install How to install the KLYRN VM controller and add compute nodes: the command, the supported systems, what is installed where, and one server doing both. Networks, storage, plans Setting up KLYRN VM to sell machines: a network and its address pools, storage, plans with traffic allowances and backup schedules, and customers. Losing the controller What KLYRN VM keeps and where, what to do before anything goes wrong, and how to rebuild the controller on a new machine without touching a guest. Integrations How KLYRN VM connects to Prometheus and Grafana, signed webhooks for Slack, Discord and n8n, reverse DNS through PowerDNS, and billing. HTTP API The KLYRN VM controller API: authentication, machines, nodes, networks and address pools, tasks, and the provisioning API a billing system drives.

Prefer to watch? Six video guides

Where to start

The guides in the order a new provider needs them.

  1. Install. One command for the controller, then a compute node: on its own server, or on the same one. The install guide lists the twelve Linux systems it is proven on and what is put where.
  2. Make it sellable. A machine needs an address, a disk, a size and an owner. Networks, storage, plans and customers covers those four in the order they have to be done, including the routed block most dedicated-server providers have.
  3. Plan for losing the controller. Machines keep running without it, but you want it back. Losing the controller says what is kept, where, and how to rebuild on a new machine.
  4. Connect what you already run. Prometheus and Grafana, signed webhooks, reverse DNS through PowerDNS and billing are in integrations.
  5. Automate. Everything the panel does is in the HTTP API, with tokens that carry only the scopes you give them and a provisioning API built for retries.

Answers that are not in a guide

Shorter reads.

Questions providers ask first Nineteen short answers: what it installs on, moving from another panel, backups, price and the licence. Moving from SolusVM 2 What stays exactly as it is, what changes, and the five steps, with no guest restarted. The WHMCS module What each button does, why a retried order cannot build twice, and what is not yet proven.

Read enough? Run it.

One command on the Linux you already run. The first compute node is free.

Install in one command Questions providers ask first