From 1f53ec5253c00d7e33092a68bdc37c5a859b4567 Mon Sep 17 00:00:00 2001 From: Martin Date: Thu, 3 Nov 2022 17:00:34 +0100 Subject: [PATCH] Improve Auth Basic service descriptions (#4971) --- services/auth-basic/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/services/auth-basic/README.md b/services/auth-basic/README.md index 87a2bafe3..8ed7f8294 100644 --- a/services/auth-basic/README.md +++ b/services/auth-basic/README.md @@ -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"`