Title
Create new category
Edit page index title
Edit category
Edit link
MetaDefender Distributed Cluster Identity Service
Ignition file
The ignition file is required only for a fresh installation.
To install MetaDefender Distributed Cluster Identity Service server, ignition file in YML format is required at the following location:
Windows:
C:\opswat\mddc_identity_service.ymlLinux:
/etc/opswat/mddc_identity_service.yml
The ignition file includes keys
Key path | Value type | Accepted values | Required | Description |
|---|---|---|---|---|
secure.connection_key | string | A string from 4 to 64 character long containing digits from 0 to 9 and characters from a/A to z/Z | required | An arbitrary string that enables clients to connect to the server. Use this value for the key |
secure.private_key | string | required | Content of private key in X509 format. | |
secure.certificate | string | required | Content of certificate in X509 format. | |
database.host | string | required | IP address / domain name of the server where PostgreSQL server locates. | |
database.port | number | required | Port of PostgreSQL server is listening for connections from clients. | |
database.user | string | required | PostgreSQL server's user. SUPERUSER privilege is required to setup the server's database and extensions for the first time. | |
database.password | string | required | PostgreSQL server's user credentials. | |
rest.host | string | optional | IP address (V4/V6) or host where the server resides on. Default value is '*' Notes: value To bind the service to a specific interface, specify its IP address or domain name. For example, to listen on all IPv4 interfaces, set the host to | |
rest.port | number | optional | The port where the server resides on. Default value is 8891 | |
log.streams[@].log_type | string |
| optional | Type of log device. |
log.streams[@].log_level | string |
| optional | Level of log message. |
log.streams[@].log_path | string | If If
| optional | Location where logs are written. |
user.name | string | optional | User name for the initial administrator user account. | |
user.password | string | optional | Password for the initial administrator user account. | |
user.email | string | Basic email format, a string starts with non | optional | E-mail address for the initial administrator user account. |
user.apikey | string | string of exactly 36 characters composed of uppercase and lowercase letters (A-Z, a-z) and digits (0-9) | optional | API key for the initial administrator user account. |
Configuration file
After successfully installing, MetaDefender Distributed Cluster Identity Service generates a configuration file with changeable settings at the following location
Windows:
C:\Program Files\OPSWAT\MetaDefender Distributed Cluster Identity Service\mddc_identity_service.ymlLinux:
/etc/mddc-identity-service/mddc_identity_service.yml
The service must be restarted to take the new configurations into effect.
Sample
database.host, database.port, database.user, and database.password should be updated with the appropriate values of your Postgres host/IP, port, username, and password.
OpenSSL or a similar tool (e.g., ssh-keygen) can create a pair of public and private keys in X.509 format.