docs(agent): add self-contained install guide + FAQ, fix dead cross-repo link #25

Merged

amiryahaya merged 1 commit from docs/agent-install-guide into main

2026-09-04 09:00:58 +02:00

amiryahaya commented

2026-09-04 07:41:05 +02:00

Owner

Problem

The root README's "Agent installation" section pointed to docs/AGENT_ENROLLMENT.md in the private triton repo for the "full walkthrough" — a link real customers of this public repo can't actually reach.

Fix

Adds agent/README.md — full install/enrollment/upgrade/uninstall/air-gapped walkthrough for Linux/macOS/Windows/FreeBSD, self-contained (no cross-repo links needed to complete an install).
Adds agent/FAQ.md — IP-change re-enrollment, service management, log locations, common errors, config reference.
Root README's "Agent installation" section now links to the new local docs and trims to a quick-reference command snippet.

Both new docs are adapted from the private repo's docs/AGENT_ENROLLMENT.md and docs/AGENT_FAQ.md. While porting, I found and corrected two stale/wrong points in the source FAQ rather than propagating them:

Its "install" example referenced a nonexistent https://<manage-server>:8082/install/get.ps1 endpoint instead of the real bundle-based flow this repo's own agent/get.ps1 + --bundle actually uses.
Its uninstall description claimed binaries get deleted; the real triton-agent uninstall command only stops the service and removes the service-manager registration — confirmed against the triton repo's AgentInstallSteps.vue component comment, which documents this explicitly.

Test plan

All command blocks cross-checked against the current, correct source (docs/AGENT_ENROLLMENT.md in triton, which matches the Manage Portal's own generated commands)
Internal markdown links (README.md#..., FAQ.md#..., root README.md → agent/README.md/agent/FAQ.md) manually verified against the actual heading anchors
No remaining references to the unreachable private-repo doc

🤖 Generated with Claude Code

## Problem The root README's "Agent installation" section pointed to `docs/AGENT_ENROLLMENT.md` in the private `triton` repo for the "full walkthrough" — a link real customers of this public repo can't actually reach. ## Fix - Adds `agent/README.md` — full install/enrollment/upgrade/uninstall/air-gapped walkthrough for Linux/macOS/Windows/FreeBSD, self-contained (no cross-repo links needed to complete an install). - Adds `agent/FAQ.md` — IP-change re-enrollment, service management, log locations, common errors, config reference. - Root README's "Agent installation" section now links to the new local docs and trims to a quick-reference command snippet. Both new docs are adapted from the private repo's `docs/AGENT_ENROLLMENT.md` and `docs/AGENT_FAQ.md`. While porting, I found and corrected two stale/wrong points in the source FAQ rather than propagating them: - Its "install" example referenced a nonexistent `https://<manage-server>:8082/install/get.ps1` endpoint instead of the real bundle-based flow this repo's own `agent/get.ps1` + `--bundle` actually uses. - Its uninstall description claimed binaries get deleted; the real `triton-agent uninstall` command only stops the service and removes the service-manager registration — confirmed against the `triton` repo's `AgentInstallSteps.vue` component comment, which documents this explicitly. ## Test plan - [x] All command blocks cross-checked against the current, correct source (`docs/AGENT_ENROLLMENT.md` in `triton`, which matches the Manage Portal's own generated commands) - [x] Internal markdown links (`README.md#...`, `FAQ.md#...`, root `README.md` → `agent/README.md`/`agent/FAQ.md`) manually verified against the actual heading anchors - [x] No remaining references to the unreachable private-repo doc 🤖 Generated with [Claude Code](https://claude.com/claude-code)

amiryahaya added 1 commit

2026-09-04 07:41:05 +02:00

docs(agent): add self-contained install guide + FAQ, fix dead cross-repo link ff7c95cb0a

The root README's "Agent installation" section pointed to
docs/AGENT_ENROLLMENT.md in the private triton repo for the "full
walkthrough" -- a link real customers of this public repo can't actually
reach.

Adds agent/README.md (full install/enrollment/upgrade/uninstall/air-gapped
walkthrough for Linux/macOS/Windows/FreeBSD) and agent/FAQ.md (IP changes,
service management, logs, common errors) as self-contained public docs,
adapted from the private repo's docs/AGENT_ENROLLMENT.md and
docs/AGENT_FAQ.md.

Corrected two stale/wrong points found in the source FAQ while porting it:
- Its "install" example referenced a nonexistent
  https://<manage-server>:8082/install/get.ps1 endpoint instead of the
  real bundle-based flow (this repo's agent/get.ps1 + --bundle).
- Its uninstall description claimed binaries get deleted; the actual
  triton-agent uninstall command only stops the service and removes the
  service-manager registration, matching the triton repo's own
  AgentInstallSteps.vue component comment.

Root README's "Agent installation" section now links to the new local
docs instead of the private repo, and trims to a quick-reference snippet
plus the two links.

amiryahaya merged commit 266a9954a9 into main

2026-09-04 09:00:58 +02:00

amiryahaya referenced this pull request from a commit

2026-09-04 09:00:59 +02:00

Merge pull request 'docs(agent): add self-contained install guide + FAQ, fix dead cross-repo link' (#25) from docs/agent-install-guide into main