blob: d3ae6ef3bf114708993f8c76145aa728148be534 [file] [log] [blame]
Jan Willem Janssenc1022ac2012-11-30 12:35:37 +00001Apache Felix UserAdmin MongoDB-based store
2Copyright 2012 The Apache Software Foundation
3
4This project provides a MongoDB-based store for use with the Felix UserAdmin
5service. It uses MongoDB to persist the role information.
6
7The MongoDB-based store service this bundle provides can be configured at
8runtime by using the service PID "org.apache.felix.useradmin.mongodb". The
9configuration options recognized by this service are:
10
11"server"
12 A space separated string containing the MongoDB servers. The format for
13 this string is: "<host1:port1> <host2:port2>". This value is optional and
14 defaults to "localhost:27017";
15"dbname"
16 A string value containing the name of the database to use for this store.
17 This value is optional and defaults to "ua_repo";
18"collection"
19 The name of the database collection to use for this store. This value is
20 optional and defaults to "useradmin";
21"username"
22 A string value representing the name of the user to authenticate against
23 MongoDB. This value is optional and defaults to "" (empty string);
24"password"
25 A string value representing the password to authenticate against MongoDB.
26 This value is optional and defaults to "" (empty string).
27
28Alternatively, one can also supply the above mentioned configuration keys
29prefixed with "org.apache.felix.useradmin.mongodb." as system properties. For
30example by adding the following to your JVM arguments:
31
32 -Dorg.apache.felix.useradmin.mongodb.server=my.mongo.server:27017
33
34will let this service use the MongoDB server at "my.mongo.server".
35
36However, using system properties will imply that only a single store can be
37configured on a system (which could be a sensible default for some
38situations)!