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.

The installation packages, binaries, services, and environment variables have changed, and this does not allow for a standard upgrade.

It may be required to modify the work and data directories ownership or access rights and to update UDMG Server transfer rules to use paths that are accessible by the 'udmg' user.

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

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.

The release migration is altering the database structure and requires the database user to have the DDL privileges fore creating, altering and deleting database its own objects.

Please refer to Installing a Database section for the requires privileges for each the database vendor. 

$ /opt/udmg/bin/udmg-server migrate --help
Usage:
  udmg-server [OPTIONS] migrate [migrate-OPTIONS] [version]

Help Options:
  -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

$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini --list | tail -n 2
1.5.0 [DATABASE]
2.0.0 [DEFAULT]

$ /opt/udmg/bin/udmg-server migrate -c /opt/udmg/etc/udmg-server/server.ini -vvv
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'

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.

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.

# sudo groupadd udmg

# sudo useradd -g udmg udmg

# sudo mkdir -p /opt/udmg/etc/udmg-server
# sudo vi /opt/udmg/etc/udmg-server/server.ini

About the log section:

• The DEBUG and TRACE log levels are not recommended for production environments.
• The detailed log feature (distinct log file for each transfer) is disabled when the log level is set to ERROR or CRITICAL.

About the global section: the requested OS file and directory creation permissions are applied after the umask of the OS user that is running the UDMG Server process.

#
# (c) Copyright 2024 Stonebranch, Inc., All rights reserved.
#
# Stonebranch, Inc.
# Universal Data Mover Gateway Server Configuration File
#
# This configuration file specifies global options for the
# udmg-server program.
#
# The configuration file is organized with the grouping of options under
# different section that are marked by brackets: [section_name]
# This organization should be maintained when modifying the file.
#
# The file syntax is:
#
# - Lines starting with a # or a ; are comments.
# - Blank lines are ignored.
# - Option lines are 'keyword = value' format.
# - keywords are not case sensitive.
# - keywords can start in any column.
# - Case sensitivity of the value depends on the value being specified.
# For example, a yes or no option is not case sensitive, but a file
# or directory name is.
# - Values must be enclosed in quotations marks (") or apostrophes (')
# if the value contains a space or tab.
# - File or folder path on Windows platform must be written with one of the following syntaxes:
# LogPath = "C:/UDMG/UDMG Server/logs"
# LogPath = "C://UDMG//UDMG Server//logs"
# LogPath = "C:\\UDMG\\UDMG Server\\logs"
# LogPath = C:\UDMG\UDMG Server\logs
# LogPath = C:/UDMG/UDMG Server/logs
#
#####################################################################


[global]
; The name given to identify this gateway instance. If the database is shared between multiple gateways, this name MUST be unique across these gateways.
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 gateway. By default, it is the working directory of the process.
GatewayHome = /home/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 = INFO

; 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. If not present, the directory is created with DirPermissions.

LogPath = /var/opt/udmg/logs
; Set to true to have a distinct log file for each local server and remote partner. The file is <LogPath>/<agent name>.<hostname>.log. The default is false to disable the feature.
LogAgent = false


[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, mysql (default), postgresql, oracle, mssql
Type = 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 gateway database user
User = udmg_user

; The password of the gateway 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 = /opt/udmg/etc/udmg-server/passphrase.aes

; Maximum number of database connections, the default is 0 (unlimited)
; MaxConnections = 0

; Maximum number of transactions retries, the default is 3.
; MaxRetries = 3

; Delay in milliseconds between retries, the default is 100.
; MaxRetriesWait = 100

; Threshold before warning for long-running queries, the default is 10 seconds

[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 gateway (0 = unlimited).
; MaxTransferIn = 0

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

; The frequency at which the heartbeat will be updated
; Heartbeat = 10s

; The deadline to determine if this instance will be active
; Deadline = 5m0s

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

[tasks]
; Set to true to disable the COPY task.
DisableCopy = false

; Set to true to disable the MOVE task.
DisableMove = false

; Set to true to disable the COPYRENAME task.
DisableCopyRename = false

; Set to true to disable the MOVERENAME task.
DisableMoveRename = false

; Set to true to disable the DELETE task.
DisableDelete = false

; Set to true to disable the RENAME task.
DisableRename = false

; Set to true to disable the CHECKREGEX task.
DisableCheckRegex = false

; Set to true to disable the PUBLISHEVENT task.
DisablePublishEvent = false

; Set to true to disable the ICAP task.
DisableIcap = false

; Set to true to disable the TRANSFER task.
DisableTransfer = false

; Set to true to disable the EXECMOVE task.
DisableExecMove = false

; Set to true to disable the EXECOUTPUT task.
DisableExecOutput = false

; Set to true to disable the EXEC task.
DisableExec = true

[rule]
; Disables global rules, requiring rules to be explicitly allowed to be used.
; ExplicitRuleAssignment = false

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 an upgrade and to have a backup.

Without the correct AESPassphrase file, the passwords, keys, and certificates are not usable.
The use of an incorrect passphrase file is reported with the error:

cannot decrypt password: cipher: message authentication failed

# sudo install -m 755 udmg-client /opt/udmg/bin
# sudo install -m 755 udmg-server /opt/udmg/bin

# sudo mkdir -p /opt/udmg/etc/udmg

# sudo vi /opt/udmg/etc/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

####################################
# The [service.*] subsections define the different services
# and authentication provider for target udmg-servers.
# There must be at least 1 service.
# The local authentication provided is enabled for all services.
# The service name is displayed on UDMG Admin UI login page.
# It is implicitily defined by the section titles:
# [service.SERVICE_NAME]
# [[service.SERVICE_NAME.targets]]
# [service.SERVICE_NAME.settings]
# [service.SERVICE_NAME.auth.ldap]
# [service.SERVICE_NAME.auth.credentials]
# [service.SERVICE_NAME.auth.google]
# [service.SERVICE_NAME.auth.saml]
# [service.SERVICE_NAME.auth.openid]
# [service.SERVICE_NAME.auth.oauth]
####################################
# Example of a service configuration for local authentication
####################################
[service.udmg]
# protocol for the UDMG Server REST API, either http or https
protocol = "http"
# switchover policy, only if several udmg-server instances can be reached by the authentication proxy instance
policy = "failover"

[[service.udmg.targets]]
# address of a target udmg-server instance, note the double square brackets
hostname = "localhost"
port = 18080

[service.udmg.settings]
#############################################
# Service Settings - this affects the UDMG Admin UI display
# The property name "udmg.xxx" must be enclosed in double quotes
#############################################
# Name of the system or environment
"udmg.system_identifier" = "UDMG"
# Color of the banner background, as HTML color name ("Brown"), RGB code ("rgb(165,42,42)"), or hexadecimal code ("#A52A2A")
"udmg.banner.background_color" = "transparent"
# Company logo, optional picture to display next to the system identifier, the path is relative to web server root directory
#"udmg.banner.logo" = "/assets/logo.png

####################################
# Example of a service configuration for SSO
####################################
#[service.udmg_sso]
#protocol = "http"
#policy = "failover"
#
#[[service.udmg_sso.targets]]
#hostname = "localhost"
#port = 18080
#
# Google SSO Provider
#[service.udmg_sso.auth.google]
#file = "/path/to/config.json"
#
# SAML SSO Provider
#[service.udmg_sso.auth.saml]
#file = "/path/to/config.json"
#
# OpenID SSO Provider
#[service.udmg_sso.auth.openid]
#file = "/path/to/config.json"
#
# OAuth2 SSO Provider
#[service.udmg_sso.auth.oauth]
#file = "/path/to/config.json"

####################################
# Example of a service configuration for LDAP
####################################
#[service.udmg_ldap]
#protocol = "http"
#policy = "failover"
#
#[service.udmg_ldap.credential]
#username = "ldap_sync"
#password = "ldap_password"
#
#[[service.udmg_ldap.targets]]
#hostname = "localhost"
#port = 18080
#
#[service.udmg_ldap.auth.ldap]
#file = "udmg-ldap-config.json"

$ udmg-auth-proxy test -f /opt/udmg/etc/udmg/auth_proxy/config.toml
level=info TS=2024-05-06T10:37:30.263799884Z Configuration="Loading configuration file: /opt/udmg/etc/udmg/auth_proxy/config.toml."
level=info TS=2024-05-06T10:37:30.269199501Z Configuration="Test Pass"

$ udmg-auth-proxy test -f /opt/udmg/etc/udmg/auth_proxy/config.toml
level=info TS=2024-05-06T10:37:30.263799884Z Configuration="Loading configuration file: /opt/udmg/etc/udmg/auth_proxy/config.toml."
level=warn TS=2024-05-06T10:37:30.699063132Z Configuration=File Error="toml: line 83 (last key \"service.udmg\"): Key 'service.udmg.settings' has already been defined."
level=error TS=2024-05-06T10:37:30.699096632Z Configuration="Error reading the configuration file." err="configuration file invalid structure"

# sudo install -m 755 udmg-auth-proxy /opt/udmg/bin

The following steps require root privilege, so make sure that you have the correct access before continuing.

# sudo unzip -d /opt/udmg/var/www/udmg/ udmg-admin-ui-<VERSION>.zip

# curl http://localhost:80 -I
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 08 Oct 2024 08:47:51 GMT
Content-Type: text/html
Content-Length: 467
Last-Modified: Tue, 08 Oct 2024 18:36:50 GMT
Connection: keep-alive
ETag: "67057bc2-1d3"
X-XSS-Protection: 0
X-Frame-Options: SAMEORIGIN
Content-Security-Policy: frame-ancestors 'self'
X-Content-Type-Options: nosniff
Referrer-Policy: strict-origin
Strict-Transport-Security: max-age=31536000; includeSubDomains; preload
Permissions-Policy: geolocation=(),midi=(),sync-xhr=(),microphone=(),camera=(),magnetometer=(),gyroscope=(),fullscreen=(self),payment=()
X-Permitted-Cross-Domain-Policies: none
Accept-Ranges: bytes

# sudo mkdir -p /opt/udmg/etc/udmg/agent/

# sudo install -m 755 udmg-agent-server /opt/udmg/bin

# ssh-keygen -t rsa -q -N "" -f /opt/udmg/etc/udmg/agent/agent

# chmod 755 /opt/udmg/etc/udmg/agent/agent /opt/udmg/etc/udmg/agent/agent.pub

# sudo vi /opt/udmg/etc/udmg/agent/agent.toml

[agent]
# UDMG Agent Server Hostname or IP, and port
hostname = "0.0.0.0"
port = "2222"
# path to the SSH private key file
ssh_key = "/opt/udmg/etc/udmg/agent/agent"
# path to the SSH public key file
ssh_key_pub = "/opt/udmg/etc/udmg/agent/

# sudo install -m 755 udmg-agent-client /opt/udmg/agent/agent.pubbin