doc: update readme

This commit is contained in:
wpetit 2024-02-28 09:23:52 +01:00
parent 6b1637d1d8
commit c583f63b6c

View File

@ -1,19 +1,23 @@
# Rebound
Serveur utilisant le protocole SSH pour créer des tunnels TCP/IP.
An TCP tunneling server requiring only a SSH client.
## Usage
### Ouvrir un tunnel sur un port local
We wants to access `<local_address>:<local_port>` from machine A's network as `<target_port>` on machine B.
### Opening the tunnel on machine A
```shell
ssh -R 0:<target_address>:<target_port> root@rebound.lookingfora.name -p 2222
ssh -R 0:<local_address>:<local_port> root@rebound-server -p 80
```
### Se connecter à un tunnel ouvert
### Connecting to the tunnel on machine B
```
ssh -L <local_port>:0.0.0.0:1 <secret>@rebound.lookingfora.name -p 2222
```shell
ssh -L <target_port>:0.0.0.0:1 <secret>@rebound-server -p 80
```
Vous pourrez ensuite accéder au service sur `127.0.0.1:<local_port>` comme si c'était `<target_address>:<target_port>`.
## Licence
[AGPL-3.0](./LICENCE.md)