Get started

Prerequisites

• A Linux server with systemd; Docker when container workflows are used.
• A stable Rust toolchain, or a prebuilt Debian package.
• Registry and state directories; production defaults are /srv/server-registry and /var/lib/opsctl.
• Separately managed Restic/rustic credentials when executing backups.

Build from source

cargo build --release
./target/release/opsctl --version

Install on Debian:

sudo scripts/install-debian.sh ./target/release/opsctl

The installer creates the runtime user, registry/state directories, and systemd unit files. It does not automatically enable backup or governance timers.

First verification

sudo opsctl \
  --registry /srv/server-registry \
  --state-dir /var/lib/opsctl \
  install-check --json

Then validate the registry:

sudo opsctl \
  --registry /srv/server-registry \
  --state-dir /var/lib/opsctl \
  registry validate --json

Run read-only checks

opsctl status --json
opsctl doctor --json
opsctl scan --json
opsctl deploy-gates --json

These commands read state and return structured reports. They do not deploy anything.

Recommended next steps

1. Read Registry and describe the real services as source-of-truth records.
2. Read the Safety model to understand dry-run, approval, and global locking.
3. Configure Backup and recovery before any production change.