Configuration¶

All configuration is in config.yaml. For Docker, mount it to /app/config.yaml.

Full Example¶

network:
  subnet: "192.168.1.0/24"
  scan_profile: "normal"

scanning:
  port_range: "1-1000"
  enable_os_detection: true
  enable_service_detection: true

alerts:
  new_device: true
  new_port: true

database:
  path: "data/argus.db"

Network Settings¶

subnet¶

Target network in CIDR notation.

network:
  subnet: "192.168.1.0/24"

Common values: 192.168.1.0/24, 192.168.0.0/24, 10.0.0.0/24, 172.16.0.0/16

Find yours: ip route | grep default

scan_profile¶

Scanning Settings¶

port_range¶

scanning:
  port_range: "1-1000"       # First 1000 (default)
  port_range: "1-65535"      # All ports
  port_range: "common"       # nmap top 1000
  port_range: "22,80,443"    # Specific ports

enable_os_detection¶

OS fingerprinting. Requires root/sudo.

enable_service_detection¶

Banner grabbing for service versions.

Alert Settings¶

alerts:
  new_device: true   # Alert on new devices
  new_port: true     # Alert on new open ports

Database¶

database:
  path: "data/argus.db"

SQLite database location. Mount this directory for persistence in Docker.

Environment Variables¶

Tips¶

• Use quick for frequent scans, intensive for weekly audits
• For large networks (100+ devices), scan smaller subnets separately
• Changes are persisted to config.yaml when saved via UI

Next Steps¶

• First Scan