Skip to content

Commit f9b6223

Browse files
committed
add README and config example
1 parent a8d44b9 commit f9b6223

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Overview
2+
3+
sshtun creates mutiple tunnels like `ssh -L`
4+
5+
# Install
6+
7+
`go install github.com/icexin/sshtun`
8+
9+
# Config
10+
11+
``` toml
12+
[ssh]
13+
# ssh address
14+
addr="example.com:22"
15+
16+
# ssh user name
17+
user="root"
18+
19+
# ssh user password
20+
password="xxx"
21+
22+
# or ssh private key
23+
keyPath="/Users/icexin/.ssh/id_rsa"
24+
25+
[ports]
26+
# listen on 0.0.0.0:8090 and forward connections to icexin.com:80
27+
8080="icexin.com:80"
28+
29+
# you may specify more tunnels
30+
8090="google.com:80"
31+
32+
```
33+
34+
# Usage
35+
36+
`./sshtun`

cfg.toml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[ssh]
2+
# ssh address
3+
addr="example.com:22"
4+
5+
# ssh user name
6+
user="root"
7+
8+
# ssh user password
9+
password="xxx"
10+
11+
# or ssh private key
12+
keyPath="/Users/icexin/.ssh/id_rsa"
13+
14+
[ports]
15+
# listen on 0.0.0.0:8090 and forward connections to icexin.com:80
16+
8080="icexin.com:80"
17+
18+
# you may specify more tunnels
19+
8090="google.com:80"

0 commit comments

Comments
 (0)