From 1d469c8dff6e6c326e1293e923469045af960868 Mon Sep 17 00:00:00 2001 From: _ <> Date: Mon, 9 Nov 2020 17:02:36 +0000 Subject: [PATCH] Update todo / readme --- README.md | 14 ++++++++++++-- todo.md | 3 ++- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ca0e78d..3b51c2f 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,16 @@ If you only have pre-built binaries: "ptth_file_server" is not needed for production. It's a standalone build of the file server module, for testing. +To run the relay behind Nginx, these directives improve time-to-first-byte +when streaming: + +``` +client_max_body_size 0; +proxy_http_version 1.1; +proxy_request_buffering off; +proxy_buffering off; +``` + ## Comparison with normal HTTP Normal HTTP: @@ -176,14 +186,14 @@ ptth_server and ptth_file_server use the `file_server` module. ptth_server will connect out to a ptth_relay instance and serve files through the reverse HTTP tunnel. -The http_serde module is shared by ptth_relay and ptth_server so that they +The `http_serde` module is shared by ptth_relay and ptth_server so that they can communicate with each other easily. ## Why are GitHub issues disabled? Because they are not part of Git. -For now, either email me (if you know me personally) or make a pull request to add an item to todo.md. +For now, either email me (if you know me personally) or make a pull request to add an item to [todo.md](todo.md). ## License diff --git a/todo.md b/todo.md index 4f10a06..d09be5b 100644 --- a/todo.md +++ b/todo.md @@ -1,4 +1,5 @@ -- Add byte counter in `trace!()` macro in the file server +- "Preview as" feature for Markdown / pretty-printed logs +- Add Prometheus metrics - Not working great behind reverse proxies - Show file server names in HTML