EFF-347: Update Linux agent install docs for step-agent package rename#524
Open
tashian wants to merge 1 commit into
Open
EFF-347: Update Linux agent install docs for step-agent package rename#524tashian wants to merge 1 commit into
tashian wants to merge 1 commit into
Conversation
The manual install instructions still referenced the old step-agent-plugin package, which the repos serve at a stale 0.63.1 that fails to run on headless systems (missing libwebkit2gtk). The agent is now packaged as step-agent (0.67.3), matching the quick-install script. Validated end-to-end in Fedora, Rocky 9, Debian stable, and Ubuntu 24.04 containers, including the systemd start flow. - Rename step-agent-plugin to step-agent in install, version check, register, and uninstall commands - Update sample version output to the current format - Drop a no-op DEBIAN_FRONTEND line from the Ubuntu steps - Enable step-agent-restart.path alongside the service, matching the quick-install script Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
tashian
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Updates the Linux manual install instructions on Install the Smallstep Agent to use the current
step-agentpackage name instead of the oldstep-agent-plugin.Why
The repos still serve
step-agent-pluginat a stale 0.63.1, which installs but fails the documented verification step on headless systems (error while loading shared libraries: libwebkit2gtk-4.1.so.0). The agent is now packaged asstep-agent(currently 0.67.3), which is what the quick-install script already uses.Changes
step-agent-plugin→step-agentin all four distro install flows (install, version check), self-registration, and uninstall commandsversionoutput updated to the current formatDEBIAN_FRONTEND=noninteractiveline from the Ubuntu stepssystemctl enable --now step-agent-restart.pathto the start section, matching the quick-install scriptValidation
Ran every command in the diff verbatim in containers: Fedora, Rocky Linux 9, Debian stable, and Ubuntu 24.04 (arm64). All four flows install
step-agent0.67.3 cleanly and pass the version check; thesystemctl daemon-reload/enable --nowflow was additionally verified in systemd-enabled Debian and Ubuntu containers (service correctly gates on/etc/step-agent/agent.yaml).Two related non-docs issues observed, flagged separately to packaging: the orphaned
step-agent-plugin0.63.1 in the repos is broken on headless systems (undeclared webkit2gtk dependency), and thestep-agentdeb postinst callssystemctlunguarded so it exits 1 in environments without systemd.🤖 Generated with Claude Code