Installation

Please walk through the following steps. If you encounter any issues during installation, refer to our Troubleshooting Guide.

Step #1 - (Optional) Create a new user that will own all the installed files and run the Sandbox services

sudo adduser --disabled-password --gecos "" sandbox

Step #2 - Download and unpack the release archive to a folder, e.g.: your home folder

Install 7zip:

sudo apt-get update

sudo apt-get install p7zip-full -y

Download the release archive from https://my.opswat.com/portal/products

Note that the release archive is password protected and needs to be unpacked.

7z x -aoa -p"PASSWORD" MetaDefender_Sandbox_vx.y.z-Standalone.zip

Step #3 - Move to the installation folder:

cd sandbox-installer

Step #4 - (Optional) Edit install.cfg to specify a custom user name and installation path

Note: The default settings work fine for standard deploys and all features can be configured post installation.

Step #5 - Run the install shell script

Note that this operation can take up to 20-30 minutes (depending on available network bandwidth).

sudo ./install.sh

The first step of the installation process is accepting the product EULA, you need to press Y to start the installation.

Step #6 - Access the Sandbox web server (https://localhost:443) and setup the initial Admin user

Step #7 - Add your Activation Key

The system will not be able to generate scan reports yet, as a valid Activation Key is required.

Please use the Activation Key that you received from your OPSWAT Sales Representative, and follow the instructions on the License Activation page.

Simple steps for Online activation:

Navigate to the Admin panel > Settings > Integrations > License Management tab, then click on Activate All, then enter your license key!

Step #8 - Scan your preferred test file to check if the Sandbox system functions properly

Step #9 - (Optional) Troubleshooting if the Sandbox service failed to initialize

Verify the status of the sandbox service and if the running docker container are healthy:

sudo service sandbox status

sudo docker ps

The sblog bash command can be used to check the application logs for different system components.

This command is available to all users (but might require sudo privileges):

# Show logs from the transform component

sblog 

# Show logs from the broker component

sblog -b

Important notes for air-gapped systems

Please see the Air-gapped Systems subpage.