Configuration Files

APHIDS CLI uses YAML configuration files for offline mode and advanced configuration.

Configuration File Types

Options File (options.yaml)

Defines what to scan and which modules to use.

Example:

version: "1.0"

scan:
  name: "Security Assessment"
  description: "Comprehensive security scan"

modules:
  - name: "nmap"
    enabled: true
    args:
      target: "192.168.1.0/24"
      ports: "1-65535"
      scan_type: "syn"

  - name: "nikto"
    enabled: true
    args:
      target: "https://example.com"
      tuning: "1,2,3"

Config File (config.yaml)

Defines APHIDS behavior and Docker settings.

Example:

version: "1.0"

docker:
  image: "ghcr.io/darksidesecurity/aphids:latest"
  network: "bridge"
  pull_policy: "always"

output:
  directory: "./results"
  format: "json"
  verbose: true

logging:
  level: "INFO"
  file: "./aphids.log"

Options File Structure

Scan Section

scan:
  name: "Scan Name"
  description: "Scan description"
  tags:
    - "production"
    - "external"

Modules Section

modules:
  - name: "module_name"
    enabled: true
    timeout: 300
    args:
      key: "value"

Config File Structure

Docker Section

docker:
  image: "ghcr.io/darksidesecurity/aphids:latest"
  network: "bridge"
  volumes:
    - "./data:/data"
  environment:
    - "VAR=value"

Output Section

output:
  directory: "./results"
  format: "json"  # json, xml, csv
  compress: true
  verbose: true

Logging Section

logging:
  level: "INFO"  # DEBUG, INFO, WARN, ERROR
  file: "./aphids.log"
  console: true

Usage

Offline Mode

aphids-cli \
  --options options.yaml \
  --config config.yaml

With Overrides

aphids-cli \
  --options options.yaml \
  --config config.yaml \
  --verbose \
  --output-dir ./custom-results

Best Practices

✅ Version Control: Track configuration changes
✅ Validate: Test configurations before use
✅ Document: Comment complex configurations
✅ Secure: Don't commit sensitive data
✅ Organize: Use clear naming conventions

---

Related: Basic Commands | Integration | Modules