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

Open
aviavraham wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −6
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 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
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
4 changes: 2 additions & 2 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 \
Comment on lines +16 to +17
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 26, 2026

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

Quick Start is fixed, but the same SELinux failure path still exists in other Podman examples.

Good change here. However, several later podman run -v ... examples in this same file still omit :z/:Z, so SELinux-enforcing users can still hit permission errors when following those sections. Please apply the same labeling strategy (or an explicit SELinux note) consistently across the remaining Podman bind-mount examples in CONTAINER.md to avoid repeated copy/paste failures.

🤖 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 16 - 17, Several remaining Podman bind-mount
examples in CONTAINER.md still omit SELinux mount labels and can fail for
SELinux-enforcing users; update every occurrence of the Podman bind-mount
examples (the lines using "podman run -v ..." and the earlier sample mounts like
"-v /path/to/repo:/repo" or "-v ~/agentready-reports:/reports") to append the
appropriate SELinux label (:z or :Z) consistent with the Quick Start fix, or add
a short note next to each Podman example explaining to use :z/:Z for SELinux,
ensuring all Podman run -v examples are updated consistently.

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