KLYRN documentation

Start here

From a bare Ubuntu 24.04 server to a working panel with its first site on HTTPS. Getting started names the three paths in.

• QuickstartEight steps from the install command to a site on HTTPS with a backup schedule.
• RequirementsWhat the server needs, and what the installer refuses.
• InstallOne command, eleven stages that check, apply and verify themselves.
• First setupThe one-time token, the first administrator, the panel hostname and its certificate.

By subject

• SitesThe five site types, what creating one does, and how to change it afterwards.
• WordPressInstall, health signals, hardening, the update policy and cloning.
• WordPress stagingA real second site, and a push that backs live up first.
• DNSRecords edited at the provider that is already authoritative for the name.
• BackupsVerified archives, encrypted off-site copies, and keys that are never discarded.
• Disaster recoveryWhat was on the server that is gone, answered from the bucket.
• Hosting providersAccounts, limits, resellers, backups, suspension, and moving customers in.
• Fix a symptomTen things that go wrong, each with the command that names the cause.

Automation

The panel, the CLI and the HTTP API call one registry of typed operations. A script can do anything the panel can.

• CLI referenceEvery klyrn command group, with its real flags.
• API and webhooksTokens, scopes, the job model and the signature scheme.
• ChangelogWhat shipped, in which development build.

What this documentation covers

1.0 is the first stable release. KLYRN is installable today and free. It is new: take a backup before you move a live site onto it, and take the updates. Pro is $9 a month per server. Business and Enterprise are not on sale yet. The limitations worth knowing before you install.

KLYRN hosts mail with webmail, opens phpMyAdmin at /phpmyadmin on every site, and can be the nameserver for the domains it hosts. It does not run on arm64.