@@ -4,153 +4,152 @@ weight: 2
44next : /providers
55---
66
7+ TSDProxy utilizes the configuration file ` /config/tsdproxy.yaml ` for its settings.
78
8- TSDProxy uses the configuration file ` /config/tsdproxy.yaml `
9-
10- > [ !IMPORTANT]
11- > The environment variables configuration used until v0.6.0 is deprecated and
12- > will be removed in the future.
9+ > [ !IMPORTANT]
10+ > Environment variable configurations used in versions prior to v0.6.0 are
11+ > deprecated and will be removed in future releases.
1312
1413{{% steps %}}
1514
16- ### Sample configuration File
15+ ### Sample Configuration File
1716
18- > [ !WARNING ]
19- > Configuration files are case sensitive
17+ > [ !Warning ]
18+ > Configuration files are case- sensitive.
2019
21- ``` yaml {filename="/config/tsdproxy.yaml"}
20+ ``` yaml {filename="/config/tsdproxy.yaml"}
2221defaultProxyProvider : default
2322docker :
24- local : # name of the docker target provider
25- host : unix:///var/run/docker.sock # host of the docker socket or daemon
26- targetHostname : 172.31.0.1 # hostname or IP of docker server
27- defaultProxyProvider : default # name of which proxy provider to use
23+ local : # Name of the Docker target provider
24+ host : unix:///var/run/docker.sock # Docker socket or daemon address
25+ targetHostname : 172.31.0.1 # Docker server hostname or IP
26+ defaultProxyProvider : default # Default proxy provider for this Docker server
2827lists :
29- critical : # Name the target provider
30- filename : /config/critical.yaml # file with the proxy list
31- defaultProxyProvider : tailscale1 # (optional) default proxy provider
32- defaultProxyAccessLog : true # (optional ) Enable access logs
28+ critical : # Name of the target list provider
29+ filename : /config/critical.yaml # Path to the proxy list file
30+ defaultProxyProvider : tailscale1 # (Optional) Default proxy provider for this list
31+ defaultProxyAccessLog : true # (Optional ) Enable access logs for this list
3332tailscale :
3433 providers :
35- default : # name of the provider
36- clientId : " asdasd" # OAuth clientId (generated by tailscale)
37- clientSecret : " asdasd" # OAuth clientSecret (generated by tailscale)
38- # if clientId and clientSecret are defined, authKey and authKeyFile are ignored
39- authKey : " " # define authkey here
40- authKeyFile : " " # use this to load authkey from file. If this is defined, Authkey is ignored
41- tags : " tag:example,tag:server" # default tags for all containers
42- # if a container is configured with tags this tag list is ignored
43- controlUrl : https://controlplane.tailscale.com # use this to override the default control URL
44- dataDir : /data/
34+ default : # Name of the Tailscale provider
35+ clientId : " your_client_id" # OAuth client ID (generated by Tailscale)
36+ clientSecret : " your_client_secret" # OAuth client secret (generated by Tailscale)
37+ # If clientId and clientSecret are defined, authKey
38+ # and authKeyFile are ignored
39+ authKey : " " # Tailscale auth key (alternative to OAuth)
40+ authKeyFile : " " # Path to a file containing the auth key (ignores authKey if defined)
41+ tags : " tag:example,tag:server" # Default tags for all containers using this provider
42+ # Container-specific tags override these default tags
43+ controlUrl : https://controlplane.tailscale.com # Override the default Tailscale control URL
44+ dataDir : /data/ # Tailscale data directory
4545http :
46- hostname : 0.0.0.0
47- port : 8080
46+ hostname : 0.0.0.0 # HTTP server hostname
47+ port : 8080 # HTTP server port
4848log :
49- level : info # set logging level info, error or trace
50- json : false # set to true to enable json logging
51- proxyAccessLog : true # set to true to enable container access log
49+ level : info # Logging level ( info, error, debug or trace)
50+ json : false # Enable JSON logging (true/false)
51+ proxyAccessLog : true # Enable container access logs (true/false)
5252` ` `
5353
54- ### log section
54+ ### Configuration Sections
55+
56+ #### log Section
5557
56- #### level
58+ ##### level
5759
58- Define the logging level. The default is info.
60+ Defines the logging level. Options are ` info`, `error`, `debug` or `trace`.
61+ The default is `info`.
5962
60- #### json
63+ # #### json
6164
62- Set to true if what logging in json format .
65+ Enables JSON-formatted logging when set to `true`. Defaults to `false` .
6366
64- ### tailscale section
67+ # ### tailscale Section
6568
66- You can use the following options to configure Tailscale:
69+ Configures Tailscale integration.
6770
68- #### dataDir
71+ # #### dataDir
6972
70- Define the data directory used by Tailscale. The default is ` /data/`.
73+ Specifies the data directory used by Tailscale. Defaults to `/data/`.
7174
72- # ### providers
75+ # #### providers
7376
74- Here you can define multiple Tailscale providers. Each provider is configured
75- with the following options :
77+ Defines multiple Tailscale providers. Each provider has the following options :
7678
77- ` ` ` yaml {filename="/config/tsdproxy.yaml"}
78- default: # name of the provider
79- authKey: your-authkey # define authkey here
80- authKeyFile: "" # use this to load authkey from file.
81- controlUrl: https://controlplane.tailscale.com
79+ ` ` ` yaml {filename="/config/tsdproxy.yaml"}
80+ default: # Provider name
81+ authKey: your-authkey # Tailscale auth key
82+ authKeyFile: "" # Path to auth key file
83+ controlUrl: https://controlplane.tailscale.com # Tailscale control URL
8284` ` `
8385
84- Look at next example with multiple providers.
86+ Example with multiple providers:
8587
86- ` ` ` yaml {filename="/config/tsdproxy.yaml"}
88+ ` ` ` yaml {filename="/config/tsdproxy.yaml"}
8789tailscale:
8890 providers:
8991 default:
9092 authKey: your-authkey
9193 authKeyFile: ""
9294 controlUrl: https://controlplane.tailscale.com
93-
95+
9496 server1:
9597 authKey: authkey-server1
9698 authKeyFile: ""
9799 controlUrl: http://server1
98-
100+
99101 differentkey:
100- authKey: authkey-with-diferent -tags
102+ authKey: authkey-with-different -tags
101103 authKeyFile: ""
102104 controlUrl: https://controlplane.tailscale.com
103105` ` `
104106
105- TSDProxy is configured with 3 tailscale providers. Provider 'default' with tailscale
106- servers, Provider 'server1' with a different tailscale server and provider 'differentkey'
107- using the default tailscale server with a different authkey where you can add any
108- tags.
107+ This example configures three Tailscale providers : ` default` (default server),
108+ ` server1` (different Tailscale server), and `differentkey` (default server with
109+ a different auth key for specific tags).
109110
110- > [!TIP ]
111- > Visit [Tailscale page](../advanced/tailscale/) for more details .
111+ > [!Tip ]
112+ > For more details, see the [Tailscale page](../advanced/tailscale/).
112113
113- # ## docker section
114+ # ### docker Section
114115
115- TSDProxy can use multiple docker servers. Each docker server can be configured
116- like this :
116+ Configures Docker server connections. Multiple Docker servers can be defined :
117117
118- ` ` ` yaml {filename="/config/tsdproxy.yaml"}
119- local: # name of the docker provider
120- host: unix:///var/run/docker.sock # host of the docker socket or daemon
121- targetHostname: 172.31.0.1 # hostname or IP of docker server
122- defaultProxyProvider: default # name of which proxy provider to use
118+ ` ` ` yaml {filename="/config/tsdproxy.yaml"}
119+ local: # Docker provider name
120+ host: unix:///var/run/docker.sock # Docker socket or daemon address
121+ targetHostname: 172.31.0.1 # Docker server hostname or IP
122+ defaultProxyProvider: default # Default proxy provider for this Docker server
123123` ` `
124124
125- Look at next example of using a multiple docker servers configuration.
125+ Example with multiple Docker servers:
126126
127- ` ` ` yaml {filename="/config/tsdproxy.yaml"}
127+ ` ` ` yaml {filename="/config/tsdproxy.yaml"}
128128docker:
129- local:
130- host: unix:///var/run/docker.sock
131- defaultProxyProvider: default
132- srv1:
129+ local:
130+ host: unix:///var/run/docker.sock
131+ defaultProxyProvider: default
132+ srv1:
133133 host: tcp://174.17.0.1:2376
134134 targetHostname: 174.17.0.1
135135 defaultProxyProvider: server1
136136` ` `
137137
138- TSDProxy is configured with a local server and a server remote ' srv1'
138+ This example configures a ` local` Docker server and a remote ` srv1` server.
139139
140- # ### host
140+ # #### host
141141
142- host is the address of the docker socket or daemon. The default is `unix:///var/run/docker.sock`
142+ Specifies the Docker socket or daemon address. Defaults to `unix:///var/run/docker.sock`.
143143
144- # ### targetHostname
144+ # #### targetHostname
145145
146- Is the ip address or dns name of docker server. TSDProxy has a autodetect system
147- to connect with containers, but there's some cases where it's necessary to use
148- the other interfaces besides the docker internals.
146+ Specifies the IP address or DNS name of the Docker server. Used for connecting to
147+ containers in specific cases.
149148
150- # ### defaultProxyProvider
149+ # #### defaultProxyProvider
151150
152- defaultProxyProvider is the name of the proxy provider to use. (defined in tailscale
153- providers section). Any container defined to be proxied will use this provider
154- unless it has a specific provider defined label .
151+ Specifies the default Tailscale provider (defined in the ` tailscale.providers`
152+ section) to use for containers on this Docker server. Container-specific labels
153+ override this setting .
155154
156155{{% /steps %}}
0 commit comments