Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ooclab/otunnel
peer-to-peer tunnel tool
https://github.com/ooclab/otunnel
forward-proxy golang network peer-to-peer proxy reverse-proxy tunnel
Last synced: 3 months ago
JSON representation
peer-to-peer tunnel tool
- Host: GitHub
- URL: https://github.com/ooclab/otunnel
- Owner: ooclab
- License: mit
- Created: 2016-11-07T09:44:38.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-05T02:52:30.000Z (about 6 years ago)
- Last Synced: 2024-08-02T02:14:46.709Z (6 months ago)
- Topics: forward-proxy, golang, network, peer-to-peer, proxy, reverse-proxy, tunnel
- Language: Go
- Size: 3.65 MB
- Stars: 240
- Watchers: 25
- Forks: 59
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-network-stuff - **210**星 - to-peer tunnel tool (<a id="01e6651181d405ecdcd92a452989e7e0"></a>工具 / <a id="9d6789f22a280f5bb6491d1353b02384"></a>隧道&&穿透)
README
# otunnel
otunnel is a simple safe tunnel for peer-to-peer
## Build
simple build (RECOMMENDED):
```
$ ./build-by-docker.sh
```
others:
```
$ go get -v github.com/ooclab/otunnel
$ export GOPATH=${GOPATH:-~/go}
$ cd $GOPATH/src/github.com/ooclab/otunnel
$ # use any of following commands to build otunnel
$ make # normal build
$ make static # build a static program
$ go build -v # the go build
$ gox # simple cross build, you should install gox first!
```
### Platform Example
#### dd-wrt
Netgear WNDR4300 (Firmware: DD-WRT v3.0-r37882 std (11/30/18))
```
GOOS=linux GOARCH=mips GOMIPS=softfloat go build -a -ldflags '-s -w'
```
## Usage
Start a server at a public server ( example.com ):
```
./otunnel listen -d
```
Start a client (reverse forward):
```
./otunnel connect example.com:10000 -d -t r:LOCAL_HOST:LOCAL_PORT::REMOTE_PORT
```
Now, anyone can access your `LOCAL_HOST:LOCAL_PORT` by `example.com:REMOTE_PORT`.
## SystemD
In the server side (listen a port) , create `/etc/systemd/system/otunnel-listen.service` :
```
[Unit]
Description=Otunnel Listen Service
After=network.target
[Service]
Type=simple
Restart=on-failure
ExecStart=/usr/local/bin/otunnel listen :20000 -d -s THE_SECRET
[Install]
WantedBy=multi-user.target
```
start `otunnel-listen` service:
```
systemctl start otunnel-listen
```
In the client side, create `/etc/systemd/system/otunnel-connect.service` :
```
[Unit]
Description=Otunnel Connect Service
After=network.target
[Service]
Type=simple
Restart=on-failure
ExecStart=/usr/local/bin/otunnel connect YOUR_SERVER_IP:20000 -d -s THE_SECRET -t "r:127.0.0.1:22::50022"
[Install]
WantedBy=multi-user.target
```
start `otunnel-connect` service:
```
systemctl start otunnel-connect
```
## Docker
Run a server:
```
docker run --rm -it --net=host ooclab/otunnel-amd64 /otunnel listen :10000 -d -s abc123
```
Run a client:
```
docker run --rm -it --net=host ooclab/otunnel-amd64 /otunnel connect SERVER_IP:10000 -d -s abc123 -t 'f:127.0.0.1:10022:HOST_IP:HOST_PORT'
```
## Document
[Wiki / 手册](https://github.com/ooclab/otunnel/wiki)
## Download
[Download](http://dl.ooclab.com/otunnel/)
For example:
```
wget http://dl.ooclab.com/otunnel/1.2.3/otunnel_linux_amd64.xz
unxz otunnel_linux_amd64.xz
chmod a+x otunnel_linux_amd64
mv otunnel_linux_amd64 otunnel
```
## Help
Please send issues to [github.com/ooclab/otunnel/issues](https://github.com/ooclab/otunnel/issues) .
## Other Projects
- qtunnel
- ngrok
- frp
- pagekite