Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Table of Contents

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

  1. Create a blank database on the server. An already existing database can be used, but this is not recommended.

  2. 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

  • Start NGINX
Panel

# start nginx

  • 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:

...


Panel

Table of Contents

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.

...

  • 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 RemovedImage Added

UDMG Server

  • Create a directory C:\UDMG\UDMG Gateway

  • Install the binaries as waarp-gatewayd.exe and waarp-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

...

Use PuTTYgen to generate a key pair for the agent, more detailled instructions can be found here: Using public keys for SSH authentication

Image RemovedImage Added

After generating the key, export it with OpenSSH format:

Image RemovedImage Added

  • Create a configuration file as C:\UDMG\UDMG Agent\agent\agent.toml

...

The UDMG components can be installed as Windows service with the WinSX tool.

NGINX Server

  • Download WinSX and copy winsw.exe under C:\UDMG\nginx with the following name: nginx-service.exe
  • Create a new service definition file: nginx-service.yml

...

Name

Location

PostgreSQL Client Authentication

PostgreSQL Password Authentication

Guide on setting up Nginx as a service on Windowshttps://github.com/sheggi/win-service-nginx

...