The lines starting with a colon ';' or a hash '#' are comments, describing the option or of showing the default value.

The parameters must be adapted to your environment, in particular:

• global section: GatewayHome
• log section: LogLevel, LogTo, LogPath
• admin section: Host, Port
• database section: Type, Address, Name, User, Password

There are several ways to write a file or folder Windows path that are is compatible with the supported INI format by udmg-server.

Valid syntaxes:

LogPath = "C:/UDMG/UDMG Server/logs"
LogPath = "C://UDMG//UDMG Server//logs"
LogPath = "C:\\UDMG\\UDMG Server\\logs"
LogPath = C:\UDMG\UDMG Server\logs
LogPath = C:/UDMG/UDMG Server/logs

The first one, with the quotes and the forward slash, is recommended.
The following is an invalid syntax and raises an error message: cannot load server config: failed to parse the config file: cannot parse configuration: :<line number>: invalid syntax
LogPath = "C:\UDMG\UDMG Server\logs"

####################################
# The proxy section configures the
# UDMG Authentication Proxy
####################################
[proxy]
# Port, default "5775"
port = "5775"
# Network interface, default "0.0.0.0"
inet = "0.0.0.0"
#############################################
# Fine-tuning parameters,
# beware that this can affect the security or the performance
#############################################
# Enable recover on panic, default true, should be true for production environment
recover = true
# Enable Cross-Origin Resource Sharing (CORS), should be true for production environment
cors = true
# CORS domain: List of origins that may access the resource. Optional. Default value "*"
domain = "*"
# Enable CSRF protection, default false (set to true only if NGINX uses SSL/TLS)
csrf = false
# Enable request Track ID, default true
tracker = true
# Enable request logguer, default true
logger = true
# Rate limit IP request over 1 second, default 0 (unlimited)
limit = 0
# Enable the Prometheus metric endpoint '/metric', default false
metrics = false####################################
# The [service.*] subsections define the different services
# and authentication provider for target udmg-servers.
# There must be at least 1 service.
# The local authentication provided is enabled for all services.
# The service name is diplayed on UDMG Admin UI login page.
# It is implicitely defined by the section titles:
# [service.SERVICE_NAME]
# [[service.SERVICE_NAME.targets]]
# [service.SERVICE_NAME.settings]
# [service.SERVICE_NAME.auth.ldap]
# [service.SERVICE_NAME.auth.credentials]
# [service.SERVICE_NAME.auth.google]
# [service.SERVICE_NAME.auth.saml]
# [service.SERVICE_NAME.auth.openid]
# [service.SERVICE_NAME.auth.oauth]"*"
domain = "*"
# Enable CSRF protection, default false (set to true only if NGINX uses SSL/TLS)
csrf = false
# Enable request Track ID, default true
tracker = true
# Enable request logguer, default true
logger = true
# Rate limit IP request over 1 second, default 0 (unlimited)
limit = 0
# Enable the Prometheus metric endpoint '/metric', default false
metrics = false

####################################
# The [service.*] subsections define the different services
# and authentication provider for target udmg-servers.
# There must be at least 1 service.
# The local authentication provided is enabled for all services.
# The service name is diplayed on UDMG Admin UI login page.
# It is implicitely defined by the section titles:
# [service.SERVICE_NAME]
# [[service.SERVICE_NAME.targets]]
# [service.SERVICE_NAME.settings]
# [service.SERVICE_NAME.auth.ldap]
# [service.SERVICE_NAME.auth.credentials]
# [service.SERVICE_NAME.auth.google]
# [service.SERVICE_NAME.auth.saml]
# [service.SERVICE_NAME.auth.openid]
# [service.SERVICE_NAME.auth.oauth]
####################################
# Example of a service configuration for local authentication
####################################
[service.udmg]
# protocol for the UDMG Server REST API, either http or https
protocol = "http"
# switchover policy, only if several udmg-server instances can be reached by the authentication proxy instance
policy = "failover"

[[service.udmg.targets]]
# address of a target udmg-server instance, note the double square brackets
hostname = "localhost"
port = 18080

[service.udmg.settings]
#############################################
# Service Settings - this affects the UDMG Admin UI display
# The property name "udmg.xxx" must be enclosed in double quotes
#############################################
# Name of the system or environment
"udmg.system_identifier" = "UDMG"
# Color of the banner background, as HTML color name ("Brown"), RGB code ("rgb(165,42,42)"), or hexadecimal code ("#A52A2A")
"udmg.banner.background_color" = "transparent"
# Company logo, optional picture to display next to the system identifier (size should be 32x32 pixels), the path is relative to web server root directory
#"udmg.banner.logo" = "/assets/logo.png

####################################
# Example of a service configuration for local authenticationSSO
####################################
[service.udmg]
# protocol for the UDMG Server REST API, either http or https
protocol #[service.udmg_sso]
#protocol = "http"
# switchover policy, only if several udmg-server instances can be reached by the authentication proxy instance
policy #policy = "failover"
#
#[[service.udmg_sso.targets]]
# address of a target udmg-server instance, note the double square brackets
hostname #hostname = "localhost"
port #port = 18080
#
# Google SSO Provider
#[service.udmg_sso.auth.settings]
#############################################
# Service Settings - this affects the UDMG Admin UI display
# The property name "udmg.xxx" must be enclosed in double quotes
#############################################
# Name of the system or environment
"udmg.system_identifier" = "UDMG"
# Color of the banner background, as HTML color name ("Brown"), RGB code ("rgb(165,42,42)"), or hexadecimal code ("#A52A2A")
"udmg.banner.background_color" = "transparent"
# Company logo, optional picture to display next to the system identifier (size should be 32x32 pixels), the path is relative to web server root directory
#"udmg.banner.logo" = "/assets/logo.pnggoogle]
#file = "/path/to/config.json"
#
# SAML SSO Provider
#[service.udmg_sso.auth.saml]
#file = "/path/to/config.json"
#
# OpenID SSO Provider
#[service.udmg_sso.auth.openid]
#file = "/path/to/config.json"
#
# OAuth2 SSO Provider
#[service.udmg_sso.auth.oauth]
#file = "/path/to/config.json"

####################################
# Example of a service configuration for SSOLDAP
####################################
#[service.udmg_ssoldap]
#protocol = "http"
#policy = "failover"
#
#[[service.udmg_ssoldap.targetscredential]]
#hostname #username = "localhostldap_sync"
#port = 18080#password = "ldap_password"
#
# Google SSO Provider
#[[service.udmg_sso.auth.googleldap.targets]]
#file #hostname = "/path/to/config.jsonlocalhost"
##port = 18080
# SAML SSO Provider
#[service.udmg_ssoldap.auth.samlldap]
#file = "/path/to/udmg-ldap-config.json"#
# OpenID SSO Provider
#[service.udmg_sso.auth.openid]
#file = "/path/to/config.json"
#
# OAuth2 SSO Provider
#[service.udmg_sso.auth.oauth]
#file = "/path/to/config.json"

####################################
# Example of a service configuration for LDAP
####################################
#[service.udmg_ldap]
#protocol = "http"
#policy = "failover"
#
#[service.udmg_ldap.credential]
#username = "ldap_sync"
#password = "ldap_password"
#
#[[service.udmg_ldap.targets]]
#hostname = "localhost"
#port = 18080
#
#[service.udmg_ldap.auth.ldap]
#file = "udmg-ldap-config.json"

[agent]
# Listen IP AddressUDMG Agent Server Hostname or IP, and port
hostname = "0.0.0.0"
# Listen Port
port = "2222"
# SSH Priv Keypath to the SSH private key file
ssh_key = "C:/UDMG/UDMG Agent/agent/agent_key"
# SSH Public Keypath to the SSH public key file
ssh_key_pub = "C:/UDMG/UDMG Agent/agent/agent_key.pub"
# Agent Service User and password
username = "mftudmg"
# Service Password
password = "61ee8b5601a84d5154387578466c8998848ba089"

[client]
# Target UDMG Agent Proxy Server Hostname or IP, and port
hostname = "localhost"
# UDMG Agent Proxy Listen Port
port = "2222"

# UDMG Agent Service User and password
username = "mftudmg"
password = "61ee8b5601a84d5154387578466c8998848ba089"

# Default TTL to Connection RetryInterval between connection attempts to the UDMG Agent Server, default is 15 seconds.
ttl="5s"# UDMG Agent Client Admin API

[client.api]
# Listen PortUDMG Agent Client Admin API
port="2280"
# UDMG Server
[gateway]
# API basic authentication credentials, no default
username = "api_user"
password = "api_password"

[server]
# UDMG Server Hostname or IP, and port
hostname = "localhost"
port = "18080"
# UDMG Server Port
port = "18080"
# UDMG Server Username/Password
username = "admin"
password = "admin_password"

Username/Password
username = "admin"
password = "admin_password"
# UDMG API protocol, set to true to select https, default is false for http
secure = false
# UDMG API protocol, set to true to select https, default is false for http
secure = false

C:\UDMG\UDMG Agent\client>udmg-agent-client-service.exe install
2022-10-07 10:09:45,618 INFO  - Installing service 'UDMG Agent Client(UDMG Agent Client)'...
2022-10-07 10:09:45,683 INFO  - Service 'UDMG Agent Client (UDMG Agent Client)' was installed successfully.

C:\UDMG\UDMG Agent\client>udmg-agent-client-service.exe start
2022-10-07 10:09:52,852 INFO  - Starting service 'UDMG Agent Client (UDMG Agent Client)'...
2022-10-07 10:09:54,053 INFO  - Service 'UDMG Agent Client(UDMG Agent Client)' started successfully.

C:\UDMG\UDMG Agent\client>udmg-agent-client-service.exe status
Started