Skip to main content

Setting Up the Web Transfer Client

This page explains how to enable and configure the Web Transfer Client (WTC), including prerequisites in the Configuration File, Endpoint setup, and Pipeline assignments.

Overview​

The WTC operates over HTTPS when UDMG acts as an HTTPS server, exposing a secure web interface on a defined IP address and port.

WTC configuration involves several components that work together:

  1. Global settings defined in the Configuration File.
  2. A Local HTTPS Server (WTC) Endpoint, the entry point for the WTC interface within a Domain. Only one can exist per Domain, and it inherits the global listener configuration.
  3. A Local Filesystem Endpoint that defines the physical storage location for uploaded and downloaded files.
  4. A UDMG as HTTPS Server Pipeline that connects the Local HTTPS Server (WTC) Endpoint to the Local Filesystem Endpoint, defining where files are stored and which operations are allowed.
  5. Account Groups that are associate to Pipelines to control partner access.

Configuration Steps​

Step 1. Enable the WTC Service​

Before partners can connect, you must enable and configure the Web Transfer Client (WTC) service in the wtc block of the Configuration File. These settings are global and apply to all Domains.

For example:

/opt/udmg/etc/udmg-server.hcl
wtc {
    # Enable the WTC service
    enable = true

    # IP address the WTC should listen on.
    # 0.0.0.0 listens on all available network interfaces.
    inet = "0.0.0.0"

    # HTTPS port number.
    port = 8443

    # Enables the OpenAPI spec at /spec and /swagger/index.html.
    spec = true

    # Path to the public SSL/TLS certificate file (PEM format).
    pub_key  = "path/to/pub/cert.pub"

    # Path to the WTC private key file (used for client certificate authentication).
    priv_key = "path/to/priv/cert.key"
}

After saving your changes, restart the UDMG Server to apply them:

sudo systemctl restart udmg-server

Step 2. Create a Local HTTPS Server (WTC) Endpoint​

Create a Local HTTPS Server (WTC) Endpoint following these steps.

Only one Local HTTPS Server (WTC) Endpoint can exist per Domain. Its configuration (listener IP, port, and certificates) is defined in the global WTC settings defined in Step 1.

Step 3. Create a Local Filesystem Endpoint​

Create a Local Filesystem Endpoint following these steps.

This endpoint defines the physical storage location where uploaded and downloaded files are written.

Step 4. Create a Pipeline​

Create a UDMG as HTTPS Server Pipeline to link the two Endpoints by following these steps.

This Pipeline determines how files are routed between the Local HTTPS Server (WTC) Endpoint and the Local Filesystem Endpoint, and what operations (upload, download, delete, rename) are allowed.

Step 5. Assign the Pipeline to an Account Group​

To give partners access to the WTC, assign the Pipeline to an appropriate Account Group by following these steps.

Step 6. Accessing the WTC Interface​

Partners can access the WTC using their web browser at:

https://{FQDN}:{PORT}/workspace/{DOMAIN}
  • {FQDN} — Fully Qualified Domain Name or IP address of the UDMG host.
  • {PORT} — The HTTPS port defined in the Configuration File (commonly 443 or 8443).
  • /workspace/ — A hard-coded path segment used by WTC to route web requests.
  • {DOMAIN} — The UDMG Domain the Account belongs to (for example, primary).

Example:

https://udmg.my-company.com:8443/workspace/primary

Partners will be prompted to log in with their Account, LDAP, or SSO credentials.