summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2023-05-15 05:45:14 +0000
committersanine <sanine.not@pm.me>2023-05-15 05:45:14 +0000
commit9db22ca2f86f41f98baa23a8e53d69c22ece2a67 (patch)
treea988143f0b8e25dba292bbb1cc27a2c1d380b323
parentd63d171f17f24706d2952d1b705f4c2e41fd3318 (diff)
add explainer to README
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
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
-----