-
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Files target provider documentation
- Loading branch information
1 parent
fb30f37
commit 0fc3d97
Showing
5 changed files
with
102 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
--- | ||
title: Services configuration | ||
next: /docs/advanced | ||
title: Docker Services | ||
weight: 3 | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
title: Proxy List | ||
next: /docs/advanced | ||
weight: 4 | ||
--- | ||
|
||
TSDProxy can be configured to proxy using a YAML configuration file. | ||
Can be used multiple files a they are called 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. | ||
|
||
{{% steps %}} | ||
|
||
### How to enable? | ||
|
||
In yout /config/tsdproxy.yaml, define the files you want to use, just | ||
like this example where is defined the `critical` and `media` providers. | ||
|
||
```yaml {filename="/config/tsdproxy.yaml"} | ||
Files: | ||
critical: | ||
Filename: /config/critical.yaml | ||
DefaultProxyProvider: tailscale1 | ||
DefaultProxyAccessLog: true | ||
media: | ||
Filename: /config/media.yaml | ||
DefaultProxyProvider: default | ||
DefaultProxyAccessLog: false | ||
``` | ||
```yaml {filename="/config/critical.yaml"} | ||
nas1: | ||
url: https://192.168.1.2:5001 | ||
TLSValidate: false | ||
nas2: | ||
url: https://192.168.1.3:5001 | ||
TLSValidate: false | ||
``` | ||
```yaml {filename="/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 | ||
- Sse 'default' Tailscale provider | ||
- Don't enable access logs | ||
### Provider Configuration options | ||
```yaml {filename="/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 | ||
```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 validationTailscale | ||
Tailscale: # (optional) Tailscale configuration for this proxy | ||
AuthKey: asdasdas # 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 | ||
``` | ||
{{% /steps %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters