tcp-tunnel

TCP tunnel server & client, multi-user support

Usage no npm install needed!

<script type="module">
  import tcpTunnel from 'https://cdn.skypack.dev/tcp-tunnel';
</script>

README

NPM version build status Test coverage Gittip David deps node version npm download

中文版文档

tcp-tunnel

TCP tunnel server & client, multi-user support

Installation

required Node.js v4.0 or later version

$ npm install tcp-tunnel -g

Configuration

Server side configuration file server.conf

:value
port = 5000

# clients
# name:password
:client
A:123456
B:123456

# rules
# serverPort -> clientName:port
:rule
2022 -> A:22
3306 -> A:3306
6379 -> B:6379

Client side configuration file client.conf

:value
name = A
password = 123456
server = 192.168.9.10
serverPort = 5000

# mapping port
# sourcePort -> targetHost:port
:rule
3306 -> 192.168.99.100:3306
6379 -> 192.168.99.100:6379

Start client

$ ttclient -c client.conf

Start server

$ ttserver -c server.conf

If you have change the configuration item :client or :rule, you can pass additional argument -r to start the server, the runing server will just reload the newest configuration (not restart process):

$ ttserver -c server.conf -r

License

The MIT License (MIT)

Copyright (c) 2016 Zongmin Lei (老雷) <leizongmin@gmail.com>
http://ucdok.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.