Skip to content

📝 docs(readme): correct exec-denial reasons and index the exec examples - #78

Merged
scttbnsn merged 1 commit into
mainfrom
docs/exec-audit-fixes
Jul 29, 2026
Merged

📝 docs(readme): correct exec-denial reasons and index the exec examples#78
scttbnsn merged 1 commit into
mainfrom
docs/exec-audit-fixes

Conversation

@scttbnsn

@scttbnsn scttbnsn commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • README.md: deny-all sockguard.yaml preset returns 403 not allowed by portwing preset (not the with-exec preset's exec denied: no commands are allowlisted); clarified that the denial reason now reaches portwing's exec error and is forwarded in the exec_end reason to the controller (drydock-side display still pending)
  • examples/docker-compose.edge-with-exec.yml: same correction in the header comment, plus a pointer to sockguard's audited examples/compose/tri-tool/ bundle
  • examples/README.md: indexed docker-compose.edge-with-exec.yml and sockguard-with-exec.yaml (added in 🐛 fix(docker): surface proxy/daemon error bodies in exec errors #77, missing from the table)
  • docs/content/docs/drydock-integration.mdx: documented the exec_* Edge Mode message types (exec_start/exec_ready/exec_input/exec_output/exec_resize/exec_end) and noted exec_end's reason field

Docs-only, no CHANGELOG entry.

Test plan

  • git status in the worktree shows only the four intended files changed
  • pre-commit/pre-push lefthook gates passed (gofmt/commit-msg/go-lint/go-test/govulncheck/go-fuzz/clean-tree)

Changelog

  • 🐛 Fixed documentation distinguishing exec-denial responses for deny-all and exec-enabled presets.
  • 🔧 Changed documentation for forwarding denial reasons through Portwing errors and exec_end.
  • ✨ Added documentation for Edge Mode exec_* messages and exec_end.reason.
  • ✨ Added the edge-with-exec example to the examples index.
  • 🔒 Documented the audited Sockguard tri-tool bundle reference.

Concerns

  • Ensure the documented exec_end.reason behavior remains accurate while Drydock does not yet display the reason.

- README.md: deny-all preset returns 403 "not allowed by portwing preset",
  not the with-exec preset's "exec denied: no commands are allowlisted";
  clarify the denial reason now reaches portwing's exec error and the
  exec_end reason forwarded to the controller (drydock-side display pending)
- examples/docker-compose.edge-with-exec.yml: same correction in the header
  comment, plus a pointer to sockguard's audited tri-tool bundle
- examples/README.md: index docker-compose.edge-with-exec.yml and
  sockguard-with-exec.yaml, added in #77 but missing from the table
- docs/content/docs/drydock-integration.mdx: document the exec_* Edge Mode
  message types and note exec_end's reason field
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 14790bbd-38b4-4dc0-ab79-e5a3cb8e86ef

📥 Commits

Reviewing files that changed from the base of the PR and between 5d51c11 and 540ef26.

📒 Files selected for processing (4)
  • README.md
  • docs/content/docs/drydock-integration.mdx
  • examples/README.md
  • examples/docker-compose.edge-with-exec.yml

📝 Walkthrough

Walkthrough

Updated documentation for sockguard exec-denial behavior and Edge Mode interactive exec protocol messages. The changes describe exec_end.reason propagation, immediate failure signaling, and adapter handling. The examples documentation now lists the exec-enabled compose and sockguard policy pairing, while the compose comments clarify that the exec-enabled preset is required for proxy-side rejection behavior.

Possibly related issues

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/exec-audit-fixes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@scttbnsn

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@scttbnsn

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@biggest-littlest biggest-littlest left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ALARGECOMPANY ALARGECOMPANY left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@scttbnsn
scttbnsn merged commit cd0ae3c into main Jul 29, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants