Installer CLI

The installer is one binary per operating system that deploys the shard side only. It never contacts the website.

Downloads and the walkthrough are Connect a game server. This page is the command surface.

The commands

Command	What it does
install	Set up the shard side: sync the overlay, install the sidecar, register its service
doctor	Diagnose an existing install
update	Move to a newer bundle
uninstall	Remove what install put there

doctor, update and uninstall are the day-two commands.

Rehearsing a run

Two mechanisms, and they answer different questions.

runicgateway-installer install --servuo /path/to/ServUO --verify

--verify writes nothing. It reports what would change — the diff against the ServUO tree — which is the right thing to run first against a shard that has players on it.

RUNICGATEWAY_STATE_DIR=/tmp/rehearsal runicgateway-installer install --servuo …

RUNICGATEWAY_STATE_DIR relocates everything the installer writes — state, data, and the sidecar binary — and suppresses service registration. That is how a full run is exercised without root, and it is what the project’s own tests use.

What an install actually does

1. Resolves a bundle — an exact, protocol-checked sidecar and overlay pair published by CI. Never “latest of each”; see Protocol versions.
2. Syncs the plugin overlay into the ServUO tree, backing up whatever it is about to overwrite.
3. Offers the opt-in patch tier.
4. Installs the sidecar and registers its service.
5. Prints four values to paste into the site’s shard screen.

Installer v0.1.0 prints an older path in step 5

It names <site>/admin/shard. The screen moved to /admin/uo/link when the shard surface became part of the uo module. Fixed in v0.1.1.

Platforms

Linux x86_64, Linux aarch64, and Windows x86_64.

macOS and Windows-on-ARM are deliberately absent: the game server and the sidecar must share a host, and no ServUO host is either.

Releases are unsigned, and SHA256SUMS is the trust anchor — verify before running. Windows will show a SmartScreen prompt, which is expected for an unsigned binary.

Why the library target is called `rgdeploy`

Windows UAC refuses to launch an unsigned executable whose name contains install (os error 740), and Cargo names test harnesses after their target. It is deliberate, and not something to tidy up.

Canonical documents

INSTALL.md is the operator guide — including Appendix A, hand deployment, for hosts that cannot run the binary — and PLAN.md is the design of record.