Velrix documentation

Install Velrix, run your first app and virtual machine, and operate the platform day to day.

Start here

What Velrix is

The platform in five minutes: what runs on it, who uses it and the words you will meet.

Install from USB

From an empty server to a running installation, with the realm key kept in your safe.

Your first app

Deploy a container from an image, watch it start, read its logs and give it a disk.

Your first VM

A Linux or Windows Server machine from the catalogue, with its screen in a browser window.

Find your way

  • Get started takes you from nothing to a running installation, an app and a virtual machine.
  • Concepts explains the few ideas the rest of the docs build on.
  • Guides for users cover the everyday work: apps, machines, volumes, stacks and more.
  • Guides for operators cover running the platform: updates, availability, federation and licensing.
  • Reference has the velrix command, and says where the HTTP API, Terraform, Ansible and MCP are documented: in your realm’s Docs window.
  • Security and compliance explains the cryptography and the support for GDPR and NIS2.

Press K on any docs page to search.