docs(run-a-node): the apt package ships dign, runs as root, and can install without joining - #83
docs(run-a-node): the apt package ships dign, runs as root, and can install without joining#83MichaelTaylor3d wants to merge 1 commit into
Conversation
…nstall without joining Co-Authored-By: Claude <noreply@anthropic.com>
|
Closing as not planned — this change was wrong, and I wrote it while fixing DIG-Network/dig-node#316 and #317, on the assumption that the
So both "corrections" in this PR were regressions: the page's The lint test's comment says exactly this and I did not read it before editing. That test is doing its job precisely as designed. What is genuinely still missing here is different, and belongs to apt.dig.net rather than to this repo: its package sets no No docs change is needed here today. The version bump goes with it. |
Brings
docs/run-a-node/apt.mdin line with what the apt package actually installs and does.Companion to DIG-Network/dig-node#359, which closes DIG-Network/dig-node#316 and
DIG-Network/dig-node#317. Filed together because a docs page that describes the old package is the
half-migrated state those tickets exist to remove.
Two things this change makes true
dign. dig-node#316 —dignis the name used everywhere, and until nowthe
.debshipped onlydig-node, so a reader following any documenteddign …command gotcommand not found. The page now says both names ship and are interchangeable, and warns aboutthe
n:digalone is Ubuntu's unrelated DNS lookup tool./etc/dig-node/no-autostartmarker and the/etc/dig-node/dig-node.envsettings file, for anyonestanding up a private or isolated network. It is explicit that
DIG_BOOTSTRAP_PEERS=offiswritten
offrather than empty, because an empty value can arrive as unset and an unset valuemeans "use the public peers" — the node then quietly joins the public network while looking
configured.
Two pre-existing errors, fixed while here
Both were found by reading the page against the shipped unit file and dig-node's
SPEC.md, and bothare user-visible, so they are fixed rather than filed.
dig-node.service; the unit the package installs isnet.dignetwork.dig-node.service. Everysystemctlandjournalctlexample on the page —status, restart, stop, disable, edit — therefore failed for a reader who copied it. All are
corrected.
dig-nodesystem account — never root". It runs as root: the shipped unit sets noUser=,and
SPEC.mdstates the systemd/launchd services run as root precisely so/var/lib/dig-nodecan be root-owned
0700and keep the control token unreadable by other local users. A docs pagethat understates the privilege a service holds is worse than one that says nothing, so this now
states the real model and why it is that way.
Verified
The unit name, the root execution and the marker behaviour were all measured on a real Ubuntu 24.04
host in dig-node#359, installing a package built from the 0.149.0 release binary — not read off the
source. Evidence is on DIG-Network/dig-node#316 and DIG-Network/dig-node#317.
Version bumped
0.17.1→0.18.0(minor: new documented capability).