directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r844202 - in /websites/staging/directory/trunk/content: ./ apacheds/advanced-ug/2-server-config.html
Date Sat, 29 Dec 2012 05:39:27 GMT
Author: buildbot
Date: Sat Dec 29 05:39:27 2012
New Revision: 844202

Log:
Staging update by buildbot for directory

Modified:
    websites/staging/directory/trunk/content/   (props changed)
    websites/staging/directory/trunk/content/apacheds/advanced-ug/2-server-config.html

Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sat Dec 29 05:39:27 2012
@@ -1 +1 @@
-1426588
+1426709

Modified: websites/staging/directory/trunk/content/apacheds/advanced-ug/2-server-config.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/advanced-ug/2-server-config.html (original)
+++ websites/staging/directory/trunk/content/apacheds/advanced-ug/2-server-config.html Sat
Dec 29 05:39:27 2012
@@ -129,59 +129,67 @@
 <h1 id="2-server-configuraion">2 - Server Configuraion</h1>
 <p>We will now describe the server configuration. Usually, all the configuration is
done using Apache Directory Studio, which offers a pretty GUI. One can also configure the
server using LDAP request, as the configuration is stored in teh <strong>DIT</strong>.
Otherwise, all the configuration modifications won't be applied on a started server : usually,
you will have to restart the server in order to get those modifications applied.</p>
 <p>It's a good policy not to modify the LDIF files by hand, but instead to use the
Studio Configuration plugin to modify your configuration. </p>
-<h2 id="overall-structure">Overall structure</h2>
+<h1 id="overall-structure">Overall structure</h1>
 <p>The configuration is stored in a hierarchical order, where sub-elements are related
to their parent. For instance, the <em>Transports</em> are associated to the <em>Server</em>
they are child of. If we have many kind of servers, we will have as many transports as we
have servers.</p>
 <p>The following hierarchy describe the different kind of elements that one can configure,
and their relationship :</p>
 <ul>
-<li><a href="#directory-service">Directory Service</a><ul>
-<li><a href="#change-log">ChangeLog</a></li>
-<li><a href="#journal">Journal</a></li>
-<li><a href="#interceptors">Interceptors</a><ul>
-<li><a href="#authentication-Interceptor">Authentication Interceptor</a><ul>
-<li><a href="#authenticators">Authenticators</a></li>
-<li><a href="#password-policies">Password Policies</a></li>
+<li>ou=config<ul>
+<li><a href="#directory-service">ads-directoryServiceId=XXXXX (Directory Service)</a>
<ul>
+<li><a href="#change-log">ads-changeLogId=XXXXX (ChangeLog)</a></li>
+<li><a href="#journal">ads-journalId=XXXXX (Journal)</a></li>
+<li><a href="#interceptors">ou=interceptors (Interceptors)</a><ul>
+<li><a href="#authentication-Interceptor">ads-interceptorId=authenticationInterceptor
(Authentication Interceptor)</a><ul>
+<li><a href="#authenticators">ou=authenticators (Authenticators)</a></li>
+<li><a href="#password-policies">ou=passwordPolicies (Password Policies)</a></li>
 </ul>
 </li>
 </ul>
 </li>
-<li><a href="#partitions">Partitions</a><ul>
-<li><a href="#indexes">Indexes</a><ul>
-<li><a href="#indexed-attribute">Indexed Attribute</a></li>
+<li><a href="#partitions">ou=partitions (Partitions)</a><ul>
+<li><a href="#jdbm-partition">ads-partitionId=system (JDBM Partition)</a><ul>
+<li><a href="#indexes">ou=indexes (Indexes)</a><ul>
+<li><a href="#indexed-attribute">ads-indexAttributeId=XXXXX (Indexed Attribute)</a></li>
 </ul>
 </li>
 </ul>
 </li>
-<li><a href="#servers">Servers</a><ul>
-<li><a href="#ldap-server">Ldap Server</a><ul>
-<li><a href="#transports">Transports</a></li>
-<li><a href="#repl-consumers">ReplConsumers</a></li>
-<li><a href="#extended-op-handlers">Extended Operation Handlers</a></li>
-<li><a href="#sasl-mechanisms">SASL Mechanisms</a></li>
 </ul>
 </li>
-<li><a href="#kerberos-server">Kerberos Server</a><ul>
-<li><a href="#transports">Transports</a></li>
+<li><a href="#servers">ou=servers (Servers)</a><ul>
+<li><a href="#ldap-server">ads-serverId=ldapServer (Ldap Server)</a><ul>
+<li><a href="#transports">ou=transports (Transports)</a></li>
+<li><a href="#repl-consumers">ou=replConsumers (ReplConsumers)</a></li>
+<li><a href="#extended-op-handlers">ou=extendedOpHandlers (Extended Operation
Handlers)</a></li>
+<li><a href="#sasl-mechanisms">ou=saslMechHandlers (SASL Mechanisms)</a></li>
 </ul>
 </li>
-<li><a href="#http-server">Http Server</a><ul>
-<li><a href="#transports">Transports</a></li>
-<li><a href="#http-web-apps">HttpWebApps</a></li>
+<li><a href="#kerberos-server">ads-serverId=kerberosServer (Kerberos Server)</a><ul>
+<li><a href="#transports">ou=transports (Transports)</a></li>
 </ul>
 </li>
-<li><a href="#change-password-server">ChangePassword Server</a><ul>
-<li><a href="#transports">Transports</a></li>
+<li><a href="#http-server">ads-serverId=httpServer (Http Server)</a><ul>
+<li><a href="#transports">ou=transports (Transports)</a></li>
+<li><a href="#http-web-apps">ou=httpWebApps (HttpWebApps)</a></li>
 </ul>
 </li>
+<li><a href="#change-password-server">ads-serverId=changePasswordServer (ChangePassword
Server)</a><ul>
+<li><a href="#transports">ou=transports (Transports)</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
+</li>
+</ul>
+</li>
+</ul>
+<p>Note that in order to modify one element, you have to go down the tree up to the
entry containing the elements you want to modify. For instance, to modify the TCP port for
LDAP, you have to modify the following entry :
+<strong>ads-transportid=ldap, ou=transports, ads-serverId=ldapServer, ou=servers, ads-directoryServiceId=XXXXX,
ou=config</strong></p>
 <p>We will now explain each one of those elements.</p>
-<h3 id="directory-service">Directory Service</h3>
 <p><DIV class="note" markdown="1">
-Note that bold attributes are mandatory
+Note that bold attributes are mandatory in the following tables.
 </DIV></p>
+<h1 id="directory-service">Directory Service</h1>
 <p>This is the key of the whole server : the place where we store the data. Most of
the servers are depending on this component. You maye have more than one server, but only
one <em>DirectoryService</em>. This compoent itself refers to the servers that
will be started, plus the backends it will depends on.</p>
 <p>Here are the configuration parameters for this components :</p>
 <table>
@@ -256,7 +264,7 @@ Note that bold attributes are mandatory
 </tr>
 </tbody>
 </table>
-<h3 id="change-log">Change Log</h3>
+<h2 id="change-log">Change Log</h2>
 <p>The <em>ChangeLog</em> is an optional system that logs every changes
made on the server, and also records the revert operation, allowing the system to rollback
the changes if needed. This is extremely useful when running tests.</p>
 <p>Note that at the moment, the system works in memory.</p>
 <p>It's disabled by default.</p>
@@ -297,7 +305,7 @@ Note that bold attributes are mandatory
 </tr>
 </tbody>
 </table>
-<h3 id="journal">Journal</h3>
+<h2 id="journal">Journal</h2>
 <p>The <em>Journal</em> system logs every modification on the file system.
It's intended to be used if the <em>DirectoryService</em> crashes, as we can reapply
the journal starting from a date in the past where we know that the underlying database is
correct.</p>
 <p>The configuration elements for the <em>Journal</em> are :</p>
 <table>
@@ -348,7 +356,7 @@ Note that bold attributes are mandatory
 </tr>
 </tbody>
 </table>
-<h3 id="interceptors">Interceptors</h3>
+<h2 id="interceptors">Interceptors</h2>
 <p>The <em>Interceptors</em> are generally not configurable. You don't
want to change their order, nor remove or add some. The fact that they appear in the configuration
is because we use this to initialize the server.</p>
 <p>However, at least one <em>Interceptor</em> can be confiured : the <em>authenticationInterceptor</em>.
</p>
 <p>In the case where one would like to add an interceptor, it's enough to add the associated
entry containing the interceptor identifier, under the <em>ou=interceptors</em>
entry. It must have an order. Here are the elements taht can be configured in such a case
:</p>
@@ -396,7 +404,7 @@ Note that bold attributes are mandatory
 </table>
 <h3 id="authentication-interceptor">Authentication Interceptor</h3>
 <p>This <em>Interceptor</em> is in charge of managing the users authentication.
It is associated with <em><a href="#authenticators">Authenticators</a></em>,
and with <em><a href="#password-policies">Password Policies</a></em>.</p>
-<h3 id="authenticators">Authenticators</h3>
+<h4 id="authenticators">Authenticators</h4>
 <p>We may have various <em>Authenticator</em> declared for a given server.
The default server has three different <em>Authenticators</em>, which are :</p>
 <ul>
 <li>anonymousAuthenticator : used for anonymous requests</li>
@@ -586,9 +594,11 @@ Note that bold attributes are mandatory
 </tr>
 </tbody>
 </table>
-<h3 id="partitions">Partitions</h3>
+<h2 id="partitions">Partitions</h2>
 <p>The <em>Partition</em> is the part of the server storing your data.
There are many parts that need to be configured in order to obtain the best performances out
of the server. It's also the part of the configuraton you are the more likely to modify, adding
new <em>Partitions</em> or adding new <em>Indexes</em>.</p>
-<p>A <em>Partition</em> have the following configurable elements :</p>
+<p>You may have more than one <em>Partition</em> in your <em>DirectoryService</em>.
We have at least three existing <em>Partition</em>, the <em>ou=system</em>
<em>Partition</em>, the <em>ou=config</em> <em>Partition</em>
and the <em>ou=schema</em> <em>Partition</em>. The former is a <em>JDBM</em>
<em>Partition</em>, when the two others are <em>LDIF</em> _Partitions.</p>
+<h3 id="jdbm-partition">JDBM Partition</h3>
+<p>A <em>JDBM Partition</em> have the following configurable elements :</p>
 <table>
 <thead>
 <tr>
@@ -638,7 +648,7 @@ Note that bold attributes are mandatory
 </tbody>
 </table>
 <p>Once those elements have been configured, the <em>Partition</em> is
available. You still have to create some mandatory indexes though.</p>
-<h3 id="indexes">Indexes</h3>
+<h4 id="indexes">Indexes</h4>
 <p>Each <em>Partition</em> have indexes, some are mandatory, and others
are user provided. Here are the mandatory indexes :</p>
 <table>
 <thead>
@@ -682,7 +692,7 @@ Note that bold attributes are mandatory
 </tr>
 </tbody>
 </table>
-<h3 id="indexed-attribute">Indexed Attribute</h3>
+<h5 id="indexed-attribute">Indexed Attribute</h5>
 <p>IndexedATtributes have a type, depending on the <em>Partition</em> they
are associetd with. Currently, we have only one type, <em>JdbmIndex</em>. They
have specific configurable elements.</p>
 <p>Each index attribute have four basic elements that can be configured :</p>
 <table>
@@ -758,7 +768,7 @@ Note that bold attributes are mandatory
 </tr>
 </tbody>
 </table>
-<h3 id="servers">Servers</h3>
+<h1 id="servers">Servers</h1>
 <p>As we can see, we can start more than one server. We have :</p>
 <ul>
 <li>a LDAP server</li>
@@ -808,7 +818,69 @@ Note that bold attributes are mandatory
 </tbody>
 </table>
 <p>A server can define more than one transports : for instance, the Kerberos server
uses UDP and TCP transports.</p>
-<h3 id="ldap-server">Ldap Server</h3>
+<h2 id="transports">Transports</h2>
+<p>Here are the parameters for the Transport structure :</p>
+<table>
+<thead>
+<tr>
+<th>AttributeType</th>
+<th>type</th>
+<th>default value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><strong>ads-transportId</strong></td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The identification</td>
+</tr>
+<tr>
+<td><strong>ads-transportAddress</strong></td>
+<td><em>String</em></td>
+<td>localhost</td>
+<td>The IP Address</td>
+</tr>
+<tr>
+<td><strong>ads-systemPort</strong></td>
+<td><em>int</em></td>
+<td>-1</td>
+<td>The port</td>
+</tr>
+<tr>
+<td>ads-enabled</td>
+<td><em>boolean</em></td>
+<td>N/A</td>
+<td>Tells if the Transport system is enabled</td>
+</tr>
+<tr>
+<td>description</td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>A short optional description</td>
+</tr>
+<tr>
+<td>ads-transportEnableSsl</td>
+<td><em>boolean</em></td>
+<td>false</td>
+<td>Tells if SSL is activated (not used for UDP)</td>
+</tr>
+<tr>
+<td>ads-transportNbThreads</td>
+<td><em>int</em></td>
+<td>3</td>
+<td>he number of dedicated threads to process the messages</td>
+</tr>
+<tr>
+<td>ads-transportBackLog</td>
+<td><em>int</em></td>
+<td>50</td>
+<td>The number of messages on hold if the server is overloaded (not used for UDP)</td>
+</tr>
+</tbody>
+</table>
+<h2 id="ldap-server">Ldap Server</h2>
 <p>Let's start with the main server : the LDAP server. </p>
 <p>The list of attributes that can be modified is exposed in the following table. </p>
 <table>
@@ -1130,7 +1202,7 @@ Note that bold attributes are mandatory
 </tr>
 </tbody>
 </table>
-<h3 id="kerberos-server">Kerberos Server</h3>
+<h2 id="kerberos-server">Kerberos Server</h2>
 <p>The <em>KerberosServer</em> configuration is an important part of the
configuration. It deoends on a <em>DirectoryService</em> too, as most of the informations
managed by a <em>KerberosServer</em> are store there.</p>
 <p>The list of attributes that can be modified is exposed in the following table. </p>
 <table>
@@ -1235,15 +1307,10 @@ Note that bold attributes are mandatory
 </tr>
 </tbody>
 </table>
-<p>Of course, a <em>Transport</em> has to be defined under the <em>KerberosServer</em>
entry (see <a href="[">Transports</a>#transports)).</p>
-<h3 id="http-server">Http Server</h3>
-<p>To be added...</p>
-<h3 id="http-web-apps">Http Web Apps</h3>
-<p>To be added...</p>
-<h3 id="change-password-server">Change Password Server</h3>
-<p>To be added...</p>
-<h3 id="transports">Transports</h3>
-<p>Here are the parameters for the Transport structure :</p>
+<p>Of course, a <em>Transport</em> has to be defined under the <em>KerberosServer</em>
entry (see <a href="#transports">Transports</a>).</p>
+<h2 id="http-server">Http Server</h2>
+<p>We have a Http Server embedded, which is used to manage some parts of the server.
One can inject a web application, which has direct access to the embedded LdapServer, for
instance. It can be useful for sending LDAP requests using DSML, for instance.</p>
+<p>There is one single element that can be configured :</p>
 <table>
 <thead>
 <tr>
@@ -1255,28 +1322,43 @@ Note that bold attributes are mandatory
 </thead>
 <tbody>
 <tr>
-<td><strong>ads-transportId</strong></td>
+<td>ads-enabled</td>
+<td><em>boolean</em></td>
+<td>true</td>
+<td>Tells if the HttpServer is enabled</td>
+</tr>
+<tr>
+<td>description</td>
 <td><em>String</em></td>
 <td>N/A</td>
-<td>The identification</td>
+<td>A short optional description</td>
 </tr>
 <tr>
-<td><strong>ads-transportAddress</strong></td>
+<td>ads-httpConfFile</td>
 <td><em>String</em></td>
-<td>localhost</td>
-<td>The IP Address</td>
+<td>N/A</td>
+<td>The configuration file for this server</td>
 </tr>
+</tbody>
+</table>
+<p>An <em>HttpServer</em> without webApps is pretty useless, we now have
to configure the underlaying web applications</p>
+<h3 id="http-web-apps">Http Web Apps</h3>
+<p>Each <em>WebApp</em> configuration must be added under the <em>ou=webapps</em>
entry. Here are the configurable elements :</p>
+<table>
+<thead>
 <tr>
-<td><strong>ads-systemPort</strong></td>
-<td><em>int</em></td>
-<td>-1</td>
-<td>The port</td>
+<th>AttributeType</th>
+<th>type</th>
+<th>default value</th>
+<th>Description</th>
 </tr>
+</thead>
+<tbody>
 <tr>
 <td>ads-enabled</td>
 <td><em>boolean</em></td>
-<td>N/A</td>
-<td>Tells if the Transport system is enabled</td>
+<td>true</td>
+<td>Tells if the HttpServer is enabled</td>
 </tr>
 <tr>
 <td>description</td>
@@ -1285,25 +1367,38 @@ Note that bold attributes are mandatory
 <td>A short optional description</td>
 </tr>
 <tr>
-<td>ads-transportEnableSsl</td>
-<td><em>boolean</em></td>
-<td>false</td>
-<td>Tells if SSL is activated (not used for UDP)</td>
+<td><strong>ads-httpWarFile</strong></td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The WAR file to use</td>
 </tr>
 <tr>
-<td>ads-transportNbThreads</td>
-<td><em>int</em></td>
-<td>3</td>
-<td>he number of dedicated threads to process the messages</td>
+<td><strong>ads-id</strong></td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The unique ID for this WebApp</td>
 </tr>
 <tr>
-<td>ads-transportBackLog</td>
-<td><em>int</em></td>
-<td>50</td>
-<td>The number of messages on hold if the server is overloaded (not used for UDP)</td>
+<td><strong>ads-httpAppCtxPath</strong></td>
+<td><em>String</em></td>
+<td>N/A</td>
+<td>The context</td>
 </tr>
 </tbody>
 </table>
+<p>Here is an example of configuration :</p>
+<div class="codehilite"><pre><span class="err">dn:</span> <span
class="err">ads-id=webApp1,ou=httpWebApps,ads-serverId=httpServer,ou=servers,ads-directoryServiceId=default,ou=config</span>
+<span class="err">object</span><span class="kd">class</span><span
class="err">:</span> <span class="err">top</span>
+<span class="err">objectclass:</span> <span class="err">ads-base</span>
+<span class="err">objectclass:</span> <span class="err">ads-httpWebApp</span>
+<span class="err">ads-Id:</span> <span class="err">webApp1</span>
+<span class="err">ads-httpWarFile:</span> <span class="err">war</span>
<span class="err">file</span> <span class="err">1</span>
+<span class="err">ads-httpAppCtxPath:</span> <span class="err">/home/app1</span>
+</pre></div>
+
+
+<h2 id="change-password-server">Change Password Server</h2>
+<p>To be added...</p>
 
 
     <div class="nav">



Mime
View raw message