Skip to content

docs: add SELinux/RHEL notice to container quick start #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwm4 merged 3 commits into from
May 28, 2026
Merged

docs: add SELinux/RHEL notice to container quick start #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e238d36
docs: add SELinux/RHEL notice to container quick start sections
aviavraham May 25, 2026
ff6ac87
docs: add :Z volume flags to Quick Start commands instead of callout
aviavraham May 26, 2026
aad3469
docs: use consistent lowercase :z SELinux labels across all podman ex…
aviavraham May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions CONTAINER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ mkdir -p ~/agentready-reports

# Assess repository
podman run --rm \
-v /path/to/repo:/repo:ro \
-v ~/agentready-reports:/reports \
-v /path/to/repo:/repo:ro,z \
-v ~/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports

Expand All @@ -35,8 +35,8 @@ mkdir -p ~/agentready-reports

# Run assessment
podman run --rm \
-v /tmp/agentready:/repo:ro \
-v ~/agentready-reports:/reports \
-v /tmp/agentready:/repo:ro,z \
-v ~/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports

Expand All @@ -52,22 +52,22 @@ mkdir -p ./agentready-reports

# Local repository
podman run --rm \
-v $(pwd):/repo:ro \
-v $(pwd)/agentready-reports:/reports \
-v $(pwd):/repo:ro,z \
-v $(pwd)/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports

# With additional options
podman run --rm \
-v $(pwd):/repo:ro \
-v $(pwd)/agentready-reports:/reports \
-v $(pwd):/repo:ro,z \
-v $(pwd)/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports --verbose

# Exclude specific assessors
podman run --rm \
-v $(pwd):/repo:ro \
-v $(pwd)/agentready-reports:/reports \
-v $(pwd):/repo:ro,z \
-v $(pwd)/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports -e type_annotations -e test_execution
```
Expand All @@ -77,8 +77,8 @@ podman run --rm \
```bash
# Mount writable output directory
podman run --rm \
-v /path/to/repo:/repo:ro \
-v $(pwd)/reports:/reports \
-v /path/to/repo:/repo:ro,z \
-v $(pwd)/reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports

Expand Down Expand Up @@ -227,8 +227,8 @@ Mount a writable output directory to save reports to your host filesystem:
```bash
mkdir -p ~/agentready-reports
podman run --rm \
-v /repo:/repo:ro \
-v ~/agentready-reports:/reports \
-v /repo:/repo:ro,z \
-v ~/agentready-reports:/reports:z \
Comment on lines +230 to +231

@coderabbitai coderabbitai Bot May 28, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix host mount path in troubleshooting example

Line 230 uses /repo as the host source (-v /repo:/repo:ro,z), which will fail for most users unless they happen to have that exact host directory. Use a real host path pattern here (e.g., $(pwd) or /path/to/repo) to keep this command copy/paste-safe.

Suggested doc fix 
 podman run --rm \
-  -v /repo:/repo:ro,z \
+  -v $(pwd):/repo:ro,z \
   -v ~/agentready-reports:/reports:z \
   ghcr.io/ambient-code/agentready:latest \
   assess /repo --output-dir /reports
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
-v /repo:/repo:ro,z \
-v ~/agentready-reports:/reports:z \
podman run --rm \
-v $(pwd):/repo:ro,z \
-v ~/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports
🤖 Prompt for 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.

In `@CONTAINER.md` around lines 230 - 231, Update the example host mount paths in
the troubleshooting Docker volume flags so they are copy/paste-safe: replace the
literal "/repo" in the "-v /repo:/repo:ro,z" entry with a real-host-path
placeholder like "$(pwd)" or "/path/to/repo", and replace the
"~/agentready-reports" in "-v ~/agentready-reports:/reports:z" with an absolute
path (e.g., "$HOME/agentready-reports" or "/path/to/reports") so users won't get
errors when running the shown docker command.

ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports
```
Expand Down Expand Up @@ -258,8 +258,8 @@ podman run --rm \
-e GIT_CONFIG_COUNT=1 \
-e GIT_CONFIG_KEY_0=safe.directory \
-e GIT_CONFIG_VALUE_0=/repo \
-v $(pwd):/repo:ro \
-v $(pwd)/agentready-reports:/reports \
-v $(pwd):/repo:ro,z \
-v $(pwd)/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports
```
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ mkdir -p ~/agentready-reports
# Assess AgentReady itself
git clone https://github.com/ambient-code/agentready /tmp/agentready
podman run --rm \
-v /tmp/agentready:/repo:ro \
-v ~/agentready-reports:/reports \
-v /tmp/agentready:/repo:ro,z \
-v ~/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports

# Assess your repository
# For large repos, add -i flag to confirm the size warning
podman run --rm \
-v /path/to/your/repo:/repo:ro \
-v ~/agentready-reports:/reports \
-v /path/to/your/repo:/repo:ro,z \
-v ~/agentready-reports:/reports:z \
ghcr.io/ambient-code/agentready:latest \
assess /repo --output-dir /reports

Expand Down
Loading