From 345bea50b68695fabb2049736b99a207f182ae14 Mon Sep 17 00:00:00 2001 From: Carsten Saathoff Date: Mon, 12 Oct 2015 13:04:48 +0200 Subject: [PATCH] Added documentation about the mongodb:// URI based configuration and how to use a MongoDB replica set. --- .../en/en-US/modules/server-installation.xml | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docbook/auth-server-docs/reference/en/en-US/modules/server-installation.xml b/docbook/auth-server-docs/reference/en/en-US/modules/server-installation.xml index c702020844..2f7a23a139 100755 --- a/docbook/auth-server-docs/reference/en/en-US/modules/server-installation.xml +++ b/docbook/auth-server-docs/reference/en/en-US/modules/server-installation.xml @@ -329,6 +329,30 @@ Supported long option is maxAutoConnectRetryTime. See Mongo documentation for details about those options and their default values. + + Alternatively, you can configure MongoDB using a MongoDB connection URI. + In this case, you define all information concerning the connection and authentication within the URI, as described in the MongoDB documentation. + Please note that the database specified within the URI is only used for authentication. To change the database used by keycloak you have to set + db property as before. Therefore, a configuration like the + following + + will authenticate the user against the authentication database, but store all keycloak related data in the keycloak database. + + +
+ MongoDB Replica Sets + + In order to use a mongo replica set for Keycloak, one has to use URI based configuration, which supports the + definition of replica sets out of the box: mongodb://host1:27017,host2:27017,host3:27017/. + +