aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index eb59c09..f30d904 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,8 @@ Required dependencies
* uwsgi-plugin-python3
* sqlite3
* python3
+* python3-jinja2
+* python3-passlib if using `LocalBasicAuth`
Basic infrastructure
@@ -59,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
+*