...
...
...
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
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.conf
under this directory (normallyC:\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 |
---|
|
- 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
curl
command:
Panel |
---|
|
This error (403) is excepted, since we don't have any asset deployed.
Notes:
...
Panel | |
---|---|
|
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 |
---|
|
or with the browser:
UDMG Server
Create a directory
C:\UDMG\
UDMG Gateway
Install the binaries as
andwaarp-gatewayd.exe
waarp-gateway.exe
- Create the configuration file
C:\UDMG\
UDMG Gateway\server.ini
Panel |
---|
|
...
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:\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
underC:\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 Windows | https://github.com/sheggi/win-service-nginx |
...