Improve Auth Basic service descriptions (#4971)

This commit is contained in:
Martin
2022-11-03 17:00:34 +01:00
committed by GitHub
parent f994ad951c
commit 1f53ec5253
+4
View File
@@ -1,7 +1,11 @@
# Auth-Basic Service
The oCIS Auth Basic service provides basic authentication for those clients who cannot handle OIDC. This is a rare case, is usually not necessary and mainly used for tests or development.
The `auth-basic` service is responsible for validating authentication of incoming requests. To do so, it will use the configured `auth manager`, see the `Auth Managers` section. Only HTTP basic auth requests to ocis will involve the `auth-basic` service.
To enable `auth-basic`, you first must set `PROXY_ENABLE_BASIC_AUTH` to `true`.
## Auth Managers
Since the `auth-basic` service does not do any validation itself, it needs to be configured with an authentication manager. One can use the `AUTH_BASIC_AUTH_MANAGER` environment variable to configure this. Currently only one auth manager is supported: `"ldap"`