Title
Create new category
Edit page index title
Edit category
Edit link
Container-Based Setup
Before running the setup, please check Recommended System Configuration to install all required dependencies of MetaDefender Distributed Cluster (MDDC).
Setup order requirement
Please follow installation steps in order to complete the system setup properly:
Order no. | Service | Notes |
|---|---|---|
1 | Redis, RabbitMQ, PostgreSQL, Identity Service and File Storage |
|
2 | Control Center |
|
3 | Worker for API Gateway and Worker for MetaDefender Core |
|
Image name and version
All the images can be found at OPSWAT Docker Hub with the following information:
Note: version is the currently release version.
MetaDefender Distributed Cluster Identity Service
MetaDefender Distributed Cluster File Storage
MetaDefender Distributed Cluster Control Center
MetaDefender Distributed Cluster Worker for API Gateway
MetaDefender Distributed Cluster Worker for MetaDefender Core
Environment variables
1. MDDC Identity Service
Environment Variable | Necessity | Description |
|---|---|---|
| Required | Provide the database host for Identity Service |
| Optional | Provide the database port for Identity Service Default: 5432 |
| Required | Provide the database user for Identity Service |
| Required | Provide the database password for Identity Service |
| Required | Define the information to initiate the administrator account. This account is to automatically do the following tasks:
|
| Required | Define the information to initiate the administrator account. This account is to automatically do the following tasks:
|
| Required | Define the information to initiate the administrator account. This account is to automatically do the following tasks:
|
| Optional | Define the information to initiate the administrator account. This account is to automatically do the following tasks:
|
| Required | Define the connection key in order to register to Control Center. Must be 4 to 64 characters long, using only letters and digits (0–9, a–z, A–Z). |
| Optional | Define the expose port for Identity Service Default: 8891 |
| Optional | Define the log level. Default value: info Accepted values: info/debug/error/warning |
Start Identity Service container with docker run:
2. MDDC File Storage
Environment Variable | Necessity | Description |
|---|---|---|
| Required | Define the connection key in order to register to Control Center. Must be 4 to 64 characters long, using only letters and digits (0–9, a–z, A–Z). |
| Optional | Define the expose port for File Storage Default: 8890 |
| Optional | Define the log level. Default value: info Accepted values: info/debug/error/warning |
Note: Persistent storage is located at /opt/opswat/mddc-file-storage. If end-users require data to be retained across container lifecycles, they must mount a volume to this path with 777 permissions to ensure full read/write access for all processes.
Start File Storage container with docker run
3. MDDC Control Center
Environment Variable | Necessity | Description |
|---|---|---|
| Optional | Provide the database host for Data Lake. In case that the end-user does not have the Data Lake, it's required to provide this variable to automate the database preparation |
| Optional | Provide the database port for Data Lake Default: 5432 |
| Optional | Provide the database user for Data Lake. In case that the end-user does not have the Data Lake, it's required to provide this variable to automate the database preparation |
| Optional | Provide the database password for Data Lake. In case that the end-user does not have the Data Lake, it's required to provide this variable to automate the database preparation |
| Optional | Provide the database host for Data Warehouse. In case that the end-user does not have the Data Warehouse, it's required to provide this variable to automate the database preparation |
| Optional | Provide the database port for Data Warehouse Default: 5432 |
| Optional | Provide the database user for Data Warehouse. In case that the end-user does not have the Data Warehouse, it's required to provide this variable to automate the database preparation |
| Optional | Provide the database password for Data Warehouse. In case that the end-user does not have the Data Warehouse, it's required to provide this variable to automate the database preparation |
| Optional | Provide the caching host (Redis). |
| Optional | Provide the caching port (Redis) |
| Optional | Provide the broker host (RabbitMQ) |
| Optional | Provide the broker port (RabbitMQ) |
| Optional | Provide the broker username (RabbitMQ) |
| Optional | Provide the broker password (RabbitMQ) |
| Required | Provide the database host for Control Center |
| Optional | Provide the database port for Control Center Default: 5432 |
| Required | Provide the database username for Control Center |
| Required | Provide the database password for Control Center |
| Required | Provide the administrator account that is defined in Identity Service. This account is to automatically do the following tasks:
|
| Required | Provide the administrator account that is defined in Identity Service. This account is to automatically do the following tasks:
|
| Optional | Provide the administrator account that is defined in Identity Service. This account is to automatically do the following tasks:
|
| Required | Provide the Identity Service host in order to add it to Control Center |
| Optional | Provide the Identity Service port in order to add it to Control Center Default: 8891 |
| Required | Provide the Identity Service connection key in order to add it to Control Center. Must be 4 to 64 characters long, using only letters and digits (0–9, a–z, A–Z). |
| Required | Define the encryption key for communication between Control Center and the services. Must be 32 characters long and contain only lowercase letters (a–z) and digits (0–9) |
| Required | Provide the File Storage host in order to add it to Control Center |
| Optional | Provide the File Storage port in order to add it to Control Center Default: 8890 |
| Required | Provide the File Storage connection key in order to add it to Control Center. Must be 4 to 64 characters long, using only letters and digits (0–9, a–z, A–Z). |
| Optional | Provide the directory path that contains the certificate and private key in order to enable https Note: when provide this variable, it's supposed to mount this path to |
| Optional | Define the log level. Default value: info Accepted values: info/debug/error/warning |
Start Control Center container with Docker run
4. MDDC Worker for API Gateway
Environment Variable | Necessity | Description |
|---|---|---|
| Required | Define the connection key in order to register to Control Center. Must be 4 to 64 characters long, using only letters and digits (0–9, a–z, A–Z). |
| Optional | Define the expose worker's port. Default: 8893 |
| Optional | Define the worker's host address. If it's not specified, it will get the container's internal IP address |
| Required | Provide the Control Center's host address |
| Optional | Provide the Control Center's port Default: 8892 |
| Required | Provide the administrator account that is defined in Identity Service. It can be optional if the end-user provides the MDDC_APIKEY. This account is to automatically do the following tasks:
|
| Required | Provide the administrator account that is defined in Identity Service. It can be optional if the end-user provides the MDDC_APIKEY. This account is to automatically do the following tasks:
|
| Optional | Provide the administrator account that is defined in Identity Service. This account is to automatically do the following tasks:
|
| Optional | Define the expose port to scan files via API Gateway Default: 8899 |
| Optional | Define the log level. Default value: info Accepted values: info/debug/error/warning |
Start Worker for API Gateway container with Docker run
5. MDDC Worker for Core
Environment Variable | Necessity | Description |
|---|---|---|
| Required | Define the connection key in order to register to Control Center. Must be 4 to 64 characters long, using only letters and digits (0–9, a–z, A–Z). |
| Optional | Define the expose worker's port. Default: 8893 |
| Optional | Define the worker's host address. If it's not specified, it will get the container's internal IP address |
| Required | Provide the Control Center's host address |
| Optional | Provide the Control Center's port. Default: 8892 |
| Required | Provide the administrator account that is defined in Identity Service. It can be optional if the end-user provides the MDDC_APIKEY. This account is to automatically do the following tasks:
|
| Required | Provide the administrator account that is defined in Identity Service. It can be optional if the end-user provides the MDDC_APIKEY. This account is to automatically do the following tasks:
|
| Optional | Provide the administrator account that is defined in Identity Service. This account is to automatically do the following tasks:
|
| Optional | Define the log level. Default value: info Accepted values: info/debug/error/warning |
| Optional | Provide the license key to activate MetaDefender Core |
| Optional | Define description of the license key |
Start Worker for Core container with Docker run:
Start MetaDefender Distributed Cluster with Docker Compose
Create a local file named
docker-compose.yamland copy the following content to this file:
Prepare an environment variable file named
.env.exampleand provide with your own valuesRun the application with the command:
Known limitation
When the host experiences resource limitations or degraded performance, some containers may fail to start properly. In such cases, restarting the container is recommended to restore normal operation.