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

📝 docs: update README before publishing to crates.io

main
_ 2021-04-18 12:51:43 -05:00
parent c3858ec8bf
commit 2c4d46388a
3 changed files with 61 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.lock generated
View File

@ -11,7 +11,7 @@ dependencies = [
[[package]]
name = "always_equal"
version = "1.0.1"
version = "1.0.2"
[[package]]
name = "ansi_term"

31
crates/ptth_server/README.md Normal file
View File

@ -0,0 +1,31 @@
# PTTH Server
The PTTH server is an HTTP server that can serve files from
behind a firewall, because it only makes outgoing HTTP connections
to a PTTH relay.
```
View from outside the PTTH tunnel:
* HTTP client
|
| HTTP(S) requests
V
* ptth_relay
^
| HTTP(S) requests
|
* ptth_server
View from inside the PTTH tunnel:
* HTTP client
|
| HTTP(S) requests
V
* ptth_relay
|
| HTTP(S) requests
V
* ptth_server
```

32
crates/ptth_server/src/lib.rs
View File

@ -1,8 +1,34 @@
//! # PTTH Server
//!
//! The PTTH server makes outgoing HTTP connections to a
//! PTTH relay, and then serves incoming HTTP requests through
//! the relay.
//! The PTTH server is an HTTP server that can serve files from
//! behind a firewall, because it only makes outgoing HTTP connections
//! to a PTTH relay.
//!
//! ```
//! View from outside the PTTH tunnel:
//!
//! * HTTP client
//! |
//! | HTTP(S) requests
//! V
//! * ptth_relay
//! ^
//! | HTTP(S) requests
//! |
//! * ptth_server
//!
//! View from inside the PTTH tunnel:
//!
//! * HTTP client
//! |
//! | HTTP(S) requests
//! V
//! * ptth_relay
//! |
//! | HTTP(S) requests
//! V
//! * ptth_server
//! ```
#![warn (clippy::pedantic)]