Installation
Before starting the installation, please make sure that your target system meets the Technical Requirements and the installation is performed by a person with basic Linux skills.
Before installing, please check out our Proxy Usage or Air-gapped Systems pages if these requirements apply to you!
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 "" sandboxStep #2 - Download and unpack the release archive to a folder, e.g.: your home folder
Install 7zip:
sudo apt-get updatesudo apt-get install p7zip-full -yDownload the release archive from https://my.opswat.com/portal/products
Note that the release archive is password protected and needs to be unpacked.
Please use the password that you received from OPSWAT support!
Please adjust the x.y.z version numbers to match the downloaded filename.
7z x -aoa -p"PASSWORD" MetaDefender_Sandbox_vx.y.z-Standalone.zipStep #3 - Move to the installation folder:
cd sandbox-installerStep #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.shThe 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 statussudo docker psThe 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 componentsblog # Show logs from the broker componentsblog -bFor a more comprehensive report, it is considered a best practice to enable the use of the MD Cloud Reputation API. For further details on this: MetaDefender Cloud Reputation Service
The sandbox API is documented here: MD Sandbox API
Important notes for air-gapped systems
Please see the Air-gapped Systems subpage.
