Repository navigation
docs: add per-service setup guides with least-privilege credentials - #144
Merged
Merged
Conversation
EraPartner
marked this pull request as ready for review
October 28, 2026 08:13
EraPartner
enabled auto-merge (squash)
October 28, 2026 08:13
EraPartner
disabled auto-merge
October 28, 2026 08:22
EraPartner
force-pushed
the
claude/project-thread-osfbko
branch
from
October 28, 2026 08:23
60333f5 to
951677f
Compare
EraPartner
enabled auto-merge (squash)
October 28, 2026 08:23
Add docs/guides/service-setup/ with an index and one guide for each of the 13 service kinds: what to enable on the service, which read-only or least-privilege credentials to create, what to enter in Watchman, and troubleshooting keyed to the error messages in the code. Link the guides from the integration pages and indexes, and fix doc drift found while checking against the code: AdGuard no longer claims toggle control, the Homebridge health probe path, Bitcoin's Tor claim, and the unused zmqRawtxEndpoint.
#146 made Test connection report an unreachable service as Failed, so the setup guides no longer need the known-issue callout. docs/components/use-service-health.md described a protection-toggle mutation hook and a cache-clear hook that don't exist; rewrite it from apps/frontend/src/hooks/useServiceHealth.ts (read-only, ADR-032).
EraPartner
force-pushed
the
claude/project-thread-osfbko
branch
from
October 28, 2026 11:49
951677f to
281a7ed
Compare
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
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.
Requested by EraPartner · project thread
What
New
docs/guides/service-setup/with an index and one guide per service kind (13). Each guide covers:rpcauthuser with anrpcwhitelistof exactly the methods Watchman calls, an Alby Hubreadonlytoken, a read-only SNMP community limited to the subtrees Watchman walks, SNMPv3 for Synology, and non-admin SSH users withrestrict,from=keys.Every "what Watchman reads" list was taken from the service code (
apps/backend/src/domain/services/*,bootstrap/registerServices.ts,config/schemas/fieldMetadata.ts).Doc drift fixed along the way
integrations/adguard.md: removed the claim about "protection toggle control" (Watchman is read-only, ADR-032).integrations/homebridge.md: the health probe isstatusPath(/api/status/server-information), not/api/status/homebridge.integrations/bitcoin.md: removed "optionally through Tor" (no proxy support in code). MarkedzmqRawtxEndpointas stored but unused.guides/index.md: rebuilt the broken guide table.components/use-service-health.md: rewritten fromapps/frontend/src/hooks/useServiceHealth.ts. It describeduseAdGuardProtectionToggleanduseClearCachehooks that don't exist, and old signatures. (api/adguard.mdandcomponents/optimized-service-card.mdalso mention them, but they are already marked superseded/deprecated, so I left them.)Links
Each integration page links to its guide. The guides are also linked from
integrations/index.md,guides/index.md,INDEX.mdandgetting-started.md. I added a CHANGELOG entry.Decisions (picked per the project's best-option rule)
docs/guides/service-setup/folder, not new sections indocs/integrations/*[!warning] UnverifiedOKwhen the service answers,Failed: <reason>when it doesn'tsnapshot.reachable(apps/frontend/src/lib/connectionTest.ts). The earlier "known issue" callout is removed.Bugs found, not fixed here (reported to the bug threads)
Test connection showed: fixed in fix(frontend): UI bug pass (enable toggle, test result, detail sheet, nav, errors) #146.OKfor a down serviceinfra/ssh/) does no host-key verification. This affects Mac Mini and Raspberry Pi.node-roon-api's persisted-state location is never set (unverified whether the pairing token survives restarts).Validation
paths-ignore: docs/**, *.md).title, type, status, date, tags, description, aliases) and that everydocs/wikilink in the new guides resolves: 0 problems.mainat f0a6fd2 (fix(frontend): UI bug pass (enable toggle, test result, detail sheet, nav, errors) #146).🤖 Generated with Claude Code
https://claude.ai/code/session_018QJtaHZGu52MpwGvKuHP8x