Documentation
Proxy List

Proxy List

TSDProxy can be configured to proxy using a YAML configuration file. Multiple files can be used, and they are referred to as target providers. Each target provider could be used to group the way you decide better to help you manage your proxies. Or can use a single file to proxy all your targets.

Caution

Configuration files are case sensitive

How to enable?

In your /config/tsdproxy.yaml, specify the files you want to use, just like this example where the critical and media providers are defined.

/config/tsdproxy.yaml
files:
  critical:
    filename: /config/critical.yaml
    defaultProxyProvider: tailscale1
    defaultProxyAccessLog: true
  media:
    filename: /config/media.yaml
    defaultProxyProvider: default
    defaultProxyAccessLog: false
/config/critical.yaml
nas1:
  url: https://192.168.1.2:5001
  tlsValidate: false
nas2:
  url: https://192.168.1.3:5001
  tlsValidate: false
/config/media.yaml
music:
  url: http://192.168.1.10:3789
video:
  url: http://192.168.1.10:3800
photos:
  url: http://192.168.1.10:3801

This configuration will create two groups of proxies:

  • nas1.funny-name.ts.net and nas2.funny-name.ts.net
    • Self-signed tls certificates
    • Both use ’tailscale1’ Tailscale provider
    • All access logs are enabled
  • music.ts.net, video.ts.net and photos.ts.net.
    • On the same host with different ports
    • Use ‘default’ Tailscale provider
    • Don’t enable access logs

Provider Configuration options

/config/tsdproxy.yaml
files:
  critical: # Name the target provider
    filename: /config/critical.yaml # file with the proxy list
    defaultProxyProvider: tailscale1 # (optional) default proxy provider
    defaultProxyAccessLog: true # (optional) Enable access logs

Proxy list file options

/config/filename.yaml
music: # Name of the proxy
  url: http://192.168.1.10:3789 # url of service to proxy
  proxyProvider: default # (optional) name of the proxy provider
  tlsValidate: false # (optional, default true) disable TLS validation
  tailscale:  # (optional) Tailscale configuration for this proxy
    authKey: asdasdas # (optional) Tailscale authkey
    ephemeral: true # (optional) Enable ephemeral mode
    runWebClient: false # (optional) Run web client
    verbose: false # (optional) Run in verbose mode
    funnel: false # (optional) Run in funnel mode
  dashboard:
    visible: false # (optional) doesn't show proxy in dashboard
    label: "" # optional, label to be shown in dashboard
    icon: "" # optional, icon to be shown in dashboard

Tip

TSDProxy will reload the proxy list when it is updated. You only need to restart TSDProxy if your changes are in /config/tsdproxy.yaml

Note

See available icons in icons.

Last updated on
Docker ServicesAdvanced