/
UDMG Web Transfer Client for Linux Installation

UDMG Web Transfer Client for Linux Installation

Dec 12, 2024

Requirements

  • Linux x64 (kernel 3.10 and later, glibc 2.17-78 and later)

  • UDMG 2.0 with the modules:

    • UDMG Admin UI

    • UDMG Authentication Proxy

    • UDMG Server

Upgrading UDMG Web Transfer Client


Note

UDMG Web Transfer Client must be upgraded at the same time as the UDMG Server component.

Note

If you are upgrading an installation of UDMG from any release before 2.0.0.0, the start parameters for the module have changed.

Please review them carefully, especially for manual installation or if the Systemd service files have been edited. 
The service configuration is updated automatically for a standard upgrade with the provided Linux packages.

The module now requires a 'start' command in server mode. 

udmg-web-transfer start -f configuration_file

Without it, it 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.

Upgrading with Linux Software Packages

Step 1

Contact your Stonebranch representative or Customer Support to receive the software package for the intended operating system.

Step 2

Perform the recommended backup of configuration files.

Step 3

Stop the components service.

sudo systemctl stop udmg-web-transfer

Step 4

Upgrade the UDMG package (RPM or DEB).

For RPM based Linux:

sudo rpm -Uvh udmg-web-transfer-2.0.0.0.build.11.x86_64.rpm

For Debian based Linux:

sudo dpkg --install udmg-web-transfer-2.0.0.0.build.11.x86_64.dep

Step 5

Review the component configuration file.
/opt/udmg/etc/udmg/web-transfer/config.toml
Note that the new configuration file templates (with the extension .rpmnew or .dpk-new) that contain all the allowed parameters are added during the software package upgrade.

Step 6

Review the component service configuration file.

The  service file (/etc/systemd/system/udmg-web-transfer.service) was installed with these parameters in version 1.5

udmg-auth-proxy.service (Version 1.5)
[Unit]
Description=Stonebranch UDMG Web Transfer

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_WEB_TRANSFER=/opt/udmg/etc/udmg/web-transfer/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-web-transfer'
Restart=on-failure
SyslogIdentifier=udmg-web-transfer
SyslogFacility=local0

[Install]
WantedBy=multi-user.target

Note the addition of the start command on the ExecStart directive on version 2.0:

udmg-auth-proxy.service (Version 2.0)
[Unit]
Description=Stonebranch UDMG Web Transfer

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_WEB_TRANSFER=/opt/udmg/etc/udmg/web-transfer/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-web-transfer start'
Restart=on-failure
SyslogIdentifier=udmg-web-transfer
SyslogFacility=local0

[Install]
WantedBy=multi-user.target
Step 7

Start the components service.

sudo systemctl start udmg-web-transfer

Upgrading a Manual Installation

Step 1

Contact your Stonebranch representative or Customer Support to receive the software package for the intended operating system.

Step 2

Perform the recommended backup of configuration files.

Step 3

Stop the components service.

sudo systemctl stop udmg-web-transfer

Step 4

Replace the component binary.

sudo cp udmg-web-transfer.bin /opt/udmg/bin/udmg-web-transfer

Step 5

Review the component configuration file.

/opt/udmg/etc/udmg/web-transfer/config.toml

Step 6

Review the component service configuration file.

The  service file (/etc/systemd/system/udmg-web-transfer.service) was installed with these parameter in version 1.5

udmg-auth-proxy.service (Version 1.5)
[Unit]
Description=Stonebranch UDMG Web Transfer

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_WEB_TRANSFER=/opt/udmg/etc/udmg/web-transfer/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-web-transfer'
Restart=on-failure
SyslogIdentifier=udmg-web-transfer
SyslogFacility=local0

[Install]
WantedBy=multi-user.target

Note the addition of the start command on the ExecStart directive on the version 2.0:

udmg-auth-proxy.service (Version 2.0)
[Unit]
Description=Stonebranch UDMG Web Transfer

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment="UDMG_WEB_TRANSFER=/opt/udmg/etc/udmg/web-transfer/config.toml"
ExecStart=/bin/sh -c 'exec /opt/udmg/bin/udmg-web-transfer start'
Restart=on-failure
SyslogIdentifier=udmg-web-transfer
SyslogFacility=local0

[Install]
WantedBy=multi-user.target
Step 7

Start the components service.

sudo systemctl start udmg-web-transfer

Installing UDMG Web Transfer Client

Installing with Linux Software Packages

Step 1

Contact your Stonebranch representative or Customer Support to receive the software package for the intended operating system.

Step 2

Install the UDMG packages (RPM or DEB).

For RPM based Linux:

sudo rpm -ivh udmg-web-transfer-2.0.0.0.build.11.x86_64.rpm

For Debian based Linux:

sudo dpkg --install udmg-web-transfer-2.0.0.0.build.11.x86_64.dep

Step 3

Review the component configuration file.

/opt/udmg/etc/udmg/web-transfer/config.toml

Step 4

Start the components service.

sudo systemctl start udmg-web-transfer

Performing a Manual Installation

  • Create a directory under /opt/udmg/etc/udmg:

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

  • Create a configuration file for the service:

# sudo vi /opt/udmg/etc/udmg/web-transfer/config.toml

Configuration File

A sample configuration file with all the default parameters is shown below:

[settings]
####################################
# The settings section configures the
# Web Transfer Client UI
####################################
## Network interface, default "0.0.0.0"
inet = "0.0.0.0"
## Port, default "5050"
port = "5050"
## Working directory
workdir = "/home/udmg"
## SSL certificate, uncomment to enable HTTPS
#ssl_cert = "path_to_file.crt"
#ssl_cert_key = "path_to_file.key"
#############################################
# 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
## Enable Cross-Site Request Forgery (CSRF) token, default false, recommended to be true for production environment
csrf = true
## Enable Request Track ID, default true
tracker = true
## Enable Request Logger, default true
logger = true
## Enable Prometheus Metric endpoint /metrics, default false
metrics = false
## Enable Rate limit, no default, value of 0 disables the rate limit
limit = 50
## Update Interval, frequency of synchronization with the local auth service, default is 30 (seconds)
update_interval = 30


[secrets]
#############################################
# The secrets section configures the connection towards udmg-server
# and the Web Transfer Client Authentication Server (local-auth)
# There are no default, the local-auth server must be defined and started in the UDMG Server
#############################################
## URL of the Web Client Authentication server API, local-auth server
endpoint = "http://<LOCAL-AUTH-ADRESS>:<LOCAL-AUTH-PORT>"
## API Key to authenticate to the Web Client Authentication server
apikey = "<API_KEY>"

Note

The placeholders <LOCAL-AUTH-ADRESS>, <LOCAL-AUTH-PORT> and <API _KEY> must be set to the values from the local authentication server that is configured on the UDMG Admin UI. 

The workdir parameter must be the same as the Root Directory for the LOCAL_AUTH local server.

See the Tutorial - Create Authentication Server for UDMG Web Transfer Client.

  • Install the binary under /usr/local/bin:

# sudo install -m 755 udmg-web-transfer /usr/local/bin

Setup the Systemd Services

UDMG Web Transfer Client

Create a new service definition:

# sudo vi /etc/systemd/system/udmg-web-transfer.service


[Unit]
Description=UDMG Web Transfer

[Service]
Type=simple
User=udmg
Group=udmg
WorkingDirectory=/home/udmg
Environment=UDMG_WEB_TRANSFER=/opt/udmg/etc/udmg/web-transfer/config.toml
ExecStart=/bin/sh -c 'exec /usr/local/bin/udmg-web-transfer start'
Restart=on-failure

[Install]
WantedBy=multi-user.target

  • Enable the new service:

# sudo systemctl enable udmg-web-transfer.service
Created symlink /etc/systemd/system/multi-user.target.wants/udmg-web-transfer.service → /etc/systemd/system/udmg-web-transfer.service.

  • Start the service and check the status:

# sudo systemctl start udmg-web-transfer
# sudo systemctl status udmg-web-transfer