Skip to content

Commit d2ee4d5

Browse files
committed
docs: add basic auth security notes
1 parent 7d2d112 commit d2ee4d5

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

docs/configuration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424
| BASIC_AUTH | `--basic-auth <username:password>` | Enable Basic Auth (username:password) | (empty) |
2525
| BASIC_AUTH_REALM | `--basic-auth-realm <string>` | Basic Auth realm name | `Restricted` |
2626

27+
## Security Note
28+
29+
When Basic Auth is enabled, always run behind HTTPS (or a TLS-terminating reverse proxy). Basic Auth over plain HTTP exposes credentials.
30+
2731
## Examples
2832

2933
Enable Brotli:

docs/deployment.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ services:
3434
- Use `--port` if you run the container on a non-default port.
3535
- Enable compression (`--brotli` or `--gzip`) when serving large static bundles.
3636
- For fixed asset paths (for example, a service worker), use `--ignore-cache-control-paths` to avoid CDN caching issues.
37+
- Add rate limiting at the reverse proxy (Traefik, Nginx, Cloudflare) to mitigate brute-force attempts.
3738

3839
## See Also
3940

0 commit comments

Comments
 (0)