Panel

Table of Contents

For the UDMG Web Transfer Client, please refer to UDMG Web Transfer Client for Windows Installation.

Upgrading Universal Data Mover Gateway

Upgrading UDMG refers to the increase of a currently installed pre-1.4.x Version, Release, or Modification level of UDMG (1.3.x, 1.2.x, 1.1.x, 1.0.x) to UDMG 1.4.x.

Note

title	Note

If you are upgrading an installation of UDMG from any release prior to 1.3.0.0, you must uninstall the older version before installing the new version.
The binaries, services, configuration parameters, and environment variables have changed and this does not allow for a standard upgrade.

Category	Prior releases	Release 1.3
UDMG Admin UI assets	C:\UDMG\nginx\mft	C:\UDMG\nginx\udmg
Environment variables	WAARP_GATEWAY_ADDRESS MFT_AUTH_PROXY_CONFIG MFT_AGENT_PROXY_CONFIG	UDMG_SERVER_ADDRESS UDMG_AUTH_PROXY_CONFIG UDMG_AGENT_PROXY_CONFIG

It may be required to modify the work and data directories ownership or access rights and to update UDMG Server transfer rules to use new paths.

The configuration files must be reviewed and compared between the old and new versions.

Special attention is required for the AESpassphrase parameter for UDMG Server. It must be the path for the file that was used by the previous release and must be accessible by the new service user. It is recommended to set an absolute path in the configuration file.

Anchor
backup
backup
Pre-Installation / Upgrade Backups

Make sure to have a backup of the configuration files as it will optimize the time it takes you to get up and running after upgrading.

C:\UDMG\UDMG Server\server.ini C:\UDMG\UDMG Auth Proxy\config.toml C:\UDMG\UDMG Agent\agent\agent.toml C:\UDMG\UDMG Agent\client\client.toml

Anchor
db_migration
db_migration
Release migration

The UDMG release version is stored in the database to ensure the data structure is compatible with the version of the UDMG components.

...

Step 1	Contact your Stonebranch representative or the Customer Support to receive the software binaries.
Step 2	Perform the recommended backup of configuration files.
Step 3	Stop the components services. The exact steps depend on the system architecture and the deployed components, for example: `C:\UDMG\nginx>nginx-service.exe stop` `C:\UDMG\UDMG Auth Proxy\udmg-auth-proxy-service.exe stop` `C:\UDMG\UDMG Server\udmg-server-service.exe stop` `C:\UDMG\UDMG Agent\client\udmg-agent-proxy-client-service.exe stop` `C:\UDMG\UDMG Agent\agent\udmg-agent-proxy-server-service.exe stop`
Step 4	Upgrade the UDMG component binaries by copying the release files to their target location: `sudo cp udmg-server.bin /opt/udmg/bin/udmg-server` `sudo cp udmg-client.bin /opt/udmg/bin/udmg-client` `sudo cp udmg-auth-proxy.bin /opt/udmg/bin/udmg-auth-proxy` `sudo cp udmg-web-transfer.bin /opt/udmg/bin/udmg-web-transfer` Upgrade the UDMG Admin UI: `mv /opt/udmg/var/www/udmg /opt/udmg/var/www/udmg_BACKUP unzip -d /opt/udmg/var/www/udmg/ 'udmg-admin-ui-1.4.0.0 build.6.zip' chown -R root:udmg /opt/udmg/var/www/udmg`
Step 5	Review the component configuration files. Refer to each component installation section below for the list of parameters. `C:\UDMG\UDMG Server\server.ini C:\UDMG\UDMG Auth Proxy\config.toml C:\UDMG\UDMG Agent\agent\agent.toml C:\UDMG\UDMG Agent\client\client.toml`
Step 6	Perform the release migration.
Step 7	Start the components services. The exact steps depend on the system architecture and the deployed components, for example: `C:\UDMG\UDMG Server\udmg-server-service.exe start` `C:\UDMG\UDMG Auth Proxy\\udmg-auth-proxy-service.exe start` `C:\UDMG\nginx>nginx-service.exe start` `C:\UDMG\UDMG Agent\client\udmg-agent-proxy-client-service.exe start` `C:\UDMG\UDMG Agent\agent\udmg-agent-proxy-server-service.exe start`

...

Panel

[global]
; The name given to identify this UDMG Server instance. If the the database is shared between multiple servers, this name MUST be unique across these servers.
GatewayName = udmg

; Default OS permission for created files
; FilePermissions = 770

; Default OS permission for created directories
; DirPermissions = 770

[paths]
; The root directory of the UDMG Server. By default, it is the working directory of the process.
; GatewayHome = "C:\UDMG\UDMG Server"

; 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 TRACE, 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

; The directory for the log files of the local servers, partners, and transfers. No default, if not provided then the detailed log feature is disabled.; LogPath = "C:\UDMG\UDMG Server\logs"

[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 =

; API rate limiter: number of allowed requests per client IP, per second. After that HTTP code 429 is returned. Disabled if 0 or not provided.
; RateLimit = 0

[database]
; Name of the RDBMS used for the UDMG Server database. Possible values: sqlite, mysql, postgresql
Type = postgresql

; Address of the database
Address = localhost

; The name of the database
Name = udmg

; The name of the database user
User = udmg_user

; The password of the database user
Password = udmg_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 UDMG Server (0 = unlimited).
; MaxTransferIn = 0

; The maximum number of concurrent outgoing transfers allowed on the UDMG Server (0 = unlimited).
; MaxTransferOut = 0

[sftp]
; Set to true to allow legacy and weak cipher algorithms: 3des-cbc, aes128-cbc, arcfour, arcfour128, arcfour256
; AllowLegacyCiphers = false

...

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 # CORS: List of origins that may access the resource. Optional. Default value "*" # domain = "*"
# Enable Request Track ID, default true
tracker = true
# Enable Request Logger, 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 # Enable CSRF token csrf = false# Service 'local' with direct authentication on the UDMG Server
[service.local]
# UDMG Server Listen Protocol
protocol = "http"[[service.local.targets]]
# UDMG Server Hostname or IP
hostname = "localhost"
# UDMG Server Port
port = 18080

Please refer to Authentication Methods for the LDAP and SSO authentication options.

UDMG Agent Proxy

Agent Proxy Server Configuration

Create a directory C:\UDMG\UDMG Agent\agent
Install the binaries as udmg-agent-proxy-client.exe and binary as udmg-agent-proxy-server.exe

Agent Proxy Server Configuration

Generate a SSH Key for the service.
For example with the ssh-keygen tool that is provided by Windows OpenSSH tools (Key-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\agent_key"`

If OpenSSH is not installed or not available, the PuTTY tool can be used instead.

...

After generating the key, export it with OpenSSH format:

...

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

Note

title	Note

The Windows paths in the TOML configuration file must be specified either in UNIX-style, using forward slashes '/', or with double backslashes '\\'.

For example:

ssh_key = "C:/UDMG/UDMG Agent/agent/agent_key"

ssh_key = "C:\\UDMG\\UDMG Agent\\agent\

...

\agent_key"

Panel

[agent]
# Listen IP Address
hostname = "0.0.0.0"
# Listen Port
port = "2222"
# SSH Priv Key
ssh_key = "C:\/UDMG\/UDMG Agent\/agent/agent_key"
# SSH Public Key
ssh_key_pub = "C:\/UDMG\/UDMG Agent\/agent/agent_key.pub"

# Service User
username = "mft"
# Service Password
password = "61ee8b5601a84d5154387578466c8998848ba089"

...

Agent Proxy Client Configuration

Create a directory C:\UDMG\UDMG Agent\client
Install the binary as udmg-agent-client.exe

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

...

Panel
`id: UDMG Agent Server` `name: UDMG Agent Server` `description: UDMG Agent Server` `executable: C:\UDMG\UDMG Agent\agent\udmg-agent-proxy-server.exe` `priority: Normal` `workingdirectory: C:\UDMG\UDMG Agent\agent` `env:` `- name: MFTUDMG_AGENT_PROXY_CONFIG` `value: 'C:\UDMG\UDMG Agent\agent\agent.toml'`

...

Panel

C:\UDMG\UDMG Agent\agent>udmg-agent-proxy-server-service.exe install2022-10-07 10:09:45,618 INFO - Installing service 'UDMG Agent Server (UDMG Agent Server)'...2022-10-07 10:09:45,683 INFO - Service 'UDMG Agent Server (UDMG Agent Server)' was installed successfully. C:\UDMG\UDMG Agent\agent>udmg-agent-proxy-server-service.exe start2022-10-07 10:09:52,852 INFO - Starting service 'UDMG Agent Server (UDMG Agent Server)'...2022-10-07 10:09:54,053 INFO - Service 'UDMG Agent Server (UDMG Agent Server)' started successfully. C:\UDMG\UDMG Agent\agent>udmg-agent-proxy-server-service.exe statusStarted

...

Panel
`id: UDMG Agent Client` `name: UDMG Agent Client` `description: UDMG Agent Client` `executable: C:\UDMG\UDMG Agent\client\udmg-agent-proxy-client.exe` `priority: Normal` `workingdirectory: C:\UDMG\UDMG Agent\client` `env:` `- name: MFTUDMG_AGENT_PROXY_CONFIG` `value: 'C:\UDMG\UDMG Agent\client\agentclient.toml'`

Start the service and check the status:

...

Name	Location
PostgreSQL Client Authentication	21.1. The pg_hba.conf File
PostgreSQL Password Authentication	21.5. Password Authentication
Guide on setting up Nginx as a service on Windows	https://github.com/sheggi/win-service-nginx

...

Versions Compared

Old Version 9

New Version 10

Key

Upgrading Universal Data Mover Gateway

Anchor
backup
backup
Pre-Installation / Upgrade Backups

Anchor
db_migration
db_migration
Release migration

UDMG Agent Proxy

Agent Proxy Server Configuration

Agent Proxy Server Configuration

Agent Proxy Client Configuration

Page Comparison

Versions Compared

Old Version 9

New Version 10

Key

Upgrading Universal Data Mover Gateway

AnchorbackupbackupPre-Installation / Upgrade Backups

Anchordb_migrationdb_migrationRelease migration

UDMG Agent Proxy

Agent Proxy Server Configuration

Agent Proxy Server Configuration

Agent Proxy Client Configuration

Anchor
backup
backup
Pre-Installation / Upgrade Backups

Anchor
db_migration
db_migration
Release migration