Add readme

This commit is contained in:
Pierre HUBERT 2022-08-30 15:26:23 +02:00
parent 53ad29727e
commit 884018a90d

22
README.MD Normal file
View File

@ -0,0 +1,22 @@
# TCP over HTTP
This project aims to provide an easy-to-setup TCP forwarding solution:
```
|--------| |--------| |--------| | -------|
| | | Client | | Server | | |
| Client | -- TCP xx -- | | -- HTTP 80 / 443 -- | | -- TCP xx -- | Server |
| | | Relay | | Relay | | |
|--------|   |--------| |--------| |--------|
```
This project can be used especially to bypass firewalls that blocks traffics
from ports others than the 80 / 443 duo.
This repository contains two binaries:
* `tpc_relay_server`: The server relay
* `tcp_relay_client`: The client relay
The clients relay authenticates itself to the server using a token.
A single server - client relay pair can relay multiple ports simultaneously from the same machine.