Fast and extensible multi-platform HTTP/1-2-3 web server with automatic HTTPS
Mirrored from https://github.com/Slazee/caddy.git
Synced Nov 14, 05:15 UTC
docs: Mention {http.auth.user.id} placeholder in basicauth JSON docs (#3886)
Francis Lavoie committed
Nov 26, 2020 at 22:31 UTC
4afcdc49d14855c0c3a4fd4558d0f81906db3ffb
1 file changed
+5
modules/caddyhttp/caddyauth/caddyauth.go
+5
@@ -30,6 +30,11 @@ func init() {
30
// Authentication is a middleware which provides user authentication.
31
// Rejects requests with HTTP 401 if the request is not authenticated.
32
//
33
+// After a successful authentication, the placeholder
34
+// `{http.auth.user.id}` will be set to the username, and also
35
+// `{http.auth.user.*}` placeholders may be set for any authentication
36
+// modules that provide user metadata.
37
+//
38
// Its API is still experimental and may be subject to change.
39
type Authentication struct {
40
// A set of authentication providers. If none are specified,