Cutlery/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-10-31 02:27:19 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Mention {http.auth.user.id} placeholder in basicauth JSON docs (#3886)

Browse Source
This commit is contained in:
Francis Lavoie 2020-11-26 22:31:25 -05:00 committed by GitHub
parent 7d7434c9ce
commit 4afcdc49d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
modules/caddyhttp/caddyauth/caddyauth.go
View File

@ -30,6 +30,11 @@ func init() {
// Authentication is a middleware which provides user authentication. // Authentication is a middleware which provides user authentication.
// Rejects requests with HTTP 401 if the request is not authenticated. // Rejects requests with HTTP 401 if the request is not authenticated.
// //
// After a successful authentication, the placeholder
// `{http.auth.user.id}` will be set to the username, and also
// `{http.auth.user.*}` placeholders may be set for any authentication
// modules that provide user metadata.
//
// Its API is still experimental and may be subject to change. // Its API is still experimental and may be subject to change.
type Authentication struct { type Authentication struct {
// A set of authentication providers. If none are specified, // A set of authentication providers. If none are specified,