vh/rest-server
1
0
Fork 0
mirror of https://github.com/restic/rest-server.git synced 2025-12-06 17:15:45 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

document proxy auth in readme

Browse Source
This commit is contained in:
Michael Eischer
2025-02-17 22:32:49 +01:00
parent b0a9a0452e
commit 0dfc772cdb
2 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -139,6 +139,16 @@ docker exec -it rest_server create_user myuser mypassword
docker exec -it rest_server delete_user myuser docker exec -it rest_server delete_user myuser
``` ```
## Proxy Authentication
See above for no authentication (`--no-auth`) and basic authentication.
To delegate authentication to a proxy, use the `--proxy-auth-username` flag. The specified header name, for example `X-Forwarded-User`,
must be present in the request headers and specifies the username. Basic authentication is disabled when this flag is set.
Warning: rest-server trusts the username in the header. It is the responsibility of the proxy
to ensure that the username is correct and cannot be forged by an attacker.
## Prometheus support and Grafana dashboard ## Prometheus support and Grafana dashboard

4
changelog/unreleased/pull-307
View File

@@ -1,8 +1,8 @@
Enhancement: Add support for proxy-based authentication Enhancement: Add support for proxy-based authentication
The server now supports authentication via a proxy header specified with the --proxy-auth flag (e.g., --proxy-auth=X-Forwarded-User). The server now supports authentication via a proxy header specified with the `--proxy-auth-username` flag (e.g., `--proxy-auth-username=X-Forwarded-User`).
When this flag is set, the server will authenticate users based on the given header and disable BasicAuth. When this flag is set, the server will authenticate users based on the given header and disable BasicAuth.
Note that --proxy-auth is ignored if --no-auth is set, as --no-auth disables all authentication. Note that `--proxy-auth-username` is ignored if `--no-auth` is set, as `--no-auth` disables all authentication.
https://github.com/restic/rest-server/issues/174 https://github.com/restic/rest-server/issues/174
https://github.com/restic/rest-server/pull/307 https://github.com/restic/rest-server/pull/307