Physical or Virtual Machine-Based Setup

Installation order

MetaDefender Cluster consists of the following components along with their corresponding default ports.

The system administrator should adhere to the following service installation sequence to prevent conflicts:

1. Install Redis, RabbitMQ, Postgres, MD Cluster File Storage, MD Cluster Identity Service.
2. Install MD Cluster Control Center.
3. Install MD Cluster Worker on the targeted machines (for deploying MD Cluster API Gateway or MetaDefender Core).

Installation

Install Redis Caching Server

1. Follow steps to install Redis Caching server.
2. Access Redis configuration file/etc/redis/redis.conf for editing.
3. Comment out the bind setting and set protected-mode option to no.

...

# The following line should be commented

# bind 127.0.0.1

...

# The following line should be uncommented and set to no

protected-mode no

...

4. Restart the service.

# Red Hat/Rocky

 $ sudo systemctl enable redis

 $ sudo systemctl restart redis

​

# Debian/Ubuntu

$ sudo systemctl enable redis-server

$ sudo systemctl restart redis-server

Install RabbitMQ Message Broker

Windows

1. Download Erlang and follow the instructions to install Erlang.
2. Download RabbitMQ for Windows.
3. Run the executable file as administrator, follow instructions to complete the RabbitMQ installation.
4. In Command Prompt, change working directory to <RabbitMQ installation folder>/rabbitmq_server-<version>/sbin and run the following command:

> rabbitmqctl.bat add_user <username> <password>

> rabbitmqctl.bat set_permissions -p / <username> "." "." "."

> rabbitmqctl.bat set_user_tags <username> administrator

Linux

1. Download Erlang and follow the instructions to install Erlang and its dependencies.
2. Download RabbitMQ for Red Hat/Rocky or Debian/Ubuntu .
3. In Terminal, run the following command:

# Red Hat/Rocky

$ sudo rpm -Uvh --nodeps rabbitmq-server-<rabbitmq version>.el8.noarch.rpm

$ sudo systemctl enable rabbitmq-server

$ sudo systemctl start rabbitmq-server

# Debian/Ubuntu

$ sudo dpkg -i rabbitmq-server_<rabbitmq version>_all.deb

4. In Terminal, run the following command:

$ sudo rabbitmqctl add_user <username> <password>

$ sudo rabbitmqctl set_permissions -p / <username> "." "." "."

$ sudo rabbitmqctl set_user_tags <username> administrator

Install PostgreSQL Database Server

1. Download PostgreSQL Database Server.
2. Follow steps to setup Postgres Database Server to allow connections from external applications.
3. Restart Postgres Database Server.

Install MD Cluster File Storage

1. Build Ignition file for MD Cluster File Storage service.
2. Start Command Prompt as Administrator on Windows or Terminal on Linux and run the following command:

# Windows

> msiexec.exe /i <mddc_file_storage_package> /qn

​

# Debian or Ubuntu

$ sudo apt -y install uuid

$ sudo dpkg -i <mddc_file_storage_package> || sudo apt install -f

​

# Red Hat or Rocky

$ sudo dnf -y install uuid

$ sudo yum install <mddc_file_storage_package> -y

3. Check the service status.

Install MD Cluster Identity Service

1. Build Ignition file for MD Cluster Identity Service.
2. Start Command Prompt as Administrator on Windows or Terminal on Linux and run the following command:

# Windows

> msiexec.exe /i <mddc_identity_service_package> /qn

​

# Ubuntu or Debian

$ sudo apt -y install uuid

$ sudo dpkg -i <mddc_identity_service_package> || sudo apt install -f

​

# Red Hat or Rocky

$ sudo dnf -y install uuid

$ sudo yum install <mddc_identity_service_package> -y

3. Check the service status.

Install MD Cluster Control Center

1. Build Ignition file for MD Cluster Control Center service.
2. Start Command Prompt as Administrator on Windows or Terminal on Linux and run the following command:

# Windows

> msiexec.exe /i <mddc_control_center_package> /qn

​

# Ubuntu or Debian

$ sudo apt -y install uuid

$ sudo dpkg -i <mddc_control_center_package> || sudo apt install -f

​

# Red Hat or Rocky

$ sudo dnf -y install uuid

$ sudo yum install <mddc_control_center_package> -y

3. Check the service status.

Setup Data Lake and Data Warehouse

1. Go to C:\Program Files\OPSWAT\MetaDefender Distributed Cluster Control Center directory in Windows Command Prompt or /usr/sbin directory in Linux Terminal.
2. Run the following command:

# Windows

> mddc-dbready.exe --host=<postgres-host> --port=<postgres-port> --user=<postgres-user> --password=<postgres-password> --target=lake,warehouse

​

# Linux (Ubuntu, Debian, Red Hat or Rocky)

$ mddc-dbready --host=<postgres-host> --port=<postgres-port> --user=<postgres-user> --password=<postgres-password> --target=lake,warehouse

Install MD Cluster Worker

1. Build Ignition file for MD Cluster Worker service.
2. Start Command Prompt as Administrator on Windows or Terminal on Linux and run the following command:

# Windows

> msiexec.exe /i <mddc_worker_package> /qn

​

# Ubuntu or Debian

$ sudo apt -y install uuid

$ sudo dpkg -i <mddc_worker_package> || sudo apt install -f

​

# Red Hat or Rocky

$ sudo dnf -y install uuid

$ sudo yum install <mddc_worker_package> -y

3. Check the service status.
4. Repeat the above steps for other MD Cluster Workers.

Configurations

When all MD Cluster Worker instances are installed successfully, it marks a completed installation. Now, heading to essential configuration steps.

Connect essential services

1. Sign in to MD Cluster Control Center web console with the initial administrator user account that you created in Install MD Cluster Identity Service.
2. Go to Inventory > Services, open the relevant service category, and click on Add service.

4. Complete all necessary fields as specified by the selected services.

5. Save result.
6. Check status of the service connections.

Submit MetaDefender Core and MD Cluster API Gateway installers

1. Sign in to MD Cluster Control Center web console with the initial administrator user account that you created in Install MD Cluster Identity Service.
2. Go to Inventory > Installers and select Upload installer .
3. Select MetaDefender Core or MD Cluster API Gateway installation files.
4. Click Upload .

Connect to MD Cluster Workers

1. Sign in to the MD Cluster Control Center web console with the initial administrator account that you created during the installation of MD Cluster Identity Service.
2. Go to Inventory > Workers and select Add workers.
3. Complete the required fields to add new workers and click Submit.

4. Check the status of MD Cluster Worker connections.

Deploy MetaDefender Core and MD Cluster API Gateway instances

1. Sign in to the MD Cluster Control Center web console with the initial administrator account that you created during the installation of MD Cluster Identity Service.
2. Go to Inventory > Workers and select Deploy workers.

3. In API Gateway tab, select workers for MD Cluster API Gateway deployment and decide which installer version will be used to deploy on the selected workers.

4. Repeat the step for selection of workers for MetaDefender Core deployment.

5. Click Next.
6. Confirm the deployment details, then click Deploy and Finish.
7. Hold off until the deployment is completed successfully.

7. Although MetaDefender Core instances are deployed successfully on workers, a valid license is required for them to function.

Activate online license

1. Sign in to the MD Cluster Control Center web console with the initial administrator account that you created during the installation of MD Cluster Identity Service.
2. Go to Inventory > Licenses and select Online License.
3. Click Add license and input your license key.

4. Click the three-dot icon beside your selected license key and choose Activate.

5. Wait until the license activation finishes on the deployed MetaDefender Core instances.

6. Navigate to Inventory > Workers to ensure the running status of the workers hosting MetaDefender Core.

7. MD Cluster API Gateway can now efficiently accept scan requests.