Commands

After installation, manage your scanner using the detectify-scanner command. All commands require sudo.

sudo detectify-scanner <command>

Available Commands

status

Displays the health of all scanner components:

sudo detectify-scanner status

Example output:

Detectify Scanner Status
========================

  [✓] k3s service: Running
  [✓] scan-scheduler: Running
  [✓] scan-manager: Running
  [✓] chrome-controller: Running
  [✓] redis: Running
  [✓] API reachability: http://10.0.1.5:30000 responding
  [✓] Disk usage: 12G 38G 24%

All systems healthy.

logs

View logs from scanner components:

sudo detectify-scanner logs

Follow logs in real time

sudo detectify-scanner logs -f

View logs for a specific component

sudo detectify-scanner logs scan-scheduler

Valid components: scan-scheduler, scan-manager, chrome-controller, redis.

You can combine both flags:

sudo detectify-scanner logs -f scan-scheduler

restart

Restart all scanner components:

sudo detectify-scanner restart

Restart a single component

sudo detectify-scanner restart scan-scheduler

The command waits for the rollout to complete before returning.

update

Pull the latest scanner images and redeploy:

sudo detectify-scanner update

The command shows whether images were updated or were already at the latest version.

reconfigure

Change credentials without reinstalling. The command shows your current configuration, lets you update any credential, and applies the changes:

sudo detectify-scanner reconfigure

Press Enter to keep a current value, or type a new one. Changed credentials are validated before being applied.

Environment Variable Overrides

You can override the following settings by exporting environment variables before running the installer:

Available chart versions are published on the Detectify Helm Charts GitHub repository .

For example, to install a specific image tag:

sudo SCANNER_IMAGE_TAG=1.2.0 ./detectify-scanner install

These overrides also apply to the update command:

sudo SCANNER_IMAGE_TAG=1.2.0 detectify-scanner update

preflight

Run pre-flight checks without installing. Useful for verifying a host meets requirements before committing to an installation:

sudo detectify-scanner preflight

uninstall

Completely remove the scanner, k3s, configuration, and data from the host:

sudo detectify-scanner uninstall

You must type uninstall to confirm. This removes:

• k3s and all Kubernetes components
• Scanner configuration (/etc/detectify-scanner/)
• Scanner data (/var/lib/rancher/)
• The installer script (/usr/local/bin/detectify-scanner)