docs: add Shell Command Sandbox documentation (RBAC)#84
Open
ashum9 wants to merge 4 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds Shell Command Sandbox (RBAC) documentation to both the English and Chinese tutorial files, describing roles, command whitelisting, and configuration.
Changes:
- Added a new "Security & Access Control (RBAC)" section documenting roles (Guest/Member/Admin/SuperAdmin) and the shell command sandbox whitelist configuration.
- Mirrored the same documentation in the Chinese tutorial (
TUTORIAL_CN.md).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| TUTORIAL.md | Added RBAC and Shell Command Sandbox documentation section |
| TUTORIAL_CN.md | Added equivalent Chinese-language RBAC documentation section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
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.
Description
This PR adds the missing documentation for the Shell Command Sandbox feature, which is a critical part of the new RBAC system.
The sandbox logic was successfully built into the engine to prevent dangerous commands (like
rm -rf /orsudo), but the user-facing tutorials were never updated to reflect how to configure it. This PR fills that gap by adding detailed configuration instructions to TUTORIAL.md and TUTORIAL_CN.md.Changes Made
safe_commandslist operates as a strict whitelist for shell execution.permissions.tools.shell.safe_commands.allowed.is_dangerous_commandchecks) when RBAC is disabled.Resolves: Closes #67