UDMG Web Transfer Client for Windows Installation

Owned by Stonebranch (Deactivated)
Last updated: Oct 06, 2023 by Olivier Michaut

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.

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 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]
####################################
# Web Transfer Client
####################################
## 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
#############################################
## 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, should 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 /metrics
metrics = true
## Enable Ratelimit
limit = 50
## Update Interval, number of seconds before to send a upload to the local auth service
update_interval = 60

#############################################
# Web Transfer Client Authentication Server
# This is defined in the UDMG Server
#############################################
[secrets]
## URL of the Web Client Authentication server API
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
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.