Server configuration
TSDProxy uses the configuration file /config/tsdproxy.yaml
Important
The environment variables configuration used until v0.6.0 is deprecated and will be removed in the future.
Sample configuration File
Warning
Configuration files are case sensitive
defaultProxyProvider: default
docker:
local: # name of the docker target provider
host: unix:///var/run/docker.sock # host of the docker socket or daemon
targetHostname: 172.31.0.1 # hostname or IP of docker server
defaultProxyProvider: default # name of which proxy provider to use
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
tailscale:
providers:
default: # name of the provider
authKey: "" # define authkey here
authKeyFile: "" # use this to load authkey from file. If this is defined, Authkey is ignored
controlUrl: https://controlplane.tailscale.com # use this to override the default control URL
dataDir: /data/
http:
hostname: 0.0.0.0
port: 8080
log:
level: info # set logging level info, error or trace
json: false # set to true to enable json logging
proxyAccessLog: true # set to true to enable container access loglog section
level
Define the logging level. The default is info.
json
Set to true if what logging in json format.
tailscale section
You can use the following options to configure Tailscale:
dataDir
Define the data directory used by Tailscale. The default is /data/.
providers
Here you can define multiple Tailscale providers. Each provider is configured with the following options:
default: # name of the provider
authKey: your-authkey # define authkey here
authKeyFile: "" # use this to load authkey from file.
controlUrl: https://controlplane.tailscale.com Look at next example with multiple providers.
tailscale:
providers:
default:
authKey: your-authkey
authKeyFile: ""
controlUrl: https://controlplane.tailscale.com
server1:
authKey: authkey-server1
authKeyFile: ""
controlUrl: http://server1
differentkey:
authKey: authkey-with-diferent-tags
authKeyFile: ""
controlUrl: https://controlplane.tailscale.comTSDProxy is configured with 3 tailscale providers. Provider ‘default’ with tailscale servers, Provider ‘server1’ with a different tailscale server and provider ‘differentkey’ using the default tailscale server with a different authkey where you can add any tags.
Tip
Visit Tailscale page for more details.
docker section
TSDProxy can use multiple docker servers. Each docker server can be configured like this:
local: # name of the docker provider
host: unix:///var/run/docker.sock # host of the docker socket or daemon
targetHostname: 172.31.0.1 # hostname or IP of docker server
defaultProxyProvider: default # name of which proxy provider to useLook at next example of using a multiple docker servers configuration.
docker:
local:
host: unix:///var/run/docker.sock
defaultProxyProvider: default
srv1:
host: tcp://174.17.0.1:2376
targetHostname: 174.17.0.1
defaultProxyProvider: server1TSDProxy is configured with a local server and a server remote ‘srv1’
host
host is the address of the docker socket or daemon. The default is unix:///var/run/docker.sock
targetHostname
Is the ip address or dns name of docker server. TSDProxy has a autodetect system to connect with containers, but there’s some cases where it’s necessary to use the other interfaces besides the docker internals.
defaultProxyProvider
defaultProxyProvider is the name of the proxy provider to use. (defined in tailscale providers section). Any container defined to be proxied will use this provider unless it has a specific provider defined label.