Skip to main content

opnDossier

opnDossier
#

Status: Active

opnDossier turns OPNsense config.xml files into clear, operator-ready documentation with optional audit reporting. It parses the XML locally and emits structured Markdown, JSON, or YAML, with terminal rendering and template-driven reports.

Modes and Capabilities
#

  • Convert: structured Markdown/JSON/YAML (summary or comprehensive)
  • Display: themed terminal rendering with syntax highlighting
  • Audit: standard/blue/red reports with findings, recommendations, and pivot data
  • Plugin-driven compliance checks with extensible templates
  • Offline-only; static Go binary; robust input validation

Usage
#

Convert to file:

opndossier convert config.xml --format markdown --out report.md
# or JSON/YAML
opndossier convert config.xml --format json --out config.json

Display in terminal:

opndossier display config.xml --style summary --theme dark

Audit modes:

# Standard (neutral)
opndossier audit config.xml --mode standard --out audit.md
# Blue (defensive)
opndossier audit config.xml --mode blue --out audit.md
# Red (attack surface)
opndossier audit config.xml --mode red --out audit.md
Download & Verify

Download the latest release and verify its integrity:

For detailed verification steps, see our Shipping & Verification page.