Skip to content
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.

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

Improve documentation for using the Containerfile on the install page #773

Open
alilleybrinker opened this issue Jan 9, 2025 · 0 comments
Labels
product: website Relates to the Hipcheck website type: enhancement New feature or request
Milestone

Comments

@alilleybrinker
Copy link
Collaborator

We should improve this section: https://hipcheck.mitre.org/docs/getting-started/install/#using-the-containerfile

Specifically to reflect the need to pass through the HC_GITHUB_TOKEN environment variable and to specify a policy file.

An invocation with podman would look like:

$ podman run -e HC_GITHUB_TOKEN=$HC_GITHUB_TOKEN localhost/hc-image:latest --policy /home/hc_user/.config/hipcheck/Hipcheck.kdl check https://github.com/mitre/hipcheck

Assuming you've built the Containerfile and have it in your local image store.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product: website Relates to the Hipcheck website type: enhancement New feature or request
Projects
Status: Todo
Status: No status
Development

No branches or pull requests

1 participant