RackMarshal 1.0 installation

From release bundle to a verified local runtime.

The reference installer targets Debian/Ubuntu-compatible Linux systems using systemd, requires root privileges, and requires Python 3.11 or newer.

Prerequisites

Before you install

Reference target

Fresh-host release qualification was completed on Debian 12. The installer is written for Debian/Ubuntu-compatible systems using systemd.

Runtime

Python 3.11 or newer. On systems with apt-get, the installer can bootstrap python3 and python3-venv.

Install

Use the installer bundle.

Download rackmarshal-installer-1.0.0.tar.gz from the 1.0.0 release, extract it, enter the top-level directory, then point the installer at the wheel included in the bundle.

sudo ./scripts/install.sh \ --wheel ./rackmarshal-1.0.0-py3-none-any.whl

Use --no-start if you want installation to complete without starting RackMarshal immediately. A custom initial config may be supplied with --config; existing RackMarshal configuration is not replaced by that option.

Verify

Prove the base runtime first.

systemctl status rackmarshal-status.service systemctl status rackmarshal-notify.timer curl http://127.0.0.1:9110/health

With the default configuration, the status API listens only on 127.0.0.1:9110. The health request should return HTTP 200.

Then configure a domain

Collection is intentionally opt-in.

A base install schedules no infrastructure collectors. Set ENABLED_DOMAINS to a comma-separated subset of pve,zfs,backup,ha,hardware,mount, supply the required site configuration, and validate it before enabling collection.

rackmarshal domains rackmarshal validate-config --config /etc/rackmarshal/rackmarshal.conf rackmarshal diagnostic
Do not skip this boundary

Installation does not discover your infrastructure, copy production credentials, or automatically configure Proxmox, PBS, Home Assistant, ZFS, hardware, or mount targets.

Keep the status API on loopback unless you deliberately provide suitable network access controls. Protect integration credential files with restrictive ownership and permissions.