Skip to content

Commit a27e6ac

Browse files
committed
doc: DATABUS_PRIVATE_MODE config
1 parent 2bd5bff commit a27e6ac

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

docs/running-your-own-databus-server/configuration.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@ The Databus container accepts the following environment variables:
2727
* **DATABUS\_OIDC\_ISSUER\_BASE\_URL**: Base URL of your OIDC provider
2828
* **DATABUS\_OIDC\_CLIENT\_ID**: Client Id of your OIDC client
2929
* **DATABUS\_OIDC\_SECRET**: Client Secret of your OIDC client
30-
* **DATABUS_PRIVATE_MODE**: Default is *false*. If set to *true* this will return an HTTP status code of **401** when trying to access the Databus without authentication.
30+
* **DATABUS\_PRIVATE\_MODE**: Default is *false*. If set to *true* this will return an HTTP status code of **401** when trying to access the Databus without authentication.
31+
* When set to *true*, the Databus will only allow access to users that have the required OIDC role. Therefore you need to configure additionally:
32+
* **DATABUS\_OIDC\_REQUIRED\_ROLE**: The required role of your OIDC provider that is needed to access the Databus. The role needs to be configured in your OIDC provider and assigned to the users that should have access to the Databus
33+
* **DATABUS\_OIDC\_RESPONSE\_TYPE=code**: The response type of the OIDC provider. Default is *code*. Change this only if you know what you are doing.
3134

3235
The volumes of the Databus container are best left unchanged. The internal path of the volumes should not be altered. The ourside paths may be changed to any desired path. The keypair folder will store the private and public key of your Databus deployment. The users folder will hold a mini-database associating your OIDC users with Databus users.
3336

0 commit comments

Comments
 (0)