From a1cf6c31d17a537d7deb300da6eae56a32587f62 Mon Sep 17 00:00:00 2001 From: cbdev Date: Tue, 15 Aug 2023 00:13:58 +0200 Subject: Document authentication methods --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6fb8a53..f30d904 100644 --- a/README.md +++ b/README.md @@ -61,4 +61,13 @@ Other httpds may provide a similar mechanism, which will need to be called out t ## Authentication -TBD +This projects provides multiple methods to identify and authenticate users, including delegating authentication to external software. +Implementing custom authentication methods is possible and patches contributing such are welcome. + +The following authentication methods are currently available: + +* *NoneAuth*: The default. Does not support any logins. Use this if you want to manage cargohold exclusively via the command line or direct database interfaces +* *ExternalAuth*: Delegate authentication to an external entity. Expects the authenticated user (if any) in the REMOTE_USER environment variable +* *LocalBasicAuth*: Internal implementation of HTTP Basic Auth using htpasswd-style user databases +* *RemoteCookieAuth*: Custom authentication scheme validating a domain-wide cookie against an external service +* -- cgit v1.2.3