Panel | |
---|---|
|
For the UDMG Web Transfer Client, please refer to UDMG Web Transfer Client for Windows Installation.
Upgrading Universal Data Mover Gateway
...
Panel | |
---|---|
|
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.5.x Version, Release, or Modification level of UDMG (1.3.x, 1.2.x, 1.1.x, 1.0.x) to UDMG 1.45.x.
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.
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 | ||||
---|---|---|---|---|
|
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.
...
Code Block |
---|
C:\UDMG\UDMG Server>udmg-server migrate /?
Usage:
udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]
Help Options:
/? Show this help message
/h, /help Show this help message
[migrate command options]
/c, /config: The configuration file to use
/d, /dry-run Simulate the migration but does not commit the changes
/l, /list List Migrations
/f, /file: Writes the migration commands into a file instead of sending them to the database
/v, /verbose Show verbose debug information. Can be repeated to increase verbosity
[migrate command arguments]
version: The version to which the database should be migrated |
The configuration file is the one that will be used for the server mode, with the parameter for accessing the target database.
To get the list of supported target version, use the list parameter. The last version is the release version of the udmg-server.
Code Block |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /list
0.7.1
0.7.1-sb.1
0.7.1-sb.2
0.7.1-sb.3
1.3.0
1.4.0 |
It is recommended to set the verbose parameter (3 times) to follow the progress.
Code Block |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /v /v /v 1.4.0
[INFO ] Migration: Starting upgrade migration...
[INFO ] Migration: Applying migration 'Bump database version to 1.4.0' |
After the migration, the service for UDMG Server can be started.
Upgrading Universal Data Mover Gateway for Windows
...
Step 1
...
Contact your Stonebranch representative or the Customer Support to receive the software binaries.
...
Step 2
...
Perform the recommended 320733540 of configuration files.
...
Step 3
Stop the components services.
The exact steps depend on the system architecture and the deployed components, for example:
...
Step 4
Upgrade the UDMG component binaries by copying the release files to their target location:
copy udmg-server.exe "
C:\UDMG\UDMG Server\udmg-server.exe"
copy
udmg-client.exe "
udmg-client.exe"C:\UDMG\UDMG Server\
copy icap-client.exe
"
"C:\UDMG\UDMG Server\icap-client.exe
copy
udmg-auth-proxy.exe "C:\UDMG\UDMG Auth Proxy\udmg-auth-proxy.exe"
copy udmg-agent-client.exe "
C:\UDMG\UDMG Agent\client\udmg-agent-client.exe"
copy udmg-agent-server.exe "
C:\UDMG\UDMG Agent\agent\udmg-agent-server.exe"
Upgrade the UDMG Admin UI:
C:\UDMG\nginx> move
udmg
udmg_BACKUP
C:\UDMG\nginx> cd udmg
C:\UDMG\nginx\udmg> tar -x -f "
udmg-admin-ui-1.4.0.0 build.6.zip"
...
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
...
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-client-service.exe start
C:\UDMG\UDMG Agent\agent\udmg-agent-server-service.exe start
Installing and Configuring the Components
UDMG Admin UI
Extract the zip file for UDMG Admin UI, under the directory that was created during the NGINX installation.
Panel |
---|
|
- The zip file can now be deleted.
- Validate that the service is working properly with the 'curl' command:
Panel |
---|
|
or with the browser:
UDMG Server
Create a directory
C:\UDMG\
UDMG Server
Copy the binaries as
andudmg-server.exe
udmg-client.exe
- Create the configuration file
C:\UDMG\
UDMG Server\server.ini
Note | ||
---|---|---|
| ||
The lines starting with a colon ';' or a hash '#' are comments, describing the option or showing the default value. The parameters must be adapted to your environment, in particular:
|
...
[global]
; The name given to identify this UDMG Server instance. If the database is shared between multiple servers, this name MUST be unique across these
servers
.GatewayName =
sb-mft-01
; 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 =
; Password for the key of the TLS Certificate (if key is encrypted).
; TLSPassphrase =
; 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]
; Type of the RDBMS used for the
UDMG Server
database. Possible values: sqlite (default), mysql, postgresql, oracle, mssqlType = postgresql
; Address (URL:port) of the database. The default port depends on the type of database used (PostgreSQL: 5432, MySQL: 3306, MS SQL: 1433, Oracle: 1521, SQLite: none).
Address = localhost
:5432
; 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. (only supported for mysql, postgresql)
; TLSCert =
; Path of the key of the TLS certificate file (only supported for mysql, postgresql).
; TLSKey =
; The path to the file containing the passphrase used to encrypt account passwords using AES
. Recommended to be a full absolute path, if the file does not exist, a new passphrase is generated the first time.
; AESPassphrase =
C:\UDMG\
passphrase.aesUDMG Server\
; Maximum number of database connections, the default is 0 (unlimited)
; MaxConnections = 0
[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
Note | ||
---|---|---|
| ||
AESPassphrase file is generated on first run if it does not exist. Make sure to set verify the file location during upgrade and to have a backup. Without the correct AESPassphrase file, the passwords, the keys and the certificates will not be usable. |
UDMG Authentication Proxy
Create a directory
C:\UDMG\UDMG
Auth Proxy
Copy the binary as
udmg-auth-proxy.exe
Create the configuration file
C:\UDMG\UDMG Auth Proxy\config.toml
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 # 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 # Service 'local' with direct authentication on the [service.local] # UDMG Server Listen Protocol protocol = "http" [[service.local.targets]] # UDMG Server Hostname or IP hostname = "localhost" # UDMG Server Port port = 18080
version: The version to which the database should be migrated |
The configuration file is the one that will be used for the server mode, with the parameter for accessing the target database.
To get the list of supported target version, use the list parameter. The last version is the release version of the udmg-server.
Code Block |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /list
0.7.1
0.7.1-sb.1
0.7.1-sb.2
0.7.1-sb.3
1.3.0
1.4.0
1.4.1
1.5.0 |
It is recommended to set the verbose parameter (3 times) to follow the progress. If not specified on the command line, the target version is the latest release number.
Code Block |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /v /v /v
[INFO ] Migration: Starting upgrade migration...
[INFO ] Migration: Applying migration 'Bump database version to 1.5.0' |
After the migration, the service for UDMG Server can be started.
Upgrading Universal Data Mover Gateway for Windows
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-client-service.exe stop C:\UDMG\UDMG Agent\agent\udmg-agent-server-service.exe stop |
Step 4 | Upgrade the UDMG component binaries by copying the release files to their target location:
Upgrade the UDMG Admin UI:
|
Step 5 | Review the component configuration files. |
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:
|
Installing and Configuring the Components
UDMG Admin UI
Extract the zip file for UDMG Admin UI, under the directory that was created during the NGINX installation.
Panel |
---|
|
- The zip file can now be deleted.
- Validate that the service is working properly with the 'curl' command:
Panel |
---|
|
or with the browser:
UDMG Server
Create a directory
C:\UDMG\
UDMG Server
Copy the binaries as
andudmg-server.exe
udmg-client.exe
- Create the configuration file
C:\UDMG\
UDMG Server\server.ini
Note | ||
---|---|---|
| ||
The lines starting with a colon ';' or a hash '#' are comments, describing the option or showing the default value. The parameters must be adapted to your environment, in particular:
|
Note | ||
---|---|---|
| ||
DEBUG and TRACE log levels are not recommended for production environments. |
Note | ||
---|---|---|
| ||
There are several ways to write a file or folder Windows path that are compatible with the supported INI format by udmg-server. Valid syntaxes:
The first one, with the quotes and the forward slash, is recommended. |
Panel |
---|
;
|
Note | ||
---|---|---|
| ||
AESPassphrase file is generated on first run if it does not exist. Make sure to set verify the file location during upgrade and to have a backup. Without the correct AESPassphrase file, the passwords, the keys and the certificates will not be usable. |
UDMG Authentication Proxy
Create a directory
C:\UDMG\UDMG
Auth Proxy
Copy the binary as
udmg-auth-proxy.exe
Create the configuration file
C:\UDMG\UDMG Auth Proxy\config.toml
Panel |
---|
|
Please refer to Authentication Methods for the LDAP and SSO authentication options.
...
Be sure that the UDMG Server API listen port (8080 18080 by default) and network interface are reachable by UDMG Authentication Proxy and UDMG Agent Client. Refer to Ports Configuration for more information.
...
Panel |
---|
|
...
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 |
...