Skip to content

Configuration

chuckablack edited this page Nov 11, 2020 · 2 revisions

If you do nothing else - no configuration - quokka should still run fine, since it has configured already a number of sandbox devices in the cloud, it auto-discovers hosts on your local network, and it has a few normal services configured.

However, if you enjoy quokka and wish to tailor it to your specific network, then this is possible through configuration files. These files are all in the YAML format, which is pretty straightforward, and is both human- and computer-readable.

The configuration files available for monitoring devices and services are as follows:

  • quokka/quokka/data/devices.yaml: This file holds the devices that quokka will monitor. By default, this file includes a number of Cisco sandbox devices.
  • quokka/quokka/data/services.yaml: This file holds the services that quokka will monitor. By default, this file includes a couple DNS servers, a few HTTP sites, and an NTP site, all of these being in the cloud and easily accessible.

The configuration files for performing 'diagnostic' functions are as follows:

  • quokka/quokka/data/capturemonitors.yaml: This file defines the 'monitors', aka 'workers', that will be used for doing packet capture. By default, everything goes to the local packet capture worker.
  • quokka/quokka/data/portscanmonitors.yaml: This file defines the 'monitors', aka 'workers', that will be used for doing extended port scan. By default, everything goes to the local portscan worker.
  • quokka/quokka/data/traceroutemonitors.yaml: This file defines the 'monitors', aka 'workers', that will be used for doing traceroute. By default, everything goes to the local traceroute worker.
  • quokka/quokka/data/workers.yaml: This file defines the remote workers. By default, the local workers are used, and everything goes through them, so no truly 'remote' workers are required.

As indicated by the file names given above, these configurations are stored in the directory path quokka/quokka/data/*.yaml . Note that these files are only read at quokka startup time, so if you make a change, you will need to stop and restart quokka.

Clone this wiki locally