mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-04-24 14:06:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Numerous various updates for v2.1

Browse source
This commit is contained in:
Matthew Holt 2020-06-08 14:56:20 -06:00
parent 148176582d
commit db18a5d4c8
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
9 changed files with 79 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/docs/markdown/caddyfile/directives/basicauth.md
View file

@ -8,7 +8,7 @@ Enables HTTP Basic Authentication, which can be used to protect directories and
**Note that basic auth is not secure over plain HTTP.** Use discretion when deciding what to protect with HTTP Basic Authentication.
When a user requests a resource that is protected, the browser will prompt the user for a username and password if they have not already supplied one. If the proper credentials are present in the Authorization header, the server will grant access to the resource. If the header is missing or the credentials are incorrect, the server will respond with HTTP 401 Unauthorized.
When a user requests a resource that is protected, the browser will prompt the user for a username and password if they have not almdy supplied one. If the proper credentials are present in the Authorization header, the server will grant access to the resource. If the header is missing or the credentials are incorrect, the server will respond with HTTP 401 Unauthorized.
Caddy configuration does not accept plaintext passwords; you MUST hash them before putting them into the configuration. The [`caddy hash-password`](/docs/command-line#caddy-hash-password) command can help with this.
@ -16,13 +16,14 @@ Caddy configuration does not accept plaintext passwords; you MUST hash them befo
## Syntax
```caddy-d
basicauth [<matcher>] [<hash_algorithm>] {
basicauth [<matcher>] [<hash_algorithm> [<realm>]] {
<username> <hashed_password_base64> [<salt_base64>]
...
}
```
- **&lt;hash_algorithm&gt;** is the name of the password hashing algorithm (or KDF) used for the hashes in this configuration. Can be `bcrypt` (default) or `scrypt`.
- **&lt;realm&gt;** is a custom realm name.
- **&lt;username&gt;** is a username or user ID.
- **&lt;hashed_password_base64&gt;** is the base-64 encoding of the hashed password.
- **&lt;salt_base64&gt;** is the base-64 encoding of the password salt, if an external salt is required.