summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortjpcc <tjp@ctrl-c.club>2023-10-31 11:11:53 -0600
committertjpcc <tjp@ctrl-c.club>2023-10-31 11:15:08 -0600
commit1a3ec70d3f0b7d62e570f3b85aa7e0e034a2cc7b (patch)
tree08e3f9dfc1260cb324625b6437b0254fee89e5bd /README.md
parent9d102cb910fe9687b94235da04125329cd787054 (diff)
move 'auth' to a modifier
fixes #12
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0c00004..f65ae78 100644
--- a/README.md
+++ b/README.md
@@ -318,6 +318,12 @@ The "autoatom" modifier customizes routing to recognize "<any other valid path>.
Allowed contexts: static, cgi directives (no git), gemini and spartan servers (no gopher or finger).
+### auth <auth name>
+
+The "auth" modifier takes the name of an auth (defined in a global "auth" directive) and sets it as a requirement to access the modified route. All the supported auth mechanisms are based on client TLS certificates, so they only work in servers with a "servertls" directive.
+
+Allowed contexts: static, cgi, git directives, gemini, gopher, and finger servers (no spartan, and gopher or finger only with "servertls").
+
### titan <auth name>
The "titan" modifier takes an auth name (defined in a global "auth" directive) and enables the titan file upload protocol in a static route. Titan requests specifically will have to pass the named auth mechanism.