Skip to content

Docs: the system-mode upgrade steps give only the systemd commands, not macOS's launchd ones #701

Closed

Description

@LoopGlitch26

Split out of #464, whose items can each be fixed on their own.

docs/deploy.md's upgrade steps for laptop system mode (lines 158-166) stop and restart the signer with systemctl:

1. Stop the signer: `sudo systemctl stop tracekit-signer` ...
4. Add your lines back to `/etc/tracekit/signer.yaml`, then `sudo systemctl restart tracekit-signer` ...

macOS system mode (--experimental-macos) runs the signer under launchd, not systemd, so those commands fail there.
Init writes /Library/LaunchDaemons/dev.tracekit.signer.plist and then boots it out and bootstraps it
(tracekit/install.py:1636-1641, label V2_LABEL = "dev.tracekit.signer" at tracekit/install.py:106). With
--harness, the helper is dev.tracekit.harness-helper (HELPER_LABEL, tracekit/install.py:186), booted out and
bootstrapped the same way (tracekit/install.py:201-211).

Task:

  1. In steps 1 and 4 of docs/deploy.md (lines 160-166), give the macOS form next to the systemd one: stopping the
    signer with sudo launchctl bootout system/dev.tracekit.signer (and, when --harness is used, the helper with
    sudo launchctl bootout system/dev.tracekit.harness-helper, as step 1 stops it on Linux), and restarting the
    signer after editing signer.yaml with sudo launchctl kickstart -k system/dev.tracekit.signer. Say that init's own
    bootstrap starts the signer (and the helper) again, so step 3 needs no launchd command.
  2. Add a test to tests/test_docs.py that reads the upgrade steps and checks they name install.V2_LABEL, so the docs
    follow the label if it changes.

Done when: the steps work as written on both systems, the new test fails on main and passes with the change, and
tests/test_docs.py and make lint pass.

Comment here to claim it. Commits need a DCO sign-off (git commit -s).

Activity

  1. Siri-Durugapu commented on Nov 10, 2026

    @Siri-Durugapu
    Contributor

    I'd like to claim this issue. I'll update the upgrade instructions for both systemd and launchd, and add a regression test that checks the documented signer label against install.V2_LABEL. I'll run the focused documentation tests and lint checks before opening a PR.

  2. LoopGlitch26 commented on Nov 10, 2026

    @LoopGlitch26
    MemberAuthor

    Assigned to you, thanks. The test in step 2 should fail on main before the docs change; mention in the PR that you saw it fail.

  3. LoopGlitch26 commented on Nov 10, 2026

    @LoopGlitch26
    MemberAuthor

    Done in #703.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions