...
...
Requirements
System Requirements
Windows Server 2012 R2 (or Windows 8.1) and later
NGINX web server (1.20 and later)
PostgreSQL database (11 and later)
UDMG distribution files for the different modules:
UDMG Admin UI
UDMG Authentication Proxy
UDMG Server (Waarp Gateway)
UDMG Agent Proxy, this module is optional
- An account with administrative privileges for the installation.
- Network connectivity via TCP/IP.
- Approximately 100 megabytes of disk space for the installation. More disk space is required for log files.
- A dedicated account for the execution of the UDMG components, with write access to the storage location for the files that will be managed by UDMG.
WinSX (https://github.com/winsw/winsw/releases/tag/v2.11.0) for service management, optional.
Database Space Requirements
Following the initialization of the Universal Data Mover Gateway database, the initial table space size will be approximately 10MB.
Based on calculations using data from all transfer types, each file transfer consumes approximately 2KB of database space. You should estimate space requirements for your data based on your expected number of file transfers per day and the duration for retaining history and activity data before purging.
Installing and Configuring the Components
PostgreSQL Database
Create a blank database on the server. An already existing database can be used, but this is not recommended.
Add a user that will be used as the owner of the related tables but also to authenticate with the server.
In order to install or perform upgrades, this database user will require DDL (Data Definition Language) permission in the database during the installation or the upgrade.
Once the install or upgrade has been completed successfully, the configured database user requires only DML (Data Manipulation Language) permissions.
Here is how to configure the database for a local installation where the database server is on the same host. For multi-node installation please refer to your database administrator.
Note: The following steps require Administrator privilege, be sure that you have the correct access before continuing.
Install a PostgreSQL database server.
Once the installation is complete, initialize the PostgreSQL database.
Start the PostgreSQL Server:
For example, from the Service Management Console management:
Image Removed
Create a user for UDMG Waarp Gateway
Login as PostgreSQL user, start the PostgreSQL Console (psql) and create the database user:
Image Removed
| Panel |
|---|
postgres=# create database mft_waarp_gateway;
CREATE DATABASE
postgres=# create user mft_waarp_gateway_user with encrypted password 'mft_waarp_gateway_password';
CREATE ROLE
postgres=# grant all privileges on database mft_waarp_gateway to mft_waarp_gateway_user;
GRANT
|
Finally change the pg_hba.conf, to allow database connection with password.
For example, for a system where the database server is on the same host as the UDMG server, by changing this line from:
| Panel |
|---|
host all all 127.0.0.1/32 ident
|
to:
| Panel |
|---|
host all all 127.0.0.1/32 scram-sha-256
|
For a system where the database server is on the same subnet as the UDMG server, change it to:
| Panel |
|---|
host all all samenet scram-sha-256
|
The exact configuration depends on the OS and database version, on the preferred security settings, and on the system architecture.
The location of the pg_hba.conf can be returned by PostgreSQL Console (psql):
| Panel |
|---|
postgres=# SHOW hba_file;
|
The current password encryption method can be returned by PostgreSQL Console (psql):
| Panel |
|---|
postgres=# SHOW password_encryption;
|
NGINX Server
Note: The following steps require Administrator privileges, be sure that you have the correct access before to continue.
Install NGINX (see nginx for Windows), for example under C:\UDMG\nginx.
Run the following command to check the main NGINX configuration file:
| Panel |
|---|
C:\UDMG\nginx> nginx -t
nginx: the configuration file C:\UDMG\nginx/conf/nginx.conf syntax is ok
nginx: configuration file C:\UDMG\nginx/conf/nginx.conf test is successfully
|
Create a directory under the configuration folder called "enabled" and add an include directive in the main configuration file inside the http section. For example:
| Panel |
|---|
http {
include mime.types;
default_type application/octet-stream;
include "C:/MFT/nginx/conf/enabled/*.conf";
|
- Create a configuration file
mft.conf under this directory (normally C:\UDMG\nginx\conf\enabled):
...
server {
listen 8080;
server_name localhost;
access_log logs//mft.access.log;
location /service/ {
proxy_pass http://mft_auth_proxy/;
}
location / {
try_files $uri $uri/ /index.html;
root mft;
}
}
- Validate that the configuration is correct with the following command:
| Panel |
|---|
C:\UDMG\nginx> nginx -t
nginx: the configuration file C:\UDMG\nginx/conf/nginx.conf syntax is ok
nginx: configuration file C:\UDMG\nginx/conf/nginx.conf test is successfully
|
- Create the Root directory under the NGINX main directory called mft:
| Panel |
|---|
C:\UDMG\nginx> mkdir mft
|
Check that the HTTP server was started and is running, for example with the curl command:
| Panel |
|---|
C:\>curl.exe http://localhost:8080
<html>
<head><title>403 Forbidden</title></head>
<body>
<center><h1>403 Forbidden</h1></center>
<hr><center>nginx/1.23.0</center>
</body>
</html>
|
This error (403) is excepted, since we don't have any asset deployed.
Notes:
- For configuring HTTPS and HTTP redirection, please refer to the web server documentation (Configuring HTTPS servers).
- Paths in an NGINX configuration file must be specified in UNIX-style using forward slashes '/'.
UDMG Admin UI
Uncompress the tar file for MFT Admin UI, under the directory that we created during the configuration.
| Panel |
|---|
C:\UDMG\nginx\mft> tar -x -f mft_admin_ui-<version>.zip
|
- Validate that the service is working properly with curl
| Panel |
|---|
C:\>curl.exe http://localhost:8080 -I
HTTP/1.1 200 OK
Server: nginx/1.23.0
Date: Thu, 07 Jul 2022 17:53:09 GMT
Content-Type: text/html
Content-Length: 7788
Last-Modified: Fri, 01 Jul 2022 13:58:15 GMT
Connection: keep-alive
ETag: "62befd77-1e6c"
Accept-Ranges: bytes
|
or with the browser:
Image Removed
UDMG Server
Create a directory C:\UDMG\UDMG Gateway
Install the binaries as waarp-gatewayd.exewaarp-gateway.exe
- Create the configuration file
C:\UDMG\UDMG Gateway\server.ini with the following parameters:
| Panel |
|---|
[global]
; The name given to identify this gateway instance. If the the database is shared between multiple gateways, this name MUST be unique across these gateways.
GatewayName = mft_waarp_gateway
[paths]
; The root directory of the gateway. By default, it is the working directory of the process.
; GatewayHome = /home/mft
; The directory for all incoming files.
; DefaultInDir = in
; The directory for all outgoing files.
; DefaultOutDir = out
; The directory for all running transfer files.
; DefaultTmpDir = tmp
[log]
; All messages with a severity above this level will be logged. Possible values are DEBUG, INFO, WARNING, ERROR and CRITICAL.
Level = DEBUG
; The path to the file where the logs must be written. Special values 'stdout' and 'syslog' log respectively to the standard output and to the syslog daemon
; LogTo = stdout
; If LogTo is set on 'syslog', the logs will be written to this facility.
; SyslogFacility = local0
[admin]
; The address used by the admin interface.
Host = 0.0.0.0
; The port used by the admin interface. If the port is 0, a free port will automatically be chosen.
Port = 18080
; Path of the TLS certificate for the admin interface.
; TLSCert =
; Path of the key of the TLS certificate.
; TLSKey =
[database]
; Name of the RDBMS used for the gateway database. Possible values: sqlite, mysql, postgresql
Type = postgresql
; Address of the database
Address = localhost
; The name of the database
Name = mft_waarp_gateway
; The name of the gateway database user
User = mft_waarp_gateway_user
; The password of the gateway database user
Password = mft_waarp_gateway_password
; Path of the database TLS certificate file.
; TLSCert =
; Path of the key of the TLS certificate file.
; TLSKey =
; The path to the file containing the passphrase used to encrypt account passwords using AES
; AESPassphrase = passphrase.aes
[controller]
; The frequency at which the database will be probed for new transfers
Delay = 5s
; The maximum number of concurrent incoming transfers allowed on the gateway (0 = unlimited).
; MaxTransferIn = 0
; The maximum number of concurrent outgoing transfers allowed on the gateway (0 = unlimited).
; MaxTransferOut = 0
[sftp]
; Set to true to allow legacy and weak cipher algorithms: 3des-cbc, aes128-cbc, arcfour, arcfour128, arcfour256
; AllowLegacyCiphers = false
|
UDMG Authentication Proxy
Create a directory C:\UDMG\MFT Auth Proxy
Install the binaries as mft_auth_proxy_server.exe
Create the configuration file C:\UDMG\MFT Auth Proxy\config.toml with the following parameters:
| Panel |
|---|
# Proxy Configuration
[proxy]
# Port, default "5000"
port = "5000"
# Network interface, default "0.0.0.0"
inet = "127.0.0.1"
# 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
# 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
# Service 'local' with direct authentication on the waarp gateway
[service.local]
# MFT Waarp Gateway Listen Protocol
protocol = "http"
[[service.local.targets]]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = 18080
# Service 'mft' with direct authentication on the waarp gateway
[service.mft]
# MFT Waarp Gateway Listen Protocol
protocol = "http"
[[service.mft.targets]]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = 18080
|
Configuration for LDAP Authentication
The UDMG Authentication Proxy is capable to use a LDAP Service to authenticate users for UDMG Admin UI:
...
# Service 'local' with direct authentication on the waarp gateway
[service.local]
# MFT Waarp Gateway Listen Protocol
protocol = "http"
[[service.local.targets]]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = 18080
...
[[service.mft.targets]]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = 18080
# User for Sync Password Between Ldap and Proxy
[service.mft.credential]
# Pre - Setup user under MFT Waarp Gateway
username = "ldap_sync"
password = "ldap_password"
# LDAP Configuration
[service.mft.auth.ldap]
# LDAP Server DC with OU
dn = "ou=users,dc=stonebranch,dc=com"
# LDAP Server FQDN or IP
hostname = "myldap.server.fqdn.com"
# LDAP Server pORT
port = 1389
| Note |
|---|
The LDAP replication requires a user with permission for creating and updating users. For example to create the 'ldap_sync' user with the command line interface: waarp_gateway user add -u ldap_sync -p ldap_password -r 'U=rw'
In case of successful authentication on the LDAP, the user is created with default read permission in the internal UDMG database if it does not exist. Otherwise the credentials are updated in the database to allow for authentication on the REST and CLI interfaces.
|
UDMG Agent Proxy
Create a directory C:\UDMG\UDMG Agent
Install the binaries as mft_agent_proxy_client.exe and mft_agent_proxy_server.exe
Agent Configuration
Generate a SSH Key for the service.
For example with the ssh-keygen tool that is provided by Windows OpenSSH tools (
Image RemovedKey-based authentication in OpenSSH for Windows), or by 3PP packages like Copssh - OpenSSH for Windows or Portable Git for Windows
...
Installing and Configuring the Components
UDMG Admin UI
Uncompress the tar file for MFT Admin UI, under the directory that we created during the configuration.
| Panel |
|---|
C:\UDMG\nginx\mft> tar -x -f mft_admin_ui-<version>.zip
|
- Validate that the service is working properly with curl
| Panel |
|---|
C:\>curl.exe http://localhost:8080 -I
HTTP/1.1 200 OK
Server: nginx/1.23.0
Date: Thu, 07 Jul 2022 17:53:09 GMT
Content-Type: text/html
Content-Length: 7788
Last-Modified: Fri, 01 Jul 2022 13:58:15 GMT
Connection: keep-alive
ETag: "62befd77-1e6c"
Accept-Ranges: bytes
|
or with the browser:
Image Added
UDMG Server
Create a directory C:\UDMG\UDMG Gateway
Install the binaries as waarp-gatewayd.exewaarp-gateway.exe
- Create the configuration file
C:\UDMG\UDMG Gateway\server.ini with the following parameters:
| Panel |
|---|
[global]
; The name given to identify this gateway instance. If the the database is shared between multiple gateways, this name MUST be unique across these gateways.
GatewayName = mft_waarp_gateway
; Default OS permission for created files
; FilePermissions = 700
; Default OS permission for created directories
; DirPermissions = 750
[paths]
; The root directory of the gateway. By default, it is the working directory of the process.
; GatewayHome = /home/mft
; The directory for all incoming files.
; DefaultInDir = in
; The directory for all outgoing files.
; DefaultOutDir = out
; The directory for all running transfer files.
; DefaultTmpDir = tmp
[log]
; All messages with a severity above this level will be logged. Possible values are DEBUG, INFO, WARNING, ERROR and CRITICAL.
Level = DEBUG
; The path to the file where the logs must be written. Special values 'stdout' and 'syslog' log respectively to the standard output and to the syslog daemon
; LogTo = stdout
; If LogTo is set on 'syslog', the logs will be written to this facility.
; SyslogFacility = local0
[admin]
; The address used by the admin interface.
Host = 0.0.0.0
; The port used by the admin interface. If the port is 0, a free port will automatically be chosen.
Port = 18080
; Path of the TLS certificate for the admin interface.
; TLSCert =
; Path of the key of the TLS certificate.
; TLSKey =
[database]
; Name of the RDBMS used for the gateway database. Possible values: sqlite, mysql, postgresql
Type = postgresql
; Address of the database
Address = localhost
; The name of the database
Name = mft_waarp_gateway
; The name of the gateway database user
User = mft_waarp_gateway_user
; The password of the gateway database user
Password = mft_waarp_gateway_password
; Path of the database TLS certificate file.
; TLSCert =
; Path of the key of the TLS certificate file.
; TLSKey =
; The path to the file containing the passphrase used to encrypt account passwords using AES
; AESPassphrase = passphrase.aes
[controller]
; The frequency at which the database will be probed for new transfers
Delay = 5s
; The maximum number of concurrent incoming transfers allowed on the gateway (0 = unlimited).
; MaxTransferIn = 0
; The maximum number of concurrent outgoing transfers allowed on the gateway (0 = unlimited).
; MaxTransferOut = 0
[sftp]
; Set to true to allow legacy and weak cipher algorithms: 3des-cbc, aes128-cbc, arcfour, arcfour128, arcfour256
; AllowLegacyCiphers = false
|
UDMG Authentication Proxy
Create a directory C:\UDMG\MFT Auth Proxy
Install the binaries as mft_auth_proxy_server.exe
Create the configuration file C:\UDMG\MFT Auth Proxy\config.toml with the following parameters:
| Panel |
|---|
# Proxy Configuration
[proxy]
# Port, default "5000"
port = "5000"
# Network interface, default "0.0.0.0"
inet = "127.0.0.1"
# 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
# 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
# Service 'local' with direct authentication on the waarp gateway
[service.local]
# MFT Waarp Gateway Listen Protocol
protocol = "http"
[[service.local.targets]]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = 18080
# Service 'mft' with direct authentication on the waarp gateway
[service.mft]
# MFT Waarp Gateway Listen Protocol
protocol = "http"
[[service.mft.targets]]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = 18080
|
Configuration for LDAP Authentication
The UDMG Authentication Proxy is capable to use a LDAP Service to authenticate users for UDMG Admin UI:
| Panel |
|---|
# Proxy Configuration
[proxy]
# Port, default "5000"
port = "5000"
# Network interface, default "0.0.0.0"
inet = "127.0.0.1"
# 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
# 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
# Service 'local' with direct authentication on the waarp gateway
[service.local]
# MFT Waarp Gateway Listen Protocol
protocol = "http"
[[service.local.targets]]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = 18080
# Service 'mft' with LDAP Authentication
[service.mft]
# MFT Waarp Gateway Listen Protocol
protocol = "http"
# This option is breaking glass option for admins, they will not reach the LDAP service during the Auth Stage
admins = ["admin"]
[[service.mft.targets]]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = 18080
# User for Sync Password Between Ldap and Proxy
[service.mft.credential]
# Pre - Setup user under MFT Waarp Gateway
username = "ldap_sync"
password = "ldap_password"
# LDAP Configuration
[service.mft.auth.ldap]
# LDAP Server DC with OU
dn = "ou=users,dc=stonebranch,dc=com"
# LDAP Server FQDN or IP
hostname = "myldap.server.fqdn.com"
# LDAP Server pORT
port = 1389
|
| Note |
|---|
The LDAP replication requires a user with permission for creating and updating users. For example to create the 'ldap_sync' user with the command line interface: waarp_gateway user add -u ldap_sync -p ldap_password -r 'U=rw'
In case of successful authentication on the LDAP, the user is created with default read permission in the internal UDMG database if it does not exist. Otherwise the credentials are updated in the database to allow for authentication on the REST and CLI interfaces.
|
UDMG Agent Proxy
Create a directory C:\UDMG\UDMG Agent
Install the binaries as mft_agent_proxy_client.exe and mft_agent_proxy_server.exe
Agent Configuration
Generate a SSH Key for the service.
For example with the ssh-keygen tool that is provided by Windows OpenSSH tools (Image AddedKey-based authentication in OpenSSH for Windows), or by 3PP packages like Copssh - OpenSSH for Windows or Portable Git for Windows
| Panel |
|---|
# ssh-keygen -t rsa -q -N "" -f "C:\UDMG\UDMG Agent\agent_key"
# ssh-keygen -t rsa -q -N "" -f "C:\UDMG\UDMG Agent\client_key"
|
If OpenSSH is not installed or not available, the PuTTY tool can be used instead.
Use PuTTYgen to generate a key pair for the agent, more detailled instructions can be found here: Using public keys for SSH authentication
Image Added
After generating the key, export it with OpenSSH format:
Image Added
Create a configuration file as C:\UDMG\UDMG Agent\agent\agent.toml
| Panel |
|---|
[agent]
# Listen IP Address
hostname = "0.0.0.0"
# Listen Port
port = "2222"
# SSH Priv Key
ssh_key = "C:\UDMG\UDMG Agent\agent_key"
# SSH Public Key
ssh_key_pub = "C:\UDMG\UDMG Agent\agent_key.pub"
# Service User
username = "mft"
# Service Password
password = "61ee8b5601a84d5154387578466c8998848ba089"
|
The password key will be used for the client authentication.
Client Configuration
Create a configuration file as C:\UDMG\UDMG Agent\client\client.toml
| Panel |
|---|
[client]
# UDMG Agent Proxy Hostname or IP
hostname = "localhost"
# UDMG Agent Proxy Listen Port
port = "2222"
# SSH Priv Key
ssh_key = "C:\UDMG\UDMG Agent\client_key"
|
If OpenSSH is not installed or not available, the PuTTY tool can be used instead.
Use PuTTYgen to generate a key pair for the agent, more detailled instructions can be found here: Using public keys for SSH authentication
Image Removed
After generating the key, export it with OpenSSH format:
Image Removed
...
# SSH Public Key
ssh_key_pub = "C:\UDMG\UDMG Agent\
|
...
| Panel |
|---|
[agent]
# Listen IP Address
hostname = "0.0.0.0"client_key.pub"
# Service User
username = "mft"
# Service Password
password = "61ee8b5601a84d5154387578466c8998848ba089"
# Default TTL to Connection Retry
ttl="5s"
# UDMG Agent Client Admin API
[client.api]
# Listen Port
port="2222"
# SSH Priv Key
ssh_key = "C:\UDMG\UDMG Agent\agent_key"
# SSH Public Key
ssh_key_pub = "C:\UDMG\UDMG Agent\agent_key.pub"# Service User
username = "mft"
# Service Password
password = "61ee8b5601a84d5154387578466c8998848ba0892280"
# MFT Waarp Gateway
[gateway]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = "18080"
# MFT Waarp Gateway Username/Password
username = "admin"
password = "admin_password"
|
The password key will be used for the client authentication.
Client Configuration
Create a configuration file as C:\UDMG\UDMG Agent\client\client.toml
| Panel |
|---|
[client]
# UDMG Agent Proxy Hostname or IP
hostname = "localhost"
# UDMG Agent Proxy Listen Port
port = "2222"
# SSH Priv Key
ssh_key = "C:\UDMG\UDMG Agent\client_key"
# SSH Public Key
ssh_key_pub = "C:\UDMG\UDMG Agent\client_key.pub"
# Service User
username = "mft"
# Service Password
password = "61ee8b5601a84d5154387578466c8998848ba089"
# Default TTL to Connection Retry
ttl="5s"
# UDMG Agent Client Admin API
[client.api]
# Listen Port
port="2280"
# MFT Waarp Gateway
[gateway]
# MFT Waarp Gateway Hostname or IP
hostname = "localhost"
# MFT Waarp Gateway Port
port = "18080"
# MFT Waarp Gateway Username/Password
username = "admin"
password = "admin_password"
|
The password key will be used for the client authentication.
Setup the Windows Services
The UDMG components can be installed as Windows service with the WinSX tool.
NGINX Server
...
.
Setup the Windows Services
The UDMG components can be installed as Windows service with the WinSW tool.
NGINX Server
- Download WinSW and copy
winsw.exe under C:\UDMG\nginx with the following name: nginx-service.exe - Create a new service definition file:
nginx-service.yml
| Panel |
|---|
id: NGINX
name: NGINX Service
description: Runs the nginx.exe as a service
executable: C:\UDMG\nginx\nginx.exe
stopexecutable: C:\UDMG\nginx\nginx-stop.cmd
logpath: C:\UDMG\nginx\logs
logmode: roll
|
- Create a stop script:
nginx-stop.cmd
| Panel |
|---|
@echo off
cd /D %~dp0
if not exist logs\nginx.pid GOTO skip
nginx.exe -s quit
del logs\nginx.pid
:skip
taskkill /f /IM nginx.exe
|
- Start the service and check the status:
| Panel |
|---|
C:\UDMG\nginx>nginx-service.exe install
2022-10-07 10:20:20,724 INFO - Installing service 'NGINX Service (NGINX)'...
2022-10-07 10:20:20,777 INFO - Service 'NGINX Service (NGINX)' was installed successfully.
C:\UDMG\nginx>nginx-service.exe status
Stopped
C:\UDMG\nginx>nginx-service.exe start
2022-10-07 10:20:40,213 INFO - Starting service 'NGINX Service (NGINX)'...
2022-10-07 10:20:41,327 INFO - Service 'NGINX Service (NGINX)' started successfully.
C:\UDMG\nginx>nginx-service.exe status
Started
|
UDMG Server
- Download WinSW and copy
winsw.exe under C:\UDMG\nginxUDMG Gateway with the following name: nginxwaarp-gatewayd-service.exe - Create a new service definition file:
nginxwaarp-gatewayd-service.yml
Here is the minimal version of the file with the required configuration parameters, make sure that the paths are correct
| Panel |
|---|
id: NGINXUDMG Server
name: NGINX ServiceUDMG Server
description: Runs the nginx.exe as a serviceUDMG Server
executable: C:\UDMG\nginx\nginxUDMG Server\udmg-server.exe
stopexecutablestartArguments: server -c "C:\UDMG\nginx\nginx-stop.cmd
logpath: C:\UDMG\nginx\logs
logmode: roll
|
- Create a stop script:
nginx-stop.cmd
| Panel |
|---|
@echo off
cd /D %~dp0
if not exist logs\nginx.pid GOTO skip
nginx.exe -s quit
del logs\nginx.pid
:skip
taskkill /f /IM nginx.exe
|
- Start the service and check the status:
| Panel |
|---|
C:\UDMG\nginx>nginx-service.exe install
2022-10-07 10:20:20,724 INFO - Installing service 'NGINX Service (NGINX)'...
2022-10-07 10:20:20,777 INFO - Service 'NGINX Service (NGINX)' was installed successfully.
C:\UDMG\nginx>nginx-service.exe status
Stopped
C:\UDMG\nginx>nginx-service.exe start
2022-10-07 10:20:40,213 INFO - Starting service 'NGINX Service (NGINX)'...
2022-10-07 10:20:41,327 INFO - Service 'NGINX Service (NGINX)' started successfully.
C:\UDMG\nginx>nginx-service.exe status
Started
|
UDMG Server
- Download WinSX and copy
winsw.exe under C:\UDMG\UDMG Gateway with the following name: waarp-gatewayd-service.exe - Create a new service definition file:
waarp-gatewayd-service.yml
| Panel |
|---|
id: UDMG Server
name: UDMG Waarp Gateway Server
description: UDMG Waarp Gateway Server
executable: C:\UDMG\UDMG Gateway\waarp-gatewayd.exe
startArguments: server -c "C:\UDMG\UDMG Gateway\server.ini"
workingdirectory: C:\UDMG\UDMG Gateway
priority: NormalUDMG Server\server.ini"
workingdirectory: C:\UDMG\UDMG Server
priority: Normal
|
Here is another version with the full set of parameters and their description, it can be used as a template for tweaking the service settings.
| Panel |
|---|
## UDMG server service configuration
##
## references:
## https://github.com/winsw/winsw/blob/v2.11.0/doc/yamlConfigFile.md
## https://github.com/winsw/winsw/blob/v2.11.0/examples/sample-allOption.yml
id: UDMG Server
name: UDMG Server
description: UDMG Server
## SECTION: Installation
## These options are being used during the installation only.
## Their modification will not take affect without the service re-installation.
##
## service account can be given during the installation with /p parameter
## waarp-gatewayd-service-user.exe install /p
## and then providing username
onFailure:
-
action: restart
delay: 10 sec
-
action: restart
delay: 60 sec
-
action: none
#resetFailure: 01:00:00
## SECTION: Executable management
executable: C:\UDMG\UDMG Server\udmg-server.exe
startArguments: >
server
-c "C:\UDMG\UDMG Server\server.ini"
workingdirectory: C:\UDMG\UDMG Server
priority: Normal
#stopTimeout: 15 sec
#stopParentProcessFirst: true
## SECTION: Service management
#startMode: Automatic
#delayedAutoStart: true
## SECTION:Logging
## Note: disabled due to WinSW bug https://github.com/winsw/winsw/issues/1016
#log:
# mode: roll-by-size-time
# sizeThreshold: 10240
# keepFiles: 8
# pattern: yyyyMMdd
# autoRollAtTime: 00:00:00
## SECTION: Environment setup
## SECTION: Extensions
## This configuration section allows specifying custom extensions.
## More info is available here: https://github.com/kohsuke/winsw/blob/v2.11.0/doc/extensions/extensions.md
|
| Note |
|---|
|
The rollover of the service log file is disabled as it causes a bug of the WinSW application, see https://github.com/winsw/winsw/issues/1016. |
- Start the service and check the status:
...
UDMG Authentication Proxy
- Copy
Download WinSW and copy winsw.exe under C:\UDMG\UDMG Auth Proxy with the following name: mft_auth_proxy_server-service.exe - Create a new service definition file:
mft_auth_proxy_server-service.yml
...
Agent Proxy Server Service
- CopyDownload WinSW and copy
winsw.exe under C:\UDMG\UDMG Agent\agent with the following name: mft_agent_proxy_server-service.exe - Create a new service definition file:
mft_agent_proxy_server-service.yml
...
...
