Prerequisites

This section tells you about the prerequisite items for running a QScanner scan.

• Operating System
• Write Permissions
• Network Connectivity
• Resource Requirements

Host Operating System

QScanner supports its installation on the following Operating Systems.

• Linux OS (amd64 and arm64)
• Darwin MacOS

Write Permission

QScanner requires the 'Write' permission to the following paths.

Sr no.	Type	Used For	Default Path	Override flag
1	Output directory	Output artifacts such as, report, scan-result, changelist DB, SBOM and so on	~/qualys/qscanner/data	--output-dir
2	Cache directory	To cache artifacts like java-db, qscanner-cache, secret-config, and so on.	~/.cache/qualys/qscanner	--cache-dir
3	Temp directory	Temporary artifacts required during the scan	/tmp	TMPDIR

Network Connectivity

QScanner requires network access for the following use case. Please make sure they are accessible from the host where QScanner is running.

• To scan remote images. The registry must be accessible.
• To perform SCA scan (when running in online-scan mode). The below URLs must be accessible for downloading java-db which is an SQL database. For more details, refer section on Java Index Database.
  • https://ghcr.io/v2
  • https://pkg-containers.githubusercontent.com

If you are running QScanner in a Proxy environment, run the below command.
$ export https_proxy=<proxy_url>

OR

Use the --proxy <proxy_url> flag.

Resource Requirements

The table below shows you the resource requirements (CPU and Memory allocation) for a successful QScanner scan.

Resource	Minimum	Recommended
CPU	2 CPU	4 CPU
Memory	4 GB	8 GB