Requirements
Windows Server 2012 R2 (or Windows 8.1) and later
UDMG 2.0 with the modules:
UDMG Admin UI
UDMG Authentication Proxy
UDMG Server
WinSW (https://github.com/winsw/winsw/releases/tag/v2.11.0) for service management, optional.
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 prior to 2.0.0.0, the start parameters for the module have changed.
The module now requires a 'start' command to begin 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 to verify the the syntax of the configuration file 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 recommendedbackupof configuration files. |
Step 3 | Stop the component's service.
|
Step 4 | Replace the component binary
|
Step 5 | Review the component configuration file.
|
Step 6 | Start the components service.
|
Installing UDMG Web Transfer Client
Create a directory "
C:\UDMG\
UDMG Web Transfer"
Create a configuration file for the service: "C:\
\UDMG
\config.toml"UDMG Web Transfer
[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
under "udmg-web-transfer
.exeC:\
\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\
with the following name:UDMG Web Transfer"
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
.exearguments: start
priority: Normal
workingdirectory: C:\UDMG\
UDMG Web Transfer
env:
-
name: UDMG_WEB_TRANSFER
value: 'C:\UDMG\
\config.toml'UDMG Web Transfer
- Open a command prompt under
C:\UDMG\
and run the command.UDMG Web Transfer
C:\
\UDMG
> UDMG Web Transfer
udmg-web-transfer
-service.exe install2022-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 start2022-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.