reactor
/
ptth
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update readme

main
_ 2020-11-03 01:20:24 +00:00
parent 4a1e1a7c23
commit daecac8554
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -3,9 +3,15 @@
An HTTP server that can run behind a firewall by connecting out to a relay. An HTTP server that can run behind a firewall by connecting out to a relay.
``` ```
Outside the tunnel
+--------+ +------------+ +-------------+ +--------+ +------------+ +-------------+
| Client |-------->| PTTH relay |<-------| PTTH server | | Client | ------> | PTTH relay | <----- | PTTH server |
+--------+ +------------+ +-------------+ +--------+ +------------+ +-------------+
Inside the tunnel
+--------+ -------------- +-------------+
| Client | ----------------------------> | Server |
+--------+ -------------- +-------------+
``` ```
The server can run behind a firewall, because it is actually a special HTTP The server can run behind a firewall, because it is actually a special HTTP
@ -26,7 +32,7 @@ the terminal. Copy that to the relay.
Configuring the relay: Configuring the relay:
- Copy ptth_relay onto the server - Copy ptth_relay onto the server (A Dockerfile is provided with no guarantees)
- Create ptth_relay.toml in the relay's working dir - Create ptth_relay.toml in the relay's working dir
- Add the tripcodes of all servers to the server_tripcodes table - Add the tripcodes of all servers to the server_tripcodes table