Panel | |
---|---|
|
Pre-Installation / Upgrade Backups
The installation process overwrites the current files (exception: the configuration files are kept), effectively removing your modifications. Backing up these files will optimize the time it takes you to get up and running after installing or upgrading.
...
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_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.
Upgrading UDMG Server
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.
...
Panel | |
---|---|
|
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 | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
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 | ||||
---|---|---|---|---|
|
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
db_migration | |
db_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 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' |
...
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 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:
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
...
Panel |
---|
; 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
|
...
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 |
...