inbuxa relay: install inbuxa Relay on a machine of its own #45

Merged
jcoffey-dev merged 1 commits from relay/install into main 2026-10-31 01:11:04 +00:00
Owner

Step 6 of inbuxa Relay: the installer path.

inbuxa relay install --token - installs inbuxa Relay on a machine of its own, in front of the server:

  • Binary: the release's static inbuxa-relay-<arch>-linux-musl (inbuxa-server #271). It's checked against a SHA-256 pinned here, and against the .sig beside it, signed by one of the two inbuxa release keys (the same check the relay makes before an upgrade). It's tried with --version before it's put in place.
  • Ownership: it belongs to a new inbuxa-relay system user, in /opt/inbuxa-relay/bin, so a console upgrade can replace it. State lives in /var/lib/inbuxa-relay (0700).
  • Unit: inbuxa-relay.service, as inbuxa-server ships it in resources/systemd/, with --link-listen when one is asked for.
  • Join and start: it joins with the token as the relay's user, starts the service, and checks that the same process is still up 3 s later.
  • Refusals: a machine that runs the mail server; port 25 or the link's port already held (it names the holder); a relay that hasn't joined and has no token.
  • Re-runs converge: it keeps a binary of its release, or a newer one from the console, keeps an earlier --link-listen, and doesn't restart a relay that needs nothing.
  • relay status: the unit's state, the version, and the relay's own status.
  • relay uninstall: keeps the state; --purge resets it first, which refuses while it holds mail unless --discard-held.

RelaySHA256 is empty for now. No release has relay binaries yet, so a plain install says so. The pins PR for the first one (likely 27.1-rc.5) fills it in. Until then INBUXA_RELAY_BINARY installs a local build.

Checked

  • gofmt; vet for amd64 and arm64; unit tests; govulncheck; standard library only.
  • The signature check passes the relay's own openssl-made fixture and rejects another binary, release, target or key.
  • SemVer ordering matches the relay's.
  • e2e/cases/relay-host.sh on debian13, with the binary from a Dockerfile.relay image: 41 passed, 0 failed. It covers the refusals, install and join, user, ownership, CapEff 0x400, 443 open and 25 closed until settings arrive, status, a converge that leaves the process alone, moving --link-listen and keeping it, a held port 25, uninstall keeping state, reinstall without a token, and --purge.

Not yet exercised: a download from a real release. That waits for the first release with relay binaries.

Step 6 of inbuxa Relay: the installer path. `inbuxa relay install --token -` installs inbuxa Relay on a machine of its own, in front of the server: - **Binary:** the release's static `inbuxa-relay-<arch>-linux-musl` (inbuxa-server #271). It's checked against a SHA-256 pinned here, and against the `.sig` beside it, signed by one of the two inbuxa release keys (the same check the relay makes before an upgrade). It's tried with `--version` before it's put in place. - **Ownership:** it belongs to a new `inbuxa-relay` system user, in `/opt/inbuxa-relay/bin`, so a console upgrade can replace it. State lives in `/var/lib/inbuxa-relay` (0700). - **Unit:** `inbuxa-relay.service`, as inbuxa-server ships it in `resources/systemd/`, with `--link-listen` when one is asked for. - **Join and start:** it joins with the token as the relay's user, starts the service, and checks that the same process is still up 3 s later. - **Refusals:** a machine that runs the mail server; port 25 or the link's port already held (it names the holder); a relay that hasn't joined and has no token. - **Re-runs converge:** it keeps a binary of its release, or a newer one from the console, keeps an earlier `--link-listen`, and doesn't restart a relay that needs nothing. - **`relay status`:** the unit's state, the version, and the relay's own `status`. - **`relay uninstall`:** keeps the state; `--purge` resets it first, which refuses while it holds mail unless `--discard-held`. **`RelaySHA256` is empty for now.** No release has relay binaries yet, so a plain install says so. The pins PR for the first one (likely 27.1-rc.5) fills it in. Until then `INBUXA_RELAY_BINARY` installs a local build. **Checked** - gofmt; vet for amd64 and arm64; unit tests; govulncheck; standard library only. - The signature check passes the relay's own openssl-made fixture and rejects another binary, release, target or key. - SemVer ordering matches the relay's. - `e2e/cases/relay-host.sh` on debian13, with the binary from a `Dockerfile.relay` image: **41 passed, 0 failed**. It covers the refusals, install and join, user, ownership, CapEff 0x400, 443 open and 25 closed until settings arrive, status, a converge that leaves the process alone, moving `--link-listen` and keeping it, a held port 25, uninstall keeping state, reinstall without a token, and `--purge`. **Not yet exercised:** a download from a real release. That waits for the first release with relay binaries.
jcoffey-dev added 1 commit 2026-10-31 00:54:03 +00:00
`inbuxa relay install --token -` puts the relay a server release attaches
on this machine: the static inbuxa-relay binary, checked against a checksum
pinned here and against the inbuxa release keys' signature in its .sig
file, owned by the inbuxa-relay user so an upgrade from the console can
replace it, under inbuxa-relay.service as inbuxa-server ships it (ports 25
and 443 and nothing more). It joins with the console's token as the
relay's user, starts it, and checks it stays up.

It refuses on a machine that runs the mail server, where port 25 or the
link's port is held, and on a relay that hasn't joined without a token. Run
again it converges: it keeps a binary of its release or a newer one from
the console, and the --link-listen an earlier run set.

`relay status` is the relay's own status, as its user; `relay uninstall`
keeps its state, and --purge resets it first, which refuses while it holds
mail unless --discard-held.

RelaySHA256 is empty: no release has relay binaries yet, so the command
says so until the pins PR for the first one fills it in. INBUXA_RELAY_BINARY
installs a local build meanwhile, and e2e/cases/relay-host.sh runs with one
(RELAY_BINARY in run.sh).
jcoffey-dev merged commit 4e9ed17033 into main 2026-10-31 01:11:04 +00:00
jcoffey-dev deleted branch relay/install 2026-10-31 01:11:04 +00:00
Sign in to join this conversation.