SvavyomDocs
Development PreviewWebsite ↗
Documentation Getting started
Getting startedDevelopment Preview

Install

Get the artifact and verify it#

Download svavyom-<version>.tar.gz and its SHA256SUMS from the releases page, or build it from source. The release is not signed yet, so verify it against checksums obtained over a channel you trust.

Verify
tar xzf svavyom-<version>.tar.gz && cd svavyom-<version>
sha256sum -c SHA256SUMS
bin/svavyom-ctl verify-artifact .

Plan, then apply#

Every command that changes the host prints its plan and changes nothing until you add --apply. Read the plan first.

Install
sudo bin/svavyom-ctl install --artifact . --create-pool --tls-self-signed HOST.example \
     --enable-mutation --enable-console --backup-dir /var/lib/svavyom/backups
# read the plan, then repeat with --apply

The installer creates the service accounts and directories, installs the seven binaries, the web assets and five systemd units, and starts the services in order. It never runs a service as root, never opens a firewall port, never edits libvirt security settings and never touches existing VMs, pools or networks.

Options you will likely want#

  • --enable-mutation lets the console create and manage VMs; --enable-console allows the serial and graphical consoles. Both are off unless you ask; without them Svavyom is a read-only viewer.
  • --listen ADDR (default 0.0.0.0:8443; a non-loopback address needs TLS). For a first look use --listen 127.0.0.1:8443 with an SSH tunnel.
  • --enable-nightly-boot HH:MM runs a nightly check that creates, boots and deletes a disposable VM.
  • --network and --pool use names other than the defaults.

Reaching the console#

Use ssh -L 8443:127.0.0.1:8443 you@host and open https://127.0.0.1:8443/. A self-signed certificate triggers a browser warning; install your own certificate for anything beyond a lab.

Search the documentation

↑ ↓ to navigate · Enter to open · Esc to close

Type to search the public documentation.