tunnel: add README
rabbitprincess committed
Dec 5, 2025 at 21:19 UTC
4ba1bdd65532affa8b2a1af626c25811d36f0ec4
1 file changed
+38
cmd/portal-tunnel/README.md
new
+38
@@ -0,0 +1,38 @@
1
+# Portal-tunnel
2
+
3
+Portal-tunnel is a tunneling tool that connects your local services to a [portal network](github.com/gosuda/portal), without any additional configuration.
4
+
5
+## Usage
6
+
7
+You can run the tunnel using command-line flags or a configuration file.
8
+
9
+### Run binary
10
+
11
+```bash
12
+./bin/portal-tunnel --host localhost --port 8080 \
13
+ --relay portal.gosuda.org,portal.thumbgo.kr,portal.iwanhae.kr \
14
+ --name <service> \
15
+ --description "Service description" \
16
+ --tags tag1,tag2 \
17
+ --thumbnail https://example.com/thumb.png
18
+```
19
+
20
+## Flags
21
+
22
+```text
23
+Usage:
24
+ portal-tunnel [flags]
25
+
26
+Flags:
27
+ --config string Path to portal-tunnel config file
28
+ --description string Service description metadata
29
+ -h, --help help for portal-tunnel
30
+ --hide Hide service from discovery (metadata)
31
+ --host string Local host to proxy to when config is not provided (default "localhost")
32
+ --name string Service name when config is not provided (auto-generated if empty)
33
+ --owner string Service owner metadata
34
+ --port string Local port to proxy to when config is not provided (default "4018")
35
+ --relay string Portal relay server URLs when config is not provided (comma-separated) (default "ws://localhost:4017/relay")
36
+ --tags string Service tags metadata (comma-separated)
37
+ --thumbnail string Service thumbnail URL metadata
38
+```