UDMG Web Transfer Client for Windows Installation

Owned by
Stonebranch
Last updated: Jun 02, 2024 by
Katie Murphy

Requirements

Upgrading UDMG Web Transfer Client

Note

UDMG Web Transfer Client must be upgraded at the same 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.

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.

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 component's service.

"C:\UDMG\UDMG Web Transfer\udmg-web-transfer-service.exe" stop

Step 4

Replace the component binary.

"C:\UDMG\UDMG Web Transfer\udmg-web-transfer.exe"

Step 5

Review the component configuration file.

"C:\UDMG\UDMG Web Transfer\config.toml"

Step 6

Start the components service.

"C:\UDMG\UDMG Web Transfer\udmg-web-transfer-service.exe" start

Installing UDMG Web Transfer Client

  • Create a directory "C:\UDMG\UDMG Web Transfer"

  • Create a configuration file for the service: "C:\UDMG\UDMG Web Transfer\config.toml"

[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 = "C:\\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>"

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, see Tutorial - Create Authentication Server for UDMG Web Transfer Client.

  • Copy the binary udmg-web-transfer.exe under "C:\UDMG\UDMG Web Transfer"

Setup the Windows Service with WinSW


UDMG Web Transfer Client


  • Download WinSW and copy the binary winsw.exe under "C:\UDMG\UDMG Web Transfer" with the following name: udmg-web-transfer-service.exe
  • Create a new service definition file: udmg-web-transfer-service.yml

id: UDMG Web Transfer
name: UDMG Web Transfer
description: UDMG Web Transfer
executable: C:\UDMG\UDMG Web Transfer\udmg-web-transfer.exe
arguments: start
priority: Normal
workingdirectory: C:\UDMG\UDMG Web Transfer
env:
  -

    name: UDMG_WEB_TRANSFER
    value: 'C:\UDMG\UDMG Web Transfer\config.toml'

  • Open a command prompt under C:\UDMG\UDMG Web Transfer and run the command.

C:\UDMG\UDMG Web Transfer> udmg-web-transfer-service.exe install
2022-07-11 11:23:24,653 INFO - Installing service 'UDMG Web Transfer (UDMG Web Transfer)'...
2022-07-11 11:23:24,680 INFO - Service 'UDMG Web Transfer (UDMG Web Transfer)' was installed successfully.

  • Start the service.

C:\UDMG\UDMG Web Transfer> udmg-web-transfer-service.exe start
2022-07-11 11:23:24,653 INFO - Starting service 'UDMG Web Transfer (UDMG Web Transfer)'...
2022-07-11 11:23:24,680 INFO - Service 'UDMG Web Transfer (UDMG Web Transfer)' started successfully.