Skip to main content

USP Server

USP Server is the central component of the UDMG Secure Proxy (USP) platform. It receives inbound connections, applies authentication and session break logic, and routes connections to internal targets. It also exposes SSH tunnels to receive traffic relayed by USP Clients.

Configuration Overview

USP Server uses a small set of required settings to run. Some values have no defaults, so you must define them before running the service.

USP Server reads configuration from two sources:

info
Any configuration value defined via an environment variable overrides the corresponding value in the HCL file.

Configuration File

You can specify the path to the configuration file using one of the following options (in order of precedence):

  1. Environment Variable: USP_SERVER_CONFIG
  2. Command Line Flag: -c or --config
  3. Default File: usp-server.hcl (lowest precedence)

Commands Usage

To view available commands and flags, run:

usp-server -h

To run a command:

usp-server [command]

Available Commands

CommandDescription
usp-server [command] --helpShow help for a command
completionGenerate shell autocompletion
helpDisplay help about commands
startStart the USP Server

Available Flags

-h, --help      help for usp-server
-v, --version version for usp-server

Start USP Server

To start the USP Server:

usp-server start [flags]

Flags:

  • -c, --config string: Path to the configuration file (default: usp-server.hcl)
  • -h, --help: Show help for the start command