Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ChatTheatre/websocket-to-tcp-tunnel
Tunnel connecting a client to a telnet backend
https://github.com/ChatTheatre/websocket-to-tcp-tunnel
Last synced: 3 months ago
JSON representation
Tunnel connecting a client to a telnet backend
- Host: GitHub
- URL: https://github.com/ChatTheatre/websocket-to-tcp-tunnel
- Owner: ChatTheatre
- License: mit
- Created: 2017-11-08T19:50:27.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T11:43:36.000Z (over 1 year ago)
- Last Synced: 2024-06-14T01:28:47.375Z (5 months ago)
- Language: JavaScript
- Size: 109 KB
- Stars: 2
- Watchers: 7
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-muds - websocket-to-tcp-tunnel
README
# WebSocket to TCP Tunnel
A basic relay between a listening WebSockets server and TCP server.
Data between both sockets is simply echoed to the other.
## Use with the SkotOS Client
You will most likely be using the `websocket-to-tcp-tunnel` with the orchil HTML5 client.
For that setup, please read the [orchil README](https://github.com/skotostech/orchil/blob/master/README.md) for complete instructions on how to set up orchil, `nginx`, `apache`, and this tunnel to work together.
If you are instead using the tunnel for some other purposes, and need to install it on its own (or if you want to better understand all of the configuration variables), read on.
## Requirements
* Node.js - The WebSocket server runs via Node.js
* npm - npm is used to install package dependencies.
## Installation
Clone the repository with `git clone https://github.com/skotostech/websocket-to-tcp-tunnel.git`.
From the new repository's root directory run `npm install`.
## Configuration
Rename `config.json.example` to `config.json` and edit to suit your needs.
Example (with all optional entries):
```json
{
"pidFileDirectory": "./",
"logDirectory": "./logs/",
"maximumRetries": 100,
"websocketHeartbeat": 15,
"shutdownDelay": 20,
"servers": [
{
"name": "My Server",
"listen": 1234,
"send": 1235,
"host": "domain.tld",
"sendTunnelInfo": true
}
]
}
```
### Server Configurations [REQUIRED]
Servers can be configured by adding objects to the property.
* `name` is used only for identification in output.
* `listen` is the port on which this server should listen for incoming WebSocket connections.
* `send` is the port on which the outgoing TCP socket should connect.
* `host` is the host to which the outgoing TCP socket should connect.
* `sendTunnelInfo` is a boolean representing whether or not this information should be sent
on connection. The default is `true`.
### PID Files [OPTIONAL]
The location of files containing PID information for each process can be defined with
the `pidFileDirectory` property.
*Defaults to `./`.*
### Logging [OPTIONAL]
The directory in which logs are written can be defined with the `logDirectory` property.
*Defaults to `./logs/`.*
### Maximum Retries [OPTIONAL]
If provided the `maximumRetries` property defines how many times Forever will restart a child before giving up.
This is useful in preventing runaway processes. If this property does not exist no limit will be set.
*Defaults to unlimited.*
### Heartbeat Delay [OPTIONAL]
The `websocketHeartbeat` will set the time between expected heartbeats for the Websocket client.
This is the number of seconds between consecutive heartbeats. When a heartbeat occurs, each connection will be sent a ping ("are you there?") and connections that do not reply will be disconnected.
*Defaults to 15.*
### Shutdown Delay [OPTIONAL]
The `shutdownDelay` determines the number of seconds between a process getting a signal to shutdown
and the exiting of the process. Connected clients of the relay will receive a message warning them
of the shutdown and the length of the delay.
## Starting Relay
To start the relay use `node main.js &` from the root directory of the cloned repository.