aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcbdev <cb@cbcdn.com>2023-08-15 00:13:58 +0200
committercbdev <cb@cbcdn.com>2023-08-15 00:13:58 +0200
commita1cf6c31d17a537d7deb300da6eae56a32587f62 (patch)
treee0665ef7ec9b09d42c5027459c40c24053233577
parent0c3ab4200dbb58038ac2ec4a4cdd78729a7e21b3 (diff)
downloadcargohold-a1cf6c31d17a537d7deb300da6eae56a32587f62.tar.gz
cargohold-a1cf6c31d17a537d7deb300da6eae56a32587f62.tar.bz2
cargohold-a1cf6c31d17a537d7deb300da6eae56a32587f62.zip
Document authentication methods
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
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
+*