Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

rockfish config

Verify the current configuration, or print a default one.

Overview

  • rockfish config / rockfish config verify — verify and display the current resolved configuration: YAML settings, environment file values (with secrets masked), enabled compile-time features, and license information. verify is the default action, so bare rockfish config behaves the same.

  • rockfish config default — print a commented default configuration to stdout. Redirect it to create a starter config:

    rockfish config default > /opt/rockfish/etc/rockfish.yaml
    

The engine auto-discovers rockfish.yaml in this order: ./rockfish.yaml/opt/rockfish/etc/rockfish.yaml (default install location) → /etc/rockfish/rockfish.yaml~/.config/rockfish/rockfish.yaml.

Usage

rockfish config [verify|default] [OPTIONS]

Output

The command displays:

  • Config file — resolved path to the active YAML configuration
  • Environment file — loaded environment variables (secrets masked as XXX...last8)
  • Enabled features — compile-time feature flags
  • License information — tier, customer, expiration (if a license file is provided)

Examples

# Show all configuration
rockfish config

# With a specific config file
rockfish -c /etc/rockfish/rockfish.yaml config

# With license info
rockfish --license /etc/rockfish/license.json config

Feature Flags

The config output includes which features were compiled in:

Compile-time Features
---------------------
  s3           enabled
  mcp          enabled
  hunt         enabled
  report       enabled
  chat         enabled
  alert        enabled
  kafka        disabled
  geoip        enabled
  ip_reputation enabled