diff options
| author | Matthew Holt <mholt@users.noreply.github.com> | 2019-12-23 12:45:35 -0700 |
|---|---|---|
| committer | Matthew Holt <mholt@users.noreply.github.com> | 2019-12-23 12:45:35 -0700 |
| commit | 95ed603de79c66ff76bfe7e42986a2fc8c7a1fa4 (patch) | |
| tree | 1a788b8eba98f0c2e69e5816bac9c7cc09aca96f /modules/caddyhttp/caddyauth/caddyauth.go | |
| parent | cbb405f6aaee046c9de9ffb4f07ca824d9eedeb1 (diff) | |
Improve godocs all around
These will be used in the new automated documentation system
Diffstat (limited to 'modules/caddyhttp/caddyauth/caddyauth.go')
| -rw-r--r-- | modules/caddyhttp/caddyauth/caddyauth.go | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/modules/caddyhttp/caddyauth/caddyauth.go b/modules/caddyhttp/caddyauth/caddyauth.go index c814caf..aefeec5 100644 --- a/modules/caddyhttp/caddyauth/caddyauth.go +++ b/modules/caddyhttp/caddyauth/caddyauth.go @@ -28,7 +28,10 @@ func init() { } // Authentication is a middleware which provides user authentication. +// Rejects requests with HTTP 401 if the request is not authenticated. type Authentication struct { + // A set of authentication providers. If none are specified, + // all requests will always be unauthenticated. ProvidersRaw caddy.ModuleMap `json:"providers,omitempty" caddy:"namespace=http.authentication.providers"` Providers map[string]Authenticator `json:"-"` |