docs(examples): add sandbox policy quickstart walkthrough#266
Merged
docs(examples): add sandbox policy quickstart walkthrough#266
Conversation
|
All contributors have signed the DCO ✍️ ✅ |
Collaborator
Author
|
I have read the DCO document and I hereby sign the DCO. |
Add an interactive getting-started example that demonstrates OpenShell's network policy system end-to-end: default-deny, L7 read-only access, and audit logging — all with a single YAML policy file. - examples/sandbox-policy-quickstart/policy.yaml: policy with default static fields (filesystem, landlock, process) so it works out of the box with `openshell policy set` - examples/sandbox-policy-quickstart/demo.sh: automated demo script using printf (portable) and openshell ssh-proxy for sandbox exec - examples/sandbox-policy-quickstart/README.md: step-by-step manual walkthrough - README.md: add "See network policy in action" section linking to the quickstart Signed-off-by: Alexander Watson <zredlined@gmail.com> Made-with: Cursor Signed-off-by: Alexander Watson <zredlined@gmail.com> Made-with: Cursor
zredlined
force-pushed
the
aw/getting-started-examples
branch
from
f2b888a to
fccdd84
Compare
johntmyers
reviewed
Mar 12, 2026
Sandbox defaults vary by type and community configs, so "all outbound traffic is blocked" is too absolute. Made-with: Cursor
drew
approved these changes
Mar 13, 2026
curl -s suppresses stderr, hiding the 403 from the CONNECT proxy. Adding -S ensures the error message is always shown. Made-with: Cursor
drew
pushed a commit
that referenced
this pull request
Mar 16, 2026
* docs(examples): add sandbox policy quickstart walkthrough Add an interactive getting-started example that demonstrates OpenShell's network policy system end-to-end: default-deny, L7 read-only access, and audit logging — all with a single YAML policy file. - examples/sandbox-policy-quickstart/policy.yaml: policy with default static fields (filesystem, landlock, process) so it works out of the box with `openshell policy set` - examples/sandbox-policy-quickstart/demo.sh: automated demo script using printf (portable) and openshell ssh-proxy for sandbox exec - examples/sandbox-policy-quickstart/README.md: step-by-step manual walkthrough - README.md: add "See network policy in action" section linking to the quickstart Signed-off-by: Alexander Watson <zredlined@gmail.com> Made-with: Cursor Signed-off-by: Alexander Watson <zredlined@gmail.com> Made-with: Cursor * docs: soften default-deny wording to minimal outbound access Sandbox defaults vary by type and community configs, so "all outbound traffic is blocked" is too absolute. Made-with: Cursor * docs: use curl -sS so L4 deny errors are visible curl -s suppresses stderr, hiding the 403 from the CONNECT proxy. Adding -S ensures the error message is always shown. Made-with: Cursor --------- Signed-off-by: Alexander Watson <zredlined@gmail.com>
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
3 participants
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.
Summary
examples/sandbox-policy-quickstart/) that walks users through OpenShell's network policy system: default-deny, L7 read-only access to the GitHub API, and audit loggingdemo.shthat runs the full walkthrough non-interactively — great for demos and CI smoke testsKey fixes in the example
filesystem_policy,landlock,process) — required becauseopenshell policy setreplaces the entire policy and the server rejects removal of static fields on a live sandboxdemo.shusesprintfinstead ofecho -e— portable acrosssh/bash/zsh(the old version printed literal-eon macOS)demo.shparses the SSH Host fromopenshell sandbox ssh-config— the generated config usesHost openshell-<name>, not<name>directlyTest plan
./demo.shend-to-end on macOS against a remote spark cluster — all 7 steps passopenshell policy setworks with the updatedpolicy.yaml(no morefilesystem policy cannot be removederror)Made with Cursor