Setting up the Local VM Scanner on Linux

Aikido VM Scanner is a single-package that installs on your system, automatically scanning and identifying dependencies to provide a detailed view into your environment.

Prerequisites

• Minimum system requirements: at least 1GB RAM.

• Preferred system requirements: at least 2GB RAM and 4 CPUs.

• Ensure you have sudo / admin privileges on your system

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

• If you need to run with sudo, place the AIKIDO_TOKEN env var after sudo, like this: sudo AIKIDO_TOKEN=REPLACE_ME <install_command>

Installation and Upgrade

Make sure you run as sudo and replace AIKIDO_TOKEN with valid token from Local VM scanning page in Aikido. You can also specify the VM_TYPE as one of: production, staging or development.

The VM Scanner Agent runs once a day, at a random time between 4:00 AM - 8:00 AM (machine time).

After install, a first scan will start automatically. If you want to run it on demand, you can manually execute:

/opt/aikido-vm-scanner-1.1.5/aikido-vm-scanner

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

x86_64

AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production dnf install -y https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.1.5/aikido-vm-scanner.x86_64.rpm

Hash	aikido-vm-scanner.x86_64.rpm
MD5	7eeef972b5d4ea9c759d9bc47dc79d92
SHA256	6752a89b6adeb66d0dac81e06a15db13b03cf5f89119a5567c7165d2f974b706

aarch64

AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production dnf install -y https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.1.5/aikido-vm-scanner.aarch64.rpm

Hash	aikido-vm-scanner.aarch64.rpm
MD5	daaff360236bdc20c341f6147f8ae85c
SHA256	23d61333e7938aa9cbb9e5df5c8ac9e258f28316c264d8ab484d76ae183407de

For Debian-based Systems (Debian, Ubuntu)

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

x86_64

curl -L -O https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.1.5/aikido-vm-scanner.amd64.deb
AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production apt-get install -y ./aikido-vm-scanner.amd64.deb

Hash	aikido-vm-scanner.amd64.deb
MD5	5bf48f9f95927db815fb6285e6e7e4c6
SHA256	571dc04ff2210d92c498c76d2ca8840fcbb6517f716f526de945cd6b54d1ae7f

aarch64

curl -L -O https://aikido-vm-agent.s3.eu-west-1.amazonaws.com/v1.1.5/aikido-vm-scanner.arm64.deb
AIKIDO_TOKEN=REPLACE_ME VM_TYPE=production apt-get install -y ./aikido-vm-scanner.arm64.deb

Hash	aikido-vm-scanner.arm64.deb
MD5	269721f0a829931c05ed966736055333
SHA256	b8328e98fd4e126116edcd61c1db2f3c445b1b3b93fa69061528c36a5030ad83

Additional 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 here, along with the last generated SBOM: /var/log/aikido-vm-scanner-1.1.5