summaryrefslogtreecommitdiff
path: root/doc/ssh_tunnels_config_util.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ssh_tunnels_config_util.md')
-rw-r--r--doc/ssh_tunnels_config_util.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/ssh_tunnels_config_util.md b/doc/ssh_tunnels_config_util.md
new file mode 100644
index 0000000..590f158
--- /dev/null
+++ b/doc/ssh_tunnels_config_util.md
@@ -0,0 +1,23 @@
+## Config example
+
+`~/.config/ssh_tunnels_config_util.toml`:
+
+```toml
+network = "192.168.1"
+http_bind_base = 20000
+ssh_bind_base = 21000
+
+[nas1]
+ipv4 = 100
+http_port = 80
+bind_slot = 0
+
+[nas2]
+ipv4 = 101
+http_port = 8080
+bind_slot = 1
+```
+
+## Usage
+
+Write config, run the script and use the output in the ssh tunnel service. \ No newline at end of file