Skip to content

Commit

Permalink
docs: upddate to case sensitive config files
Browse files Browse the repository at this point in the history
  • Loading branch information
almeidapaulopt committed Dec 25, 2024
1 parent f0d3346 commit a125b41
Show file tree
Hide file tree
Showing 8 changed files with 119 additions and 98 deletions.
29 changes: 23 additions & 6 deletions docs/content/docs/advanced/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ title: Dashboard
prev: /docs/advanced
---

{{< callout type="warning" >}}
Dashboard is still in very early stages of development.
{{< /callout >}}

{{% steps %}}

### TSDProxy docker compose
### Dashboard in docker

#### TSDProxy docker compose

Update docker-compose.yml with the following:

Expand All @@ -19,12 +17,31 @@ Update docker-compose.yml with the following:
- tsdproxy.name=dash
```
### Restart TSDProxy
#### Restart TSDProxy
```bash
docker compose restart
```

### Standalone

#### Configure files provider

Configure a new files provider or configure it in any existing files provider.

```yaml {filename="/config/tsdproxy.yaml"}
files:
proxies:
filename: /config/proxies.yaml
```
#### Add Dashboard entry on your files provider
```yaml {filename="/config/proxies.yaml"}
dash:
url: http://127.0.0.1:8080
```
### Test Dashboard access
```bash
Expand Down
48 changes: 24 additions & 24 deletions docs/content/docs/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,24 @@ In your /config/tsdproxy.yaml, specify the files you want to use, just
like this example where the `critical` and `media` providers are defined.

```yaml {filename="/config/tsdproxy.yaml"}
Files:
files:
critical:
Filename: /config/critical.yaml
DefaultProxyProvider: tailscale1
DefaultProxyAccessLog: true
filename: /config/critical.yaml
defaultProxyProvider: tailscale1
defaultProxyAccessLog: true
media:
Filename: /config/media.yaml
DefaultProxyProvider: default
DefaultProxyAccessLog: false
filename: /config/media.yaml
defaultProxyProvider: default
defaultProxyAccessLog: false
```
```yaml {filename="/config/critical.yaml"}
nas1:
url: https://192.168.1.2:5001
TLSValidate: false
tlsValidate: false
nas2:
url: https://192.168.1.3:5001
TLSValidate: false
tlsValidate: false
```
```yaml {filename="/config/media.yaml"}
Expand All @@ -65,28 +65,28 @@ This configuration will create two groups of proxies:
### Provider Configuration options
```yaml {filename="/config/tsdproxy.yaml"}
Files:
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
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
```yaml {filename="/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
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
```
{{% /steps %}}
16 changes: 8 additions & 8 deletions docs/content/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,27 @@ After the TSDProxy container is started, a configuration file
`/config/tsdproxy.yaml` is created and populated with the following:

```yaml
defaultproxyprovider: default
defaultProxyProvider: default
docker:
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 use
targetHostname: 172.31.0.1 # hostname or IP of docker server
defaultProxyProvider: default # name of which proxy provider to use
file: {}
tailscale:
providers:
default: # name of the provider
authkey: your-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/
authKey: your-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 log
proxyAccessLog: true # set to true to enable container access log
```
#### Edit the configuration file
Expand Down
10 changes: 5 additions & 5 deletions docs/content/docs/scenarios/1i-2docker-1tailscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,17 @@ volumes:
## TSDProxy Configuration
```yaml {filename="/config/tsdproxy.yaml"}
defaultproxyprovider: default
defaultProxyProvider: default
docker:
srv1:
host: unix:///var/run/docker.sock
defaultproxyprovider: default
defaultProxyProvider: default
srv2:
host: tcp://174.17.0.1:2376
targethostname: 174.17.0.1
defaultproxyprovider: default
targetHostname: 174.17.0.1
defaultProxyProvider: default
tailscale:
providers:
default:
authkey: "sdfsdgsdfgdfg"
authKey: "sdfsdgsdfgdfg"
```
14 changes: 7 additions & 7 deletions docs/content/docs/scenarios/1i-2docker-3tailscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,21 +93,21 @@ volumes:
## TSDProxy Configuration
```yaml {filename="/config/tsdproxy.yaml"}
defaultproxyprovider: default
defaultProxyProvider: default
docker:
srv1:
host: unix:///var/run/docker.sock
defaultproxyprovider: default
defaultProxyProvider: default
srv2:
host: tcp://174.17.0.1:2376
targethostname: 174.17.0.1
defaultproxyprovider: account2
targetHostname: 174.17.0.1
defaultProxyProvider: account2
tailscale:
providers:
default:
authkey: "sdfsdgsdfgdfg"
authKey: "sdfsdgsdfgdfg"
withtags:
authkey: "jujgnndvds"
authKey: "jujgnndvds"
account2:
authkey: "nnnnnnndndnddd"
authKey: "nnnnnnndndnddd"
```
12 changes: 6 additions & 6 deletions docs/content/docs/scenarios/2i-2docker-1tailscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,27 +97,27 @@ volumes:
## TSDProxy Configuration of SRV1
```yaml {filename="/config/tsdproxy.yaml"}
defaultproxyprovider: default
defaultProxyProvider: default
docker:
srv1:
host: unix:///var/run/docker.sock
defaultproxyprovider: default
defaultProxyProvider: default
tailscale:
providers:
default:
authkey: "SAMEKEY"
authKey: "SAMEKEY"
```
## TSDProxy Configuration of SRV2
```yaml {filename="/config/tsdproxy.yaml"}
defaultproxyprovider: default
defaultProxyProvider: default
docker:
srv2:
host: unix:///var/run/docker.sock
defaultproxyprovider: default
defaultProxyProvider: default
tailscale:
providers:
default:
authkey: "SAMEKEY"
authKey: "SAMEKEY"
```
20 changes: 10 additions & 10 deletions docs/content/docs/scenarios/2i-2docker-3tailscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,35 +94,35 @@ volumes:
## TSDProxy Configuration of SRV1
```yaml {filename="/config/tsdproxy.yaml"}
defaultproxyprovider: default
defaultProxyProvider: default
docker:
srv1:
host: unix:///var/run/docker.sock
defaultproxyprovider: default
defaultProxyProvider: default
tailscale:
providers:
default:
authkey: "sdfsdgsdfgdfg"
authKey: "sdfsdgsdfgdfg"
withtags:
authkey: "jujgnndvds"
authKey: "jujgnndvds"
account2:
authkey: "nnnnnnndndnddd"
authKey: "nnnnnnndndnddd"
```
## TSDProxy Configuration of SRV2
```yaml {filename="/config/tsdproxy.yaml"}
defaultproxyprovider: default
defaultProxyProvider: default
docker:
srv2:
host: unix:///var/run/docker.sock
defaultproxyprovider: account2
defaultProxyProvider: account2
tailscale:
providers:
default:
authkey: "sdfsdgsdfgdfg"
authKey: "sdfsdgsdfgdfg"
withtags:
authkey: "jujgnndvds"
authKey: "jujgnndvds"
account2:
authkey: "nnnnnnndndnddd"
authKey: "nnnnnnndndnddd"
```
Loading

0 comments on commit a125b41

Please sign in to comment.