From daecac8554a71bf3b8b19d296a3d22dad66eb5d5 Mon Sep 17 00:00:00 2001 From: _ <> Date: Tue, 3 Nov 2020 01:20:24 +0000 Subject: [PATCH] Update readme --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d0eec8c..cdf44b4 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,15 @@ 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 @@ -26,7 +32,7 @@ the terminal. Copy that to 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 - Add the tripcodes of all servers to the server_tripcodes table