Metadata-Version: 2.1
Name: relay-tunnel
Version: 0.3.2
Summary: WebSocket relay tunnel plugin for turbo-tunnel.
Home-page: https://github.com/turbo-tunnel/relay-tunnel
Author: drunkdream
Author-email: drunkdream@qq.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Intended Audience :: Developers
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: turbo-tunnel

# RelayTunnel

用于建立中继隧道的TurboTunnel插件。

## 功能特性

* WebSocket Relay Tunnel
* HTTP(S) Relay Tunnel
* IRC Relay Tunnel（开发中）

## 使用方法

### 安装方法

```bash
$ pip3 install relay-tunnel
```

### WebSocket Relay Tunnel

* 中继服务端

```bash
$ turbo-tunnel -l ws+relay://0.0.0.0:8080/relay/ -p relay_tunnel
```

也可以使用Docker方式来运行：

```bash
$ sudo docker build -t relay-server -f docker/Dockerfile .
$ sudo docker run -it -p 8080:80 relay-server
```

* 中继节点

```bash
$ relay-tunnel -s "ws://10.0.0.1:8080/relay/?client_id=${node_id}"
```

其中`${node_id}`是中继节点的ID，可以为任意字符串，但必须保持唯一。

* 客户端

```bash
$ turbo-tunnel -l tcp://127.0.0.1:7777 -t "ws+replay://10.0.0.1:8080/relay/?client_id=${node_id}&target_id=${target_id}" -t tcp://private.com:80
```

这条命令表示将中继节点所在网络中的`private.com:80`服务映射到本地的`127.0.0.1:7777`地址。





