You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by ma...@apache.org on 2019/07/09 12:43:02 UTC
[james-project] 06/08: JAMES-2822 Document usersrepository.xml
options
This is an automated email from the ASF dual-hosted git repository.
matthieu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 48d214215c7584a031af95f811cf6d4302b741c3
Author: Gautier DI FOLCO <gd...@linagora.com>
AuthorDate: Mon Jul 8 13:30:10 2019 +0200
JAMES-2822 Document usersrepository.xml options
---
src/site/xdoc/server/config-users.xml | 41 +++++++++++++++++++++++------------
1 file changed, 27 insertions(+), 14 deletions(-)
diff --git a/src/site/xdoc/server/config-users.xml b/src/site/xdoc/server/config-users.xml
index 198ad80..3056ba4 100644
--- a/src/site/xdoc/server/config-users.xml
+++ b/src/site/xdoc/server/config-users.xml
@@ -15,7 +15,7 @@
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
- under the License.
+ under the License.
-->
<document>
@@ -26,19 +26,32 @@
<body>
<section name="Users Repositories">
-
+
<subsection name="Introduction">
-
+
<p>User repositories are required to store James user information and authentication data</p>
-
+
<p>Consult <a href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/usersrepository.xml">usersrepository.xml</a> in GIT to get some examples and hints.</p>
-
+
+ </subsection>
+
+ <subsection name="General configuration">
+
+ <p>All Users Repositories provide at least these two options</p>
+
+ <dl>
+ <dt><strong>enableVirtualHosting</strong></dt>
+ <dd>true or false. Add domain support for users (default: false, except for Cassandra Users Repository)</dd>
+ <dt><strong>administratorId</strong></dt>
+ <dd>user's name. Allow an user to access to the <a href="https://tools.ietf.org/html/rfc4616#section-2">impersonation command</a>, acting on the behalf of any user.</dd>
+ </dl>
+
</subsection>
-
+
<subsection name="JPA Users Repository">
-
+
<p>JPA (database via OpenJPA) based user repository. This is the default implementation.</p>
-
+
<p>The usersrepository tag as 2 attributes: name="LocalUsers" and class="org.apache.james.user.file.UsersFileRepository">
The class tag should be specified for Spring, but is not taken into acount by Guice.</p>
@@ -54,12 +67,12 @@
</subsection>
<subsection name="File Users Repository">
-
+
<p>The File UsersRepository implementations below are DEPRECATED and will get removed in the next release</p>
<p>It just listed here for backward-compatibility</p>
<p>File-based user repositories Use these configurations to store user info in the filesystem.</p>
-
+
<p>The usersrepository tag as 2 attributes:name="LocalUsers" class="org.apache.james.user.file.UsersFileRepository"></p>
<dl>
@@ -78,20 +91,20 @@
</subsection>
<subsection name="JDBC Users Repository">
-
+
<p>The JDBC UsersRepository implementations below are DEPRECATED and will get removed in the next release.</p>
<p>It just listed here for backward-compatibility.</p>
</subsection>
<subsection name="LDAP Users Repository">
-
+
<p>Read-Only LDAP based UsersRepository</p>
-
+
<p>Example:</p>
<source>
-<repository name="LocalUsers" class="org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository" ldapHost="ldap://myldapserver:389"
+<repository name="LocalUsers" class="org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository" ldapHost="ldap://myldapserver:389"
principal="uid=ldapUser,ou=system" credentials="password" userBase="ou=People,o=myorg.com,ou=system" userIdAttribute="uid"/></source>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org