Skip to main content
Virtual Machines
Setting up the Local VM Scanner

Setting up the Local VM Scanner

Aikido VM scanner comes as a single package that needs to be installed on the system to be protected.

Install / Upgrade

Prerequisites:

  • Ensure you have sudo privileges on your system.

  • Make sure to use the appropriate commands for your system or cloud provider.

After install, open /opt/aikido-vm-scanner-1.0.12/config.json and paste the local scan token from the Aikido app. The VM Scanner Agent runs once a day at 6AM (time on the machine). If you want to run it on demand, you can manually execute /opt/aikido-vm-scanner-1.0.12/aikido-vm-scanner.

Manual install / upgrade

For Red Hat-based Systems (RHEL, CentOS, Fedora)

x86_64
dnf install -y https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.0.12/aikido-vm-scanner.x86_64.rpm
aarch64
dnf install -y https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.0.12/aikido-vm-scanner.aarch64.rpm

For Debian-based Systems (Debian, Ubuntu)

x86_64
curl -L -O https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.0.12/aikido-vm-scanner.amd64.deb
apt-get install -y ./aikido-vm-scanner.amd64.deb
aarch64
curl -L -O https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.0.12/aikido-vm-scanner.arm64.deb
apt-get install -y ./aikido-vm-scanner.arm64.deb

We support Debian >= 10 and Ubuntu >= 20.04.

Configuration

Exclude files or paths

In the config.json you can exclude files and paths by adding additional items to the exclude list. You can find some examples below.

  • Exclude a single file in a directory:

    "exclude": [
        ...
        "./home/testing/app/package.json",
]

  • Exclude all releases subdirectories:

    "exclude": [
        ...
        "./home/testing/*/releases",
]

  • Exclude all .json files in the out folder and all subdirectories:

    "exclude": [
        ...
        "./out/**/*.json",
]

Uninstall

Manual uninstall

For Red Hat-based Systems (RHEL, CentOS, Fedora)

dnf remove -y aikido-vm-scanner

For Debian-based Systems (Debian, Ubuntu)

apt-get remove -y aikido-vm-scanner

Logs

Logs are available in the /var/log/aikido-vm-scanner-1.0.12 folder, along with the last generated SBOM.