docs: kiosk-desktop post-merge audit — document self-service mode + fix stale agent systemd docs - #107
Conversation
…temd install Post-K2b documentation audit (linters/CI flows all verified clean separately, no code changes here): - desktop/README.md: self-service mode (station-type toggle, window lockdown behavior, staff-QR exit, the still-open real-hardware verification gap) had zero documentation despite being a security-relevant, user-facing feature. - agent/README.md: "Production Deployment"'s systemd section hand-wrote a stale, simplified unit (no --host 0.0.0.0, wrong binary path, no auth-token/dialout guidance) that predates K3a's real, tested agent/dist/install.sh + idento-agent.service. Repointed at the real bundle, kept a manual fallback path for non-standard setups. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 39 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. 📝 WalkthroughWalkthroughThe documentation updates describe standalone and manual Linux systemd deployment for the agent, and add operational guidance for desktop self-service stations, including restrictions, lockdown, staff exit, and a hardware-testing note. ChangesAgent deployment documentation
Desktop self-service documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@agent/README.md`:
- Around line 253-257: Update the Russian README text describing the bundle in
agent/dist/ so it states that the bundle contains an already-built binary, not
that it compiles one; keep the surrounding installation behavior unchanged.
- Around line 274-285: Update the “Ручная настройка (без install.sh)” command
block to explicitly switch to agent/dist or use repository-root-relative paths
before referencing idento-agent and idento-agent.service, ensuring the manual
fallback is copy-pasteable without relying on the preceding workflow.
- Line 271: Update the malformed reference in the agent README text near
“Connecting to a standalone agent (external” by replacing the mixed
``desktop/README.md`'s`` construction with natural Russian wording such as “в
разделе … файла `desktop/README.md`”, while preserving the referenced section.
- Around line 280-285: Update the manual installation instructions around the
idento-agent systemd setup to ensure the configured service user is a member of
the dialout group, either by adding the equivalent usermod command or clearly
documenting it as a prerequisite before enabling the service.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 27f0d6f3-0150-47a1-aca8-cbc26839a97a
📒 Files selected for processing (2)
agent/README.mddesktop/README.md
4 real findings in agent/README.md's new Production Deployment section, all fixed: - "он собирает бинарник" wrongly implied install.sh compiles the agent; it only installs the prebuilt agent/dist/idento-agent binary - malformed mixed English-possessive/Russian desktop/README.md reference - manual-install fallback referenced bare idento-agent/idento-agent.service without a working directory, not copy-pasteable from repo root - manual-install fallback never added the service user to dialout, unlike install.sh -- would silently leave serial scanners/printers inaccessible under a default setup Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Summary
Requested audit after K2b merged, closing out the full kiosk-desktop initiative (K1/K2a/K2b/K3a/K3b): "check everything is OK — linters, flows, deployment/signing docs."
Verified clean, no action needed:
npm run lint -w idento-desktop/-w @idento/ui— 0 errorscargo clippy --all-targets(desktop/src-tauri) — clean (first time this has actually been run across the whole initiative)go vet ./.../go test ./...(agent) — cleanci.yml,release.yml,release-desktop.yml,validate.yml) — valid, path-filters correctly scoped (desktop/**,agent/**), and PR feat(desktop): K2b — self-service kiosk mode (attract screen, lockdown, staff-QR exit) #105 itself already proved the realBuild Desktop (Tauri)CI job passes post-K2bFound and fixed (docs only, no code changes):
desktop/README.mdhad zero documentation of K2b's self-service mode — a security-relevant, user-facing feature (window lockdown, staff-QR exit) with no explanation of how to enable it, what the exit token is, or the still-open real-hardware verification gap. Added a section.agent/README.md's "Production Deployment" section hand-wrote a stale, simplified systemd unit (no--host 0.0.0.0, wrong binary path, no auth-token/dialoutguidance) that predates K3a's actual, testedagent/dist/install.sh+idento-agent.service. Repointed at the real bundle as the recommended path; kept a manual fallback for non-standard installs.Test plan
agent/dist/install.sh,desktop/src/pages/Mode.tsx,StaffExitOverlay.tsx)🤖 Generated with Claude Code
Summary by CodeRabbit