Determining Installation Requirements

System Requirements

System Requirements for Linux

  • Linux x64 (kernel 3.10 and later, glibc 2.17-78 and later), x86_64 based or Debian based

  • NGINX web server (1.20 and later)

  • PostgreSQL database (12 and later) or MySQL (8 and later)

  • UDMG distribution files for the different modules:

    • UDMG Admin UI

    • UDMG Authentication Proxy

    • UDMG Server

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

System Requirements for Windows

  • Windows Server 2012 R2 (or Windows 8.1) and later

  • NGINX web server (1.20 and later)

  • PostgreSQL database (12 and later)

  • UDMG distribution files for the different modules:

    • UDMG Admin UI

    • UDMG Authentication Proxy

    • UDMG Server

    • 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.
  • WinSW (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.

UDMG Server Space Requirement

UDMG allows to define a complex folder structure for the storage of the local files. The final and temporary location of a file for a given transfer scenario can be set by means of the global configuration, or at the Server level, or by the transfer rule which itself depends on the combination of partner/server, account and the requested target path. This allows to split into different folder and/or filesystems according to the business cases, for security requirements, or access speed, or space management. For more details please refer to the UDMG Server configuration file, the creation and update of Server entities, and the creation and update of Transfer Rules.
The Temp Directory (also denoted as 'tmpReceiveDir') is only utilized for file transfer where UDMG is on the receiving end (either by actively downloading a file as a client, or by being pushed a file as a server). This is were the partial content is stored until the completion of the file data exchange between server an client. At the end of the transfer, the temporary file is moved to its target location that was defined by the transfer rule Local Directory (or the default value from the Server entity Receive Directory, or in turn by the default from UDMG Server global configuration).
All the final and temporary folder locations must be large enough to accommodate the expected volume of files and their retention period (to be handled outside of UDMG). For example, let's assume a transfer scenario with a daily download of a 1.5 Tb file, a weekly retention is setup with the removal of file older that 7 days, a setup where the temporary and final storage are on different filesystems. Considering solely this scenario, the temp storage must be greater than 1.5Tb and the final storage greater than 11 Tb. Ideally, both would require to be at least the double in size, to allow for transfer failures and retries.
Note that having the temp and final on the same filesystem would avoid the need for additional space and usually speed up the moving (intra-filesystem move operation versus inter-filesystem copy and delete).


Network Requirements

Universal Data Mover Gateway components run on Windows, Linux operating systems. These systems must be connected with a network that supports TCP/IP. 

TCP/IP provides a set of commands to verify network connectivity between systems. For example, the ping command can determine if an IP connection is possible between two systems. However, the ping command may not work in all network environments. In addition, the ping command may work, but a firewall may deny all other connection attempts between the two systems. Check with your local network administrator to determine the capabilities and topology of your network.

Ports Configuration

Universal Data Mover Gateway is composed of several components that utilize the TCP/IP network for component communications. TCP/IP routes must be available between the distributed components and firewall rules open, if necessary. 

Make sure that all the ports needed are open under your firewall configuration.

Component or ActorInbound TrafficOutbound Traffic
UDMG Server
  • UDMG Server API (18080 by default, 8080 by default with RPM or DEB package installation)
    See the [admin] section in /opt/udmg/etc/udmg-server/server.ini

  • Local Virtual Servers
    As configured in the Server entities
UDMG Authentication Proxy
  • UDMG Authentication Proxy API (5000 by default)
    As configured in the [proxy] section of /opt/udmg/etc/udmg/auth_proxy/config.toml
  • UDMG Server API (18080 or 8080 by default)
    As configured in the [service.*.targets] section of /opt/udmg/etc/udmg/auth_proxy/config.toml
UDMG Admin UI
  • Web server (80 by default) 
    As configured in the server section of the udmg.conf for NGINX, see Installing NGINX Server.
  • UDMG Authentication Proxy API (5000 by default)
    As configured in the upstream section of the udmg.conf for NGINX
UDMG Agent Proxy Server
  • UDMG Agent Server (2222 by default)
    As configured in the [agent] section of /opt/udmg/etc/udmg/agent/agent.toml

  • Proxied Virtual Servers (by default, uses the same port as in UDMG Server)
    As configured in the Server entities (UDMG Server)

UDMG Agent Proxy Client
  • UDMG Agent Client Admin API (2280 by default)
    As configured in the [client.api] section of /opt/udmg/etc/udmg/agent/client.toml
  • UDMG Agent Server (2222 by default)
    As configured in the [client] section of /opt/udmg/etc/udmg/agent/client.toml

  • UDMG Server API (18080 or 8080by default)
    As configured in the [gateway] section of /opt/udmg/etc/udmg/agent/client.toml
UDMG Web Transfer
UDMG Database
  • Database listener port(s), as configured by the database administrator,
    1521 by default for Oracle, 
    3306 by default for MySQL,
    5432 by default for PostgreSQL.

UDMG Users
  • UDMG Admin UI (80 by default)
     
  • UDMG Server API (18080 or 8080 by default), for CLI or REST API access

  • Local Virtual Servers

  • UDMG Web Transfer (5050 by default) 
Universal Agent
(UDMG File Transfer Universal Task)

  • UDMG Server API (18080 or 8080 by default)
Universal Controller
  • RESTful Web Services API (8080 by default)

External Partners
  • Proxied Virtual Servers (or Local Virtual Servers if UDMG Agent Proxy is not setup)

  • UDMG Web Transfer (5050 by default)