Troubleshooting

Recovering the ScanSuite platform. For the DefectDojo bug tracker, see Set up DefectDojo.

Ask the installation what is wrong

Start here. doctor checks the host and the installation — Docker and its compose plugin, the ports, free disk space, the clock against your NTP server, the licence file, the certificate, the settings in .env — then lists the services that are not running and the recent errors in their logs:

cd /opt/scansuite && ./scansuite doctor

It reports every check rather than stopping at the first failure, so one run is usually enough to see what to fix. Send its output with any support request.

Right after a start, doctor can list connection refused lines from seaweedfs among the recent errors. The file store's parts come up one after the other and retry until they find each other; if the lines stop within a minute and doctor ends with No problems found, nothing is wrong.

Restart ScanSuite

cd /opt/scansuite && ./scansuite restart

A restart brings services back only when they report healthy, and says which one did not. If a container is wedged rather than merely unhealthy, recreate them all:

cd /opt/scansuite && ./scansuite restart --hard

Check the container logs

Ask for one service, or leave the name out for all of them. The architecture page explains what each one does.

./scansuite logs web
./scansuite logs worker
./scansuite logs worker_admin
./scansuite logs celery_beat

The application log is written to the host:

cat /var/tmp/scansuite.log

Check what this host is running

Before reporting a problem, note the release, the licence and the images actually running — which can differ from the installed release if the host has not been restarted since an update:

cd /opt/scansuite && ./scansuite version

Restart Docker

If containers fail to start at all, restart the Docker service itself:

sudo service docker restart

Remove ScanSuite from a host

To take ScanSuite off a host — to reinstall from scratch — stop it and remove its boot service. --purge also deletes the database and the stored files; leave it out to keep them:

cd /opt/scansuite && ./scansuite uninstall --purge

DefectDojo is a separate installation and keeps running. Remove it, with its data, from its own folder:

cd /opt/scansuite/defectdojo && docker compose down -v

The images and the installation folder stay on the host. Remove them to free the space; the folder needs sudo because the services write some of its files as root:

docker images -q 'appsec4u/*' | sort -u | xargs -r docker rmi -f
sudo rm -rf /opt/scansuite