Skip to content

docs: install from the 0.1.0 release, and fetch the unit from its tag - #85

Merged
groupsky merged 1 commit into
mainfrom
docs/81-release-install
Oct 16, 2026
Merged

groupsky merged 1 commit into
mainfrom
docs/81-release-install

Conversation

@groupsky

Copy link
Copy Markdown
Contributor

Closes #81.

What changes

  • README, setup guide (section 2), SECURITY.md: they no longer say that there is no release. The install steps offer the release first (tarball and SHA256SUMS, checked as docs/releasing.md says, copied straight to each machine, SHA-256 checked on the broker host). Building from the source stays as the second way.
  • Section 8 (the unit): the release tarball holds only nodkey, LICENSE and README.md. The guide now says where to get the unit: from the tag of your version, on the broker host or the trusted machine, never through an agent machine. Whoever can change the unit can run a program as root on the broker host.
  • Section 13 (upgrades), step 3: a release user has no contrib/ folder, so the step downloads the unit of the new version and compares it.
  • The tag is named as refs/tags/v0.1.0 in the URLs. GitHub blocks branch names that start with refs/, so a branch named v0.1.0 cannot serve a changed unit.

The Bitwarden part (#82) follows in its own PR.

Review

A security review subagent checked it in three rounds. All links and anchors resolve. Docs only; no code changes.

The README, the setup guide and SECURITY.md still said that there is no
release. The install steps now offer the release first: download the
tarball and SHA256SUMS on a trusted machine, check them as
docs/releasing.md says, copy the file straight to each machine, and
check its SHA-256 on the broker host. Building from the source stays as
the second way.

The release tarball does not hold the systemd unit. Section 8 and the
upgrade steps in section 13 now fetch it from the tag of the version,
named as refs/tags/... so that a branch with the same name cannot serve
a changed unit, and never through an agent machine.

Closes #81
@groupsky
groupsky merged commit bbbdf59 into main Oct 16, 2026
7 checks passed
@groupsky
groupsky deleted the docs/81-release-install branch October 16, 2026 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: README, setup guide and SECURITY.md still say there is no release

1 participant