| Panel | |
|---|---|
|
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
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 eaxmple, from the Service Management Console management:
Create a user for UDMG Waarp Gateway
Login as PostgreSQL user, start the PostgreSQL Console (psql) and create the database user:
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;
GRANTFinally 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:
host all all 127.0.0.1/32 identto:
host all all 127.0.0.1/32 md5The 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):
|
NGINX Server
Note: The following steps require root privilege, be sure that you have the correct access before to continue.
Install a NGINX Server (nginx for Windows).
Run the following command to check the main NGINX configuration file:
C:\MFT\nginx-1.23.0> nginx -t
nginx: the configuration file C:\MFT\nginx-1.23.0/conf/nginx.conf syntax is ok
nginx: configuration file C:\MFT\nginx-1.23.0/conf/nginx.conf test is successfullyCreate a directory under the configuration folder called "enabled" and add an include directive in the main configuration file inside the http section. For example
http {
include mime.types;
default_type application/octet-stream;
include "C:/MFT/nginx-1.23.0/conf/enabled/*.conf"Create a configuration file mft.conf under this directory (normally C:\MFT\nginx-1.23.0\conf\enabled):
upstream mft_auth_proxy {
# MFT Auth Proxy Configuration
server localhost:5000;
}
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:
C:\MFT\nginx-1.23.0> nginx -t
nginx: the configuration file C:\MFT\nginx-1.23.0/conf/nginx.conf syntax is ok
nginx: configuration file C:\MFT\nginx-1.23.0/conf/nginx.conf test is successfullyCreate the Root directory under the NGINX main directory called mft:
C:\MFT\nginx-1.23.0> mkdir mftStart NGINX
...
, 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:
Create a user for UDMG Waarp Gateway
Login as PostgreSQL user, start the PostgreSQL Console (psql) and create the database user:
| Panel |
|---|
|
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 |
|---|
|
to:
| Panel |
|---|
|
For a system where the database server is on the same subnet as the UDMG server, change it to:
| Panel |
|---|
|
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 |
|---|
|
The current password encryption method can be returned by PostgreSQL Console (psql):
| Panel |
|---|
|
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 |
|---|
|
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 |
|---|
|
- Create a configuration file
mft.confunder this directory (normallyC:\UDMG\nginx\conf\enabled):
| Panel |
|---|
|
- Validate that the configuration is correct with the following command:
| Panel |
|---|
|
- Create the Root directory under the NGINX main directory called mft:
| Panel |
|---|
|
- Start NGINX
| Panel |
|---|
|
Check that the HTTP server was started and is running, for example with the
curlcommand:
| Panel |
|---|
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
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 |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
- Validate that the service is working properly with curl
| Panel |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
or with the browser:
UDMG Server
Create a directory
C:\UDMG\UDMG GatewayInstall the binaries as
waarp-gatewayd.exewaarp-gateway.exe- Create the configuration file
C:\MFTUDMG\MFTUDMG Gateway\server.ini
| Panel |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Install the binaries under C:\MFT\MFT Gateway as waarp-gatewayd and waarp-gateway
...
|
UDMG Authentication Proxy
Create a directory
C:\UDMG\MFT Auth ProxyInstall the binaries as
mft_auth_proxy_server.exeCreate the configuration file
C:\UDMG\MFT Auth Proxy\config.toml
| Panel |
|---|
|
...
|
...
|
...
Install the binary under C:\MFT\MFT Auth Proxy called mft_auth_proxy_server.exe
...
|
...
|
Configuration for LDAP Authentication
The UDMG Authentication Proxy is capable to use a LDAP Service to authenticate users for UDMG Admin UI:
| Panel |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| 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:
|
UDMG Agent Proxy
Create a directory
C:\MFTUDMG\MFTUDMG AgentInstall the binaries as
mft_agent_proxy_client.exeandmft_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 (https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_keymanagement)
...
Key-based authentication in OpenSSH for Windows), or by 3PP packages like Copssh - OpenSSH for Windows or Portable Git for Windows
| Panel |
|---|
|
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
After generating the key, export it with OpenSSH format:
Create a configuration file as
C:\MFTUDMG\MFTUDMG Agent\agent\agent.toml
| Panel |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
The password key will be used for the client authentication.
Client Configuration
Create a configuration file as as
C:\UDMG\UDMG Agent\client\client.toml
| Panel |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
The password key will be used for the client authentication.
Setup the Windows Services
UDMG Server
Open a PowerShell console and create a new service definition:
$params = @{
Name = "MFT Waarp Gateway Server"
BinaryPathName = '"C:\MFT\MFT Gateway\waarp-gatewayd.exe" server -c "C:\MFT\MFT Gateway\server.ini"'
DisplayName = "MFT Waarp Gateway Server"
StartupType = "Automatic"
Description = "MFT Waarp Gateway Server."
}
New-Service @paramsStart the service and check the status:
Start-Service "MFT Waarp Gateway Server"Be sure that the listen port and network interface is reachable by UDMG Authentication Proxy and UDMG Agent Client.
UDMG Authentication Proxy
Create a new service definition:
$params = @{
Name = "MFT Auth Proxy"
BinaryPathName = 'MFT_AUTH_PROXY_CONFIG=config.toml "C:\MFT\MFT Auth Proxy\server.exe"'
DisplayName = "MFT Auth Proxy server"
StartupType = "Automatic"
Description = "MFT Auth Proxy server."
}
New-Service @paramsStart the service and check the status:
Start-Service "MFT Auth Proxy server"Be sure that the listen port and network interface is reachable by NGINX Server.
UDMG Agent Proxy
Agent Proxy Server Service
Create a new service definition:
$params = @{
Name = "MFT Agent Server"
BinaryPathName = 'MFT_AUTH_PROXY_CONFIG=config.toml "C:\MFT\MFT Agent\server\server.exe"'
DisplayName = "MFT Agent Server"
StartupType = "Automatic"
Description = "MFT Agent server."
}
New-Service @paramsStart the service and check the status:
Start-Service "MFT Agent Server"Be sure that the listen port and network interface is reachable by UDMG Agent Client .
Agent Proxy Client Service
Create a new service definition:
$params = @{
Name = "MFT Agent Client"
BinaryPathName = 'MFT_AUTH_PROXY_CONFIG=config.toml "C:\MFT\MFT Agent\client\server.exe"'
DisplayName = "MFT Agent Client"
StartupType = "Automatic"
Description = "MFT Agent Client."
}
New-Service @paramsStart the service and check the status:
...
|
...
|
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
- Download WinSX and copy
winsw.exeunderC:\UDMG\nginxwith the following name:nginx-service.exe - Create a new service definition file:
nginx-service.yml
| Panel |
|---|
|
- Create a stop script:
nginx-stop.cmd
| Panel |
|---|
|
- Start the service and check the status:
| Panel |
|---|
|
UDMG Server
- Download WinSX and copy
winsw.exeunderC:\UDMG\UDMG Gatewaywith the following name:waarp-gatewayd-service.exe - Create a new service definition file:
waarp-gatewayd-service.yml
| Panel |
|---|
|
- Start the service and check the status:
| Panel |
|---|
|
Be sure that the listen port and network interface is reachable by UDMG Authentication Proxy and UDMG Agent Client.
UDMG Authentication Proxy
- Copy
winsw.exeunderC:\UDMG\with the following name:UDMG Auth Proxymft_auth_proxy_server-service.exe - Create a new service definition file:
mft_auth_proxy_server-service.yml
| Panel |
|---|
|
- Start the service and check the status:
| Panel |
|---|
|
Be sure that the listen port and network interface is reachable by NGINX Server.
UDMG Agent Proxy
Agent Proxy Server Service
- Copy
winsw.exeunderC:\UDMG\UDMG Agent\agentwith the following name:mft_agent_proxy_server-service.exe - Create a new service definition file:
mft_agent_proxy_server-service.yml
| Panel |
|---|
|
- Start the service and check the status:
| Panel |
|---|
|
Be sure that the listen port and network interface is reachable by UDMG Agent Client .
Agent Proxy Client Service
- Copy
winsw.exeunderC:\UDMG\UDMG Agent\clientwith the following name:mft_agent_proxy_client-service.exe - Create a new service definition file:
mft_agent_proxy_client-service.yml
| Panel |
|---|
|
- Start the service and check the status:
| Panel |
|---|
|
Component Ports
Make sure that all the ports needed are open under your firewall configuration.
References
This document references the following documents.
Name | Location |
|---|---|
PostgreSQL Client Authentication |
https://www.postgresql.org/docs/current/auth-pg-hba-conf.html
PostgreSQL Password Authentication | |
| Guide on setting up Nginx as a service on Windows | https:// |
| github. |
| com/ |
| sheggi/win-service-nginx |