Skip to content
Lightning VMBeta

Features

Install, update and backup

Installation with one command, automatic HTTPS, updating from the panel, encrypted and signed backups, the hold after a restore, and the optional monitoring stack.

Requirements

MinimumRecommended
Operating systemUbuntu 22.04 / 24.04 / 26.04 (amd64 or arm64)Ubuntu 24.04 LTS
Memory / disk2 GB RAM, 10 GB free disk4 GB RAM, 40 GB disk (with monitoring on)
NetworkPorts 80 and 443 open to the outsideA domain whose A record points at the server

Install the panel on a separate Linux server, not on the virtualisation host itself; that server may be a virtual machine.

Installation

curl -fsSL https://lightningvm.app/install.sh | sudo sh

The command fetches the source into /opt/lightning-vm with git, selects the latest stable release and runs the installer. With your own domain:

curl -fsSL https://lightningvm.app/install.sh | sudo sh -s -- -- --domain panel.example.com

The script checks the system, installs Docker from its official repository if it is missing, generates the secrets, builds and starts the services, obtains the HTTPS certificate, and sets up monitoring and the daily backup. At the end it prints the panel's address and the first admin's credentials. If you give no domain and the server has a public IPv4 address, the panel opens under <ip>.sslip.io. The step-by-step account: What the one-line install does.

If the installation stops halfway, run the same command again; existing secrets, data and accounts are kept. The script does not touch the firewall, the SSH settings or an existing Nginx / Caddy / Traefik setup.

Updating

From the panel: Administration → System → Updates. From the command line:

sudo sh scripts/install.sh update

Every update takes an encrypted backup first; if the backup cannot be taken, nothing changes. If the new version does not become ready, the containers are rolled back to the previous version. The database is not rolled back automatically; the backup is there. An update run without a version only moves to a newer version. When you name a version explicitly (update --to v1.2.0), going back to an older one is stopped only by the migration check.

Automatic updating can be switched on and off, with a channel (stable, beta, edge) and a maintenance window. Read upgrade-notes.md (Turkish) in the repository before upgrading.

Backup

sudo sh scripts/install.sh backup

A backup contains the whole of PostgreSQL, the .env file, the master key, the certificates and the Alertmanager configuration. It is encrypted with secrets/backup.key (AES-256-CBC) and signed with the same key (HMAC-SHA256): each backup consists of NAME.tar.enc and, next to it, NAME.tar.enc.hmac. After it is written, a backup is read back and verified.

Setting (.env)DefaultMeaning
BACKUP_KEEP7How many of the newest backups are kept locally
BACKUP_COPY_TOemptyAn rsync target; the signature file is copied along with the backup
BACKUP_SCHEDULEdailyA daily backup while the scheduler is on

This backup does not contain customer VMs.

Restore and the hold

sudo sh scripts/install.sh restore backups/FILE.tar.enc --yes-replace-data

Without the confirmation option the command only checks and says what would change. A restore wants the signature file next to the backup, the backup under its original name, and the same backup.key. Unsigned backups from older versions are restored only with --allow-unsigned.

After a restore everyone is signed out and the panel starts on hold: until it is released no operation is started, schedules and scheduled deletions do not run, and collection does not run. The hold is lifted from the banner under Administration → System or with this command:

docker compose exec api node dist/cli.js release-restore-hold

Why it works this way is explained in the article Updates, backups and restore.

Monitoring

Prometheus, Grafana, Loki and Alertmanager are optional. They are switched on during installation (the script does so itself when RAM is 3.8 GB or more); afterwards they are switched on and off from the command line only:

sudo sh scripts/install.sh monitoring on

None of these components is exposed to the internet; remote access goes through an SSH tunnel.

Other commands

  • sh scripts/install.sh check: runs the pre-flight checks without changing anything.
  • sudo sh scripts/install.sh reset-password you@example.com: for an admin who has forgotten the password.
  • sudo sh scripts/install.sh domain panel.example.com: adds or changes the domain later.
  • sudo sh scripts/install.sh behind-proxy --public-url https://panel.example.com: runs the panel behind an existing proxy.
  • sudo sh scripts/install.sh uninstall: removes the services; .env, secrets/, backups/ and the data stay.

Limits

  • There is no versioned, signed installation package yet; installing and updating build from source.
  • Running on several servers (a cluster) is a design and has not been written.
  • After installation, monitoring cannot be switched on or off from the panel.
  • The installer's backup, update, domain and uninstall paths were not re-read line by line in the security review; the script's paths were tried with mock files only.

Sources: docs/setup.md, docs/operations.md, docs/updates.md, docs/domain-https.md (Turkish).

Install command

curl -fsSL https://lightningvm.app/install.sh | sudo sh

Ubuntu 22.04 / 24.04 / 26.04. Requirements and options