Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vd2org/wultiplexor
Wultiplexor is a reverse proxy server and client that uses websockets to multiplex tcp connections or unix sockets.
https://github.com/vd2org/wultiplexor
forward nat network networking pipe port proxy python socket tcp websocket websockets
Last synced: 7 days ago
JSON representation
Wultiplexor is a reverse proxy server and client that uses websockets to multiplex tcp connections or unix sockets.
- Host: GitHub
- URL: https://github.com/vd2org/wultiplexor
- Owner: vd2org
- License: mit
- Created: 2024-02-13T21:11:23.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-09-28T13:42:07.000Z (about 2 months ago)
- Last Synced: 2024-11-09T00:05:58.189Z (7 days ago)
- Topics: forward, nat, network, networking, pipe, port, proxy, python, socket, tcp, websocket, websockets
- Language: Python
- Homepage:
- Size: 405 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wultiplexor
## What?
Wultiplexor is a reverse proxy server and client that uses websockets to multiplex tcp connections or unix sockets.
You can use it to forward connections from one machine to another both behind NAT or firewall.
## How?
## Why?
In the beginning, I had needed to redirect a unix socket for one specific application.
Later I implemented this in a general way.
## Deploy server using docker compose
```shell
docker network create wultiplexor
DOMAIN=wultiplexor.example.com [email protected] SECRET=sEcReTkEy docker compose -p wultiplexor -f compose.yaml up --build -d
```
**WARNING:** The server is not intended to be used "as is" in a public accessible infrastructure.
Use a reverse proxy like [Traefik](https://github.com/traefik/traefik) to secure the connection like I did in the `compose.yaml` file.
## Install the client utility
```shell
pip install wultiplexor
```
## Usage: Forward tcp port
- On one machine, called the server or acceptor:
```shell
whannel ws://example.com/ acceptor -s sEcReTkEy localhost 8080 sEcReTGaTeWaYnAmeE
```
```shell
nc -l 8080
```
- On another machine, called client or requestor:
```shell
whannel ws://example.com/ requestor sEcReTGaTeWaYnAmeE 9090
```
```shell
nc localhost 9090
```
And now you can chat between two machines.
## Usage: Forward unix socket file
- On one machine, called the server or acceptor:
```shell
whannel wss://example.com/ sock-acceptor -s sEcReTkEy ./server sEcReTGaTeWaYnAmeE
```
```shell
socat UNIX-LISTEN:./server,fork STDIO
```
- On another machine, called client or requestor:
```shell
whannel wss://example.com/ sock-requestor sEcReTGaTeWaYnAmeE ./client
```
```shell
socat STDIO UNIX-CONNECT:./client
```
And now you can chat between two machines.
## Mixed usage
You can mix unix sockets and tcp ports. To do that, use tcp-acceptor from one side and sock-requestor from the another.
Or vice versa. This is also a way to "convert" a unix socket to a tcp port on the same machine.