You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2010/10/11 19:53:19 UTC

svn commit: r1021444 - in /directory/apacheds-manuals/trunk/src/basic-user-guide: book.xml chapter-configuring-apacheds.xml

Author: elecharny
Date: Mon Oct 11 17:53:18 2010
New Revision: 1021444

URL: http://svn.apache.org/viewvc?rev=1021444&view=rev
Log:
Added a chapter about configuration (to be completed)

Added:
    directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml
Modified:
    directory/apacheds-manuals/trunk/src/basic-user-guide/book.xml

Modified: directory/apacheds-manuals/trunk/src/basic-user-guide/book.xml
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/book.xml?rev=1021444&r1=1021443&r2=1021444&view=diff
==============================================================================
--- directory/apacheds-manuals/trunk/src/basic-user-guide/book.xml (original)
+++ directory/apacheds-manuals/trunk/src/basic-user-guide/book.xml Mon Oct 11 17:53:18 2010
@@ -73,6 +73,8 @@ under the License.</literallayout>
 
   <xi:include href="chapter-integrating-apacheds.xml" />
 
+  <xi:include href="chapter-configuring-apacheds.xml" />
+
   <index> ... </index>
 
 </book>

Added: directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml?rev=1021444&view=auto
==============================================================================
--- directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml (added)
+++ directory/apacheds-manuals/trunk/src/basic-user-guide/chapter-configuring-apacheds.xml Mon Oct 11 17:53:18 2010
@@ -0,0 +1,163 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file 
+  distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under 
+  the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may 
+  obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to 
+  in writing, software distributed under the License is distributed on an "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. -->
+<chapter
+  version="5.0"
+  xmlns="http://docbook.org/ns/docbook"
+  xmlns:xlink="http://www.w3.org/1999/xlink"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xmlns:ns5="http://www.w3.org/2000/svg"
+  xmlns:ns4="http://www.w3.org/1998/Math/MathML"
+  xmlns:ns3="http://www.w3.org/1999/xhtml"
+  xml:lang="en">
+  <title>Apache Directory Server Configuration</title>
+  <section
+    id="Introduction">
+    <title>Introduction</title>
+    <para>This section describes all the configuration options available for the Apache Directory Server.
+    It covers the Ldap server, but also the Kerberos server and all the other servers built on top of
+    a DirectorySevice</para>
+    <itemizedlist>
+      <listitem>
+        <para>
+          <xref
+            linkend="DirectoryService configuration" />
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <xref
+            linkend="Transports configuration" />
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <xref
+            linkend="Ldap Server configuration" />
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <xref
+            linkend="Kerberos Server configuration" />
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <xref
+            linkend="Ntp Server configuration" />
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <xref
+            linkend="Dns Server configuration" />
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <xref
+            linkend="HTTP Server configuration" />
+        </para>
+      </listitem>
+    </itemizedlist>
+    <section
+      id="DirectoryService configuration">
+      <title>DirectoryService configuration</title>
+      <para>
+        The <emphasis role="bold">DirectoryService</emphasis> component is the base for every server
+        requiring some data to be stored in a backend. It also defines the way the LdapServer will
+        process incoming requests. The following components are configurable :
+      </para>
+      <itemizedlist>
+        <listitem>
+          <para>
+            <xref
+              linkend="Interceptors configuration" />
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <xref
+              linkend="PasswordPolicy configuration" />
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <xref
+              linkend="Partitions configuration" />
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <xref
+              linkend="ChangeLog configuration" />
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <xref
+              linkend="Journal configuration" />
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <xref
+              linkend="Test entries configuration" />
+          </para>
+        </listitem>
+      </itemizedlist>
+      <para>All of those elements will be described in the following sections.</para>
+      <para>Some parameters are directly associated with the <emphasis role="bold">DirectoryService</emphasis> :</para>
+      <itemizedlist>
+        <listitem>
+          <para><emphasis role="bold">instanceId</emphasis><subscript>(String)</subscript> : <emphasis>The instance unique ID.</emphasis></para>
+        </listitem>
+        <listitem>
+          <para><emphasis role="bold">replicaId</emphasis><subscript>([0..999], 0)</subscript> : <emphasis>The replica unique ID.</emphasis></para>
+        </listitem>
+        <listitem>
+          <para><emphasis role="bold">systemPartition</emphasis><subscript>(<xref linked="Partition">partition</xref>)</subscript> : <emphasis>The dedicated System partition</emphasis></para>
+        </listitem>
+        <listitem>
+          <para><emphasis role="bold">accessControlEnabled</emphasis><subscript>(boolean, true)</subscript> : <emphasis>Tells if the ACI subsystem is enabled or not.</emphasis></para>
+        </listitem>
+        <listitem>
+          <para><emphasis role="bold">allowAnonymousAccess</emphasis><subscript>(boolean, false)</subscript> : <emphasis>Tells if the user is allowed to send request anonymously.</emphasis></para>
+        </listitem>
+        <listitem>
+          <para><emphasis role="bold">denormalizeOpAttrsEnabled</emphasis><subscript>(boolean, true)</subscript> : <emphasis>Tells if the DN returned by the server are denormalized or not.</emphasis></para>
+        </listitem>
+        <listitem>
+          <para><emphasis role="bold">maxPdu</emphasis><subscript>(Integer, 2Mb)</subscript> : <emphasis>Defines the maximum size a PDU of an incoming request can be (the PDU is 
+          the encoded bytes representing the request).</emphasis></para>
+        </listitem>
+        <listitem>
+          <para><emphasis role="bold">passwordHidden</emphasis><subscript>(boolean, true)</subscript> : <emphasis>Tells if the password is hidden or not.</emphasis></para>
+        </listitem>
+        <listitem>
+          <para><emphasis role="bold">syncPeriodMillis</emphasis><subscript>(Integer, 15000)</subscript> : <emphasis>Defines the delay between each flush to disk. No data will be
+          written to disk during this perido. If one wants everything to be written immediately, then this value
+          must be set to 0.</emphasis></para>
+        </listitem>
+      </itemizedlist>
+      <section id="Interceptors configuration">
+      </section>
+      <section id="PasswordPolicy configuration">
+      </section>
+      <section id="Partitions configuration">
+      </section>
+      <section id="ChangeLog configuration">
+      </section>
+      <section id="Journal configuration">
+      </section>
+      <section id="Test entries configuration">
+      </section>
+    </section>
+  </section>
+</chapter>