Panel | |
---|---|
|
...
Panel | |
---|---|
|
For the UDMG Web Transfer Client, please refer to UDMG Web Transfer Client for Linux 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.5.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 installmysqling 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 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. |
Anchor | ||||
---|---|---|---|---|
|
Pre-Installation / Upgrade Backups
The installation process overwrites the current files (exception: the configuration files are kept), this may affect your modifications.
Backing up the configuration files will optimize the time it takes you to get up and running after installing or upgrading.
/opt/udmg/etc/udmg/nginx/udmg.conf
/opt/udmg/etc/udmg/agent/client.toml
/opt/udmg/etc/udmg/agent/server.toml
/opt/udmg/etc/udmg/auth-proxy/config.toml
/opt/udmg/etc/udmg/web-transfer/config.toml
/opt/udmg/etc/udmg-server/server.ini
After upgrading RPM or DEB packages, review the new configuration file templates (with the extension .rpmnew or .dpk-new) and edit the current configuration files to add new parameters or remove deprecated parameters.
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.
...
Upgrading with Linux software packages
Step 1 | Contact your Stonebranch representative or the Customer Support to receive the software package for the intended operating system. | ||||
---|---|---|---|---|---|
Step 2 | Perform the recommended 320733498 backup 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 packages (RPM or DEB), for example:
| ||||
Step 5 | Step 7 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example:
systemctl start udmgReview the component configuration files. Note that new configuration file templates (with the extension .rpmnew or .dpk-new) that contains all the allowed parameters are added during the software package upgrade. | |||
Step 6 | Perform the release migration. | ||||
| |||||
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:
|
...
Step 1 | Contact your Stonebranch representative or the Customer Support to receive the software package for the intended operating system. |
---|---|
Step 2 | Perform the recommended 320733498 backup 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 | Replace the component binaries
Change ownership/permissions on new files:
Upgrade the Admin UI:
|
Step 5 | Review the component configuration files. Refer to each component installation section below for the list of parameters. |
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:
|
...
Step 1 | Contact your Stonebranch representative or the Customer Support to receive the software package for the intended operating system. |
---|---|
Step 2 | Install the UDMG packages (RPM or DEB), for example:
|
Step 3 | Review the component configuration files. |
Step 4 | Start the components services. The exact steps depend on the system architecture and the deployed components, for example:
|
...
- The zip file can now be deleted.
- Validate that the service is working properly with the 'curl' command:
Panel |
---|
|
or with the browser:
UDMG User setup
Create a dedicated user for running the UDMG modules and to be the owner of the files that will be transferred by UDMG.
Panel |
---|
|
UDMG Server
Create the configuration file /opt/udmg/etc/udmg-server/server.ini with the following parameters:
Panel |
---|
|
Note | ||
---|---|---|
| ||
The lines starting with a semicolon ';' 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 gateway instance. If the 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
...
[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 = 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.
...
[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.
...
[database]
; Type of the RDBMS used for the gateway 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
[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
...
- with the 'curl' command:
Panel |
---|
|
or with the browser:
UDMG User setup
Create a dedicated user for running the UDMG modules and to be the owner of the files that will be transferred by UDMG.
Panel |
---|
|
UDMG Server
Create the configuration file /opt/udmg/etc/udmg-server/server.ini with the following parameters:
Panel |
---|
|
Note | ||
---|---|---|
| ||
The lines starting with a semicolon ';' 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 | ||
---|---|---|
| ||
The requested OS file and directory creation permissions are applied after umask. |
Panel |
---|
[paths]
|
Note | ||
---|---|---|
| ||
AESPassphrase file is generated on 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, the keys and the certificates will not be usable.
|
...
Panel |
---|
|
...
Panel |
---|
|
...
Anchor | ||||
---|---|---|---|---|
|
Security-Enhanced Linux (SELinux) is enabled by default on modern RHEL and CentOS servers. Each operating system object (process, file descriptor, file, etc.) is labeled with an SELinux context that defines the permissions and operations the object can perform. In RHEL 6.6/CentOS 6.6 and later, NGINX is labeled with the httpd_t
context.
When SELinux is enabled, the UDMG Admin UI will show "403 access denied" and "404 page not found" errors on the landing page and permission errors are reported in the NGINX log files:
Panel |
---|
|
...