KLYRN
Install Free

    All documentation
    1. Home
    2. Docs
    3. Quickstart

    Quickstart

    A fresh Ubuntu 24.04 VPS and an SSH login are the only things this page assumes. No account anywhere, no licence key, no card. Eight steps, in the order they happen; each links to the page that explains it properly.

    What you need

    A server
    Ubuntu 24.04 LTS on x86_64, freshly installed, with root over SSH. 1 GB of RAM and 10 GB of free disk; ports 80, 443 and 7443 free; outbound HTTPS working. The installer refuses a server that already carries another panel, Apache, or an nginx or MariaDB it did not configure. Requirements
    A domain
    One you can add an A record to. Let's Encrypt will not issue a certificate until the name points at the server. Nothing else about the domain matters yet.
    Nothing else
    No account at my.klyrn.com and no licence key. An install with no key runs the Free edition: one server, five sites, everything except reseller accounts. A key is optional, and step 8 says what it adds.

    The eight steps

    1. Install As root. The bootstrap checks the platform, verifies the download's SHA-256 and the manifest's signature, then hands over to eleven stages that each verify their own result. The first clean run on a 3-vCPU, 5.9 GB VPS took 53 seconds.
      curl -fsSL https://get.klyrn.com | sudo bash
      Install
    2. Create the first administrator The installer's last lines are the panel address and a one-time setup token. Open https://<your-ip>:7443, accept the certificate warning (the panel is self-signed until step 4, and this is the only point at which the warning is expected), paste the token, create the account. The setup endpoint stops answering the moment the administrator exists. First setup
    3. Turn on two-factor sign-in Now, before the panel has anything worth reaching. Account → Two-factor sign-in: scan the code with any TOTP app, confirm one code, save the eight recovery codes. They are shown once. Signing in
    4. Give the panel a hostname Point panel.example.com at the server, then klyrn panel hostname panel.example.com. The self-signed certificate is replaced by a real one and the browser warning goes away for good. Panel hostname
    5. Point your domain at the server An A record for the name, and for www if you use it, at whoever holds your zone. KLYRN is not a nameserver. If Cloudflare already holds the zone, connect it once and klyrn dns point example.com writes the records itself. DNS
    6. Create the site One button, or one command. The hosting account, its Unix user, the PHP-FPM pool, the nginx server block, the database, WordPress and the certificate are one job.
      klyrn site create example.com --type wordpress --admin-email you@example.com
      Sites
    7. Let HTTPS arrive Nothing to do. The certificate is requested when the site is created and renewed 30 days before expiry. If the name does not resolve here yet, the site is served over HTTP and the certificate is retried every ten minutes; klyrn dns check example.com says what the name resolves to now. Certificates
    8. Set a backup schedule A backup counts only after the archive is listed back and every checksum in its manifest matches. Add an off-site destination too, so a lost disk is not a lost site.
      klyrn backup schedule example.com daily --keep 7
      Backups

    Fifteen minutes is the hands-on time, not a guarantee. The install is measured at 53 seconds and the panel steps take a couple of minutes each. The one thing outside anybody's control is DNS: a certificate cannot be issued until the name resolves to this server, and how long that takes is your provider's answer, not KLYRN's.

    A licence key, if you want one

    The server is already running the Free edition. A Free key from my.klyrn.com adds one thing: the server appears on your account there, with its version and health, and that is where a paid licence will be activated when the paid editions go on sale. Nothing your server hosts depends on the licence check afterwards. If licensing is unreachable, sites, backups and renewals carry on. 

    klyrn license activate <key>
klyrn license status

    Activating a licence

    Where to go next