Skip to main content

USP Client Windows Installation

This guide details the steps required to install the USP Client on Windows using the provided installer.

Prerequisites​

info

For detailed instructions on how to generate the required SSH key pairs for client authentication and tunnel host verification, refer to Generating SSH Keys for USP Tunnels.

Installation​

1. Get the Windows installer​

To obtain the installation package, contact your Stonebranch representative. If you do not have a representative, reach out to support@stonebranch.com.

2. Install the package​

Run the UDMG Client installer and follow the prompts in the installation wizard to complete the installation.

Select the desired installation path or accept the default (C:\Program Files\Stonebranch\USP Client\).

3. Confirm creation of configuration file​

The USP Client utilizes a configuration file located at C:\Program Files\Stonebranch\USP Client\usp-client.hcl.

Verify that this file have been created correctly by running the following commands:

cd "C:\Program Files\Stonebranch\USP Client\"
dir

4. Set the USP Client's configuration file​

warning

All files that are going to be used by USP Manager need to be owned by the appropriate user and group (udmg). For more information, refer to File Ownership and Permissions.

Set the following arguments in the USP Client Configuration File:

usp-client.hcl
# Unique identifier for this USP Client instance.
# Must match exactly the Name field defined in the corresponding Proxy Client configuration. 
# Info note below links to more details.
name = "usp-client-1"

# Absolute path to the USP Client's private key used for authentication with the USP Server.
# Counterpart Public Key is in the Proxy Client's Public Key field.
key = "C:\Program Files\Stonebranch\USP Client\ssh_keys\usp-client-1-key" # Use this if you followed the Generating SSH Keys for USP Tunnels guide.

tunnel {
    # The hostname or IP address of the USP Server where this USP Client matching Tunnel is running.
    host = ""

    # The port where this USP Client matching Tunnel is listening.
    # It must match the Port field defined in the corresponding Tunnel configuration.
    port = ""

    # Absolute path to the public key used to validate the USP Server's private key.
    # Counterpart Private Key is in the Tunnel's Private Key field.
    host_key = "C:\Program Files\Stonebranch\USP Client\ssh_keys\usp-tunnel-key.pub" # Use this if you followed the Generating SSH Keys for USP Tunnels guide
}

log {
    # Specify a file path to write logs to a dedicated log file.
    path = "C:\Program Files\Stonebranch\USP Client\logs\usp-client.log"
}
info

For more context on how the name value is used, see Proxy Clients.

For a complete list of available configuration parameters, refer to USP Client Configuration File.

5. Enable and start the USP Client service​

On Windows, "enabling" the USP Client service means configuring it to start automatically when the system boots. You do this by setting the service StartupType to Automatic with the following command:

Set-Service -Name "usp-client" -StartupType Automatic

Then, start the service:

Start-Service -Name "usp-client"

6. Verify installation​

Verify that the service is running by executing the following command:

Get-Service "usp-client" | Select Name, Status, StartType
info

If you encounter any issues, refer to Troubleshooting, where we cover the most commonly encountered issues.