From ad44e96b3b4fcd20922a8f950fd149d2936d930a Mon Sep 17 00:00:00 2001 From: _ <> Date: Sun, 21 Mar 2021 19:10:24 +0000 Subject: [PATCH] drafting readme --- readme_draft.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/readme_draft.md b/readme_draft.md index 8f2a892..5a0bee0 100644 --- a/readme_draft.md +++ b/readme_draft.md @@ -16,6 +16,21 @@ Reqwest ---> | | <--- Server 5 # Setup +Pick a relay computer and a server computer. + +The relay must be able to accept incoming HTTP connections. If the relay +will be exposed to the Internet, you should use Nginx, Caddy, or Apache as a +reverse proxy to terminate TLS in front of ptth_relay. Relays on the Internet +will typically have a domain name so that clients and servers can find them. + +The server must have read access to the files you want to serve, and it must +be able to make outgoing HTTP(S) connections to the relay. The server +does not need a static IP, since it won't accept any incoming HTTP connections. + +Begin installing PTTH. Run `cargo install ptth_relay` on the relay and +`cargo install ptth_server` on the server. ptth_server is manually tested on +Windows and Linux. ptth_relay is manually tested on Linux only. + - Run ptth_relay on cloud host - Configure ptth_server for relay, with auto keygen - Add tripcode to relay config