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-2.0.x Version, Release, or Modification level of UDMG (1.5.x, 1.4.x, 1.3.x) to UDMG 2.0.x.
...
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.
...
- WAARP_GATEWAY_ADDRESS
- MFT_AUTH_PROXY_CONFIG
- MFT_AGENT_PROXY_CONFIG
...
- UDMG_SERVER_ADDRESS
- UDMG_AUTH_PROXY_CONFIG
- UDMG_AGENT_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.
...
Make sure to have a backup of the configuration files as it optimizes 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
...
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.
After upgrading the component binaries and before starting the UDMG Server it is required to perform the release migration step.
The udmg-server "migrate" command handles the necessary database updates and the setting of the internal version.
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 to be used for the server mode, with the parameter for accessing the target database.
To get the list of supported target versions, use the list parameter. The last value is the release version of the udmg-server and also the default target version. The current version of the UDMG database structure is shown with the [DATABASE] tag:
Code Block |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /list
0.7.1-sb.3
1.3.0
1.3.1
1.3.2
1.4.0
1.4.1
1.5.0 [DATABASE]
2.0.0 [DEFAULT] |
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.
...
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-2.0.x Version, Release, or Modification level of UDMG (1.5.x, 1.4.x, 1.3.x) to UDMG 2.0.x.
Warning |
---|
As a precautionary measure, it is highly recommended that you back up the UDMG database prior to upgrading. |
Upgrading from a pre 2.0 UDMG release
If you are upgrading an installation of UDMG from any release before 2.0.0.0, the following changes must be reviewd carefully.
Note | ||
---|---|---|
| ||
Starting with UDMG version 2.0, a license key must be provided to enable file transfers. Contact your Stonebranch representative or Customer Support to receive the license key before upgrading to version 2.0 or later. |
Note | ||
---|---|---|
| ||
(1) Local Accounts are converted to Shared Accounts Before this change, a local account was only defined for a given local server and not allowed to have the same account for multiple protocols. For instance, to allow a partner to transfer files over SFTP and FTP, it was required to have both an SFTP and FTP local server, each with their own local account. Each account was then maintained independently, which created additional overhead in configuration and maintenance (password or key updates). A shared Account is created once and can be assigned to several Local Servers, sharing the same login, password, and authentication records. A migrated account has the following characteristics:
(2) New permission for Shared Account management A new User and User Group permission, "sharedAccount", is created for the management of Shared Accounts. |
Note | ||
---|---|---|
| ||
The start parameters for several services have changed. Please review the start scripts, the following modules now require a 'start' command to begin in server mode.
Without it, they will only display the command line usage information. In addition, a 'test' command allows the syntax of the configuration file to be verified without starting the server. |
New configuration parameter with UDMG 2.0.0.0
Note | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
UDMG Server
|
Upgrading from a pre 1.3 UDMG release
Note | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
If you are upgrading an installation of UDMG from any release before 1.3.0.0, you must uninstall the older version before installing the new version. Migration from releases before 1.2.1.1 (0.7.1-sb.3) is not supported anymore.
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 | ||||
---|---|---|---|---|
|
Make sure to have a backup of the configuration files as it optimizes 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.
After upgrading the component binaries and before starting the UDMG Server it is required to perform the release migration step.
The udmg-server "migrate" command handles the necessary database updates and the setting of the internal version.
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 to be used for the server mode, with the parameter for accessing the target database.
To get the list of supported target versions, use the list parameter. The last value is the release version of the udmg-server and the default target version. The current version of the UDMG database structure is shown with the [DATABASE] tag:
Code Block |
---|
C:\UDMG\UDMG Server>udmg-server migrate /c "C:\UDMG\UDMG Server\server.ini" /list
0.7.1-sb.3
1.3.0
1.3.1
1.3.2
1.4.0
1.4.1
1.5.0 [DATABASE]
2.0.0 [DEFAULT] |
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
2024/06/10 20:01:51 [INFO ] Migration: Starting upgrade migration from 1.5.0 to 2.0.0
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Drop the normalized transfer view'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Add a "src_filename, dest_filename" columns to the transfers table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Add a "src_filename, dest_filename" columns to the history table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Restore and update the normalized transfer view with the new filename'
2024/06/10 20:01:51 [DEBUG ] Migration: Skipped migration 'Check for required MySQL permissions'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Add a 'local_storage' column to the 'local_accounts' table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Fix the 'sb_user_session' table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Create the 'sb_license' table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Drop the normalized transfer view'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Add a 'local_agent_id' column to the 'transfers' table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Update the 'sb_generic_group_join' table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Update the 'sb_user_group_permission' table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Update the 'users' table'
2024/06/10 20:01:51 [INFO ] Migration: Applying migration 'Create the 'sb_local_account_auth' table'
2024/06/10 20:01:52 [INFO ] Migration: Applying migration 'Drop the 'local_agent_id' column from the 'local_accounts' table'
2024/06/10 20:01:52 [INFO ] Migration: Applying migration 'Restore and update the normalized transfer view with the new local agent id'
2024/06/10 20:01:52 [INFO ] Migration: Applying migration 'Create the 'sb_adhoc_share' table'
2024/06/10 20:01:52 [INFO ] Migration: Applying migration 'Create the 'sb_adhoc_download' table'
2024/06/10 20:01:52 [INFO ] Migration: Applying migration 'Bump database version to 2.0.0' |
...
Step 1 | Contact your Stonebranch representative or Customer Support to receive the software binaries. |
---|---|
Step 2 | Perform the recommended 320733540 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
Note | ||
---|---|---|
| ||
Starting with UDMG version 2.0, a license key must be provided to enable file transfers. Contact your Stonebranch representative or Customer Support to receive the license key before installing version 2.0 or later. |
UDMG Admin UI
Extract the zip file for UDMG Admin UI, under the directory that was created during the NGINX installation.
...
Note | ||
---|---|---|
| ||
The lines starting with a colon ';' or a hash '#' are comments, describing the option or of 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 environmentsAbout the log section:
|
Note | ||
---|---|---|
| ||
There are several ways to write a file or folder Windows path that are is compatible with the supported INI format by udmg-server. Valid syntaxes:
The first one, with the quotes and the forward slash, is recommended. |
Panel |
---|
WarningTimeout=10s
;
|
Note | ||
---|---|---|
| ||
The AESPassphrase file is generated on the first run if it does not exist. It is recommended to set an absolute path, otherwise it is created in the current directory. Make sure to verify the file location during the an upgrade and to have a backup. Without the correct AESPassphrase file, the passwords, keys, and certificates are not usable. Without the correct AESPassphrase file, the passwords, keys, and certificates are not 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
...
####################################
# The proxy section configures the
# UDMG Authentication Proxy
####################################
[proxy]
# Port, default "5775"
port = "5775"
# Network interface, default "0.0.0.0"
inet = "0.0.0.0"
#############################################
# Fine-tuning parameters,
# beware that this can affect the security or the performance
#############################################
# 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 domain: List of origins that may access the resource. Optional. Default value "*"
domain = "*"
# Enable CSRF protection, default false (set to true only if NGINX uses SSL/TLS)
csrf = false
# Enable request Track ID, default true
tracker = true
# Enable request logguer, 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
...
-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.
- Verify the configuration file with the 'test' command:
Panel |
---|
|
In case of syntax error, a verbose message will indicate the line and the issue:
Panel |
---|
|
UDMG Agent Proxy
Agent Proxy Server Configuration
...
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:
|
Panel |
---|
|
The username and password key is keys are used for the client authenticationUDMG Agent Client authentication to the UDMG Agent Server.
Agent Proxy Client Configuration
...
Create a configuration file as
"
C:\UDMG\UDMG Agent\client\client.toml"
Panel |
---|
|
...
|
The username and password keys in the '[client]'
section are used for the UDMG Agent Client authentication to the UDMG Agent Server.
Setup the Windows Services
...
Note | ||
---|---|---|
| ||
The rollover of the service log file is disabled as it causes a bug of in the WinSW application, see |
...
Panel |
---|
|
...
Panel |
---|
|
...
Panel |
---|
|
...
Panel |
---|
|
License application
Once UDMG Server and UDMG Admin UI are up and running, the license can be applied; see UDMG Licensing.
Ports Configuration
See Network Requirements.
...
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 |
...