evilbit-labs/opnDossier
Audit and document OPNsense and pfSense configurations in your GitHub Actions workflow
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 4, 2026
- License
- Apache 2.0
Pinned Snippet
uses: evilbit-labs/opndossier@f74614de515eff6ad0d087ad47b9d9b192b1a9f3 # v1.5.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| command | opnDossier sub-command to run: audit | convert | diff | display | sanitize | validate | version | no | audit |
| config-file | Path to the OPNsense or pfSense config.xml file (relative to workspace root) | yes | — |
| format | Output format for convert/audit: markdown | json | yaml | text | html | no | "" |
| output | Path to write the output file (relative to workspace root) | no | "" |
| args | Additional arguments to pass to opnDossier (split on whitespace; quoted strings with spaces are not preserved) | no | "" |
| version | Image tag to pull from ghcr.io/evilbit-labs/opndossier. RECOMMENDED for production CI: pin the action itself to a full commit SHA (e.g. `uses: EvilBit-Labs/opnDossier@<40-char-sha> # v1.6.0`) and leave this input at the default release tag. A version tag (e.g. `v1.6.0`) is an acceptable middle ground. `latest` is accepted but unpinned and moving — not supported for production use. See the README "Pinning" section for the full guidance: https://github.com/EvilBit-Labs/opnDossier#pinning | no | v1.6.0 |
Outputs
no outputs