From 9db22ca2f86f41f98baa23a8e53d69c22ece2a67 Mon Sep 17 00:00:00 2001 From: sanine Date: Mon, 15 May 2023 05:45:14 +0000 Subject: add explainer to README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e0b95b7..15be2ff 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,16 @@ a simple, authenticated reverse-proxy server. this is intended for simple use cases, like if you have a weird little web app that may have some security concerns that you'd still like to be able to access on the public internet. +what does this do? +------------------ + +phlox is a normal reverse-proxy server, except it refuses +to let you access anything it's proxying unless you are +signed in. if you try, it just redirects you to the login +page. + +you can set custom login and error pages to customize phlox. + usage ----- -- cgit v1.2.1