You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by bu...@apache.org on 2014/11/30 07:01:23 UTC

svn commit: r931054 - in /websites/staging/directory/trunk/content: ./ apacheds/advanced-ug/2-server-config.html apacheds/advanced-ug/2.1-config-description.html

Author: buildbot
Date: Sun Nov 30 06:01:22 2014
New Revision: 931054

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
    websites/staging/directory/trunk/content/apacheds/advanced-ug/2.1-config-description.html

Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sun Nov 30 06:01:22 2014
@@ -1 +1 @@
-1642524
+1642526

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 Sun Nov 30 06:01:22 2014
@@ -164,8 +164,11 @@
 
 
 <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 the <strong>DIT</strong>. Otherwise, all the configuration modifications won't be applied on a started server : you will have to restart the server in order to get those modifications applied.</p>
-<p>We will then describe the installation layout (ie, how tha various files are stored on yoru disk).</p>
+<p>We will now describe the server configuration. Usually, all the configuration changes
+are done using Apache Directory Studio, which offers a pretty GUI. One can also update
+server configuration using LDAP operations, as the configuration is stored in the <strong>DIT</strong>.
+Note that the server must be restarted after modifying the configuration.</p>
+<p>We will then describe the installation layout (ie, how tha various files are stored on the disk).</p>
 <h2 id="chapter-content">Chapter content</h2>
 <ul>
 <li><a href="2.1-config-description.html">2.1 - Configuration Description</a></li>

Modified: websites/staging/directory/trunk/content/apacheds/advanced-ug/2.1-config-description.html
==============================================================================
--- websites/staging/directory/trunk/content/apacheds/advanced-ug/2.1-config-description.html (original)
+++ websites/staging/directory/trunk/content/apacheds/advanced-ug/2.1-config-description.html Sun Nov 30 06:01:22 2014
@@ -164,10 +164,9 @@
 
 
 <h1 id="21-configuration-description">2.1 - Configuration Description</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 the <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>
+<p>It's a good practice to not modify the configuration LDIF file by hand, instead use the Studio Configuration plugin to modify the server configuration.</p>
 <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 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 corresponding <em>Server</em> that uses them. Each server may contain one or more transports.</p>
 <p>The following hierarchy describe the different kind of elements that one can configure, and their relationship :</p>
 <ul>
 <li>ou=config<ul>
@@ -220,7 +219,7 @@
 </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 :
+<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 server, 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>
 <DIV class="note" markdown="1">
@@ -228,8 +227,8 @@ Note that bold attributes are mandatory 
 </DIV>
 
 <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 may have more than one server, but only one <em>DirectoryService</em>. This component 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>
+<p>This is the heart of the entire system : the place where we store the data. Most of the servers are depending on this component. You may have more than one server(e.g LDAP, Kerberos, ChangePassword etc), but only one <em>DirectoryService</em>. </p>
+<p>Configuration options:</p>
 <table>
 <thead>
 <tr>
@@ -303,10 +302,10 @@ Note that bold attributes are mandatory 
 </tbody>
 </table>
 <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>The <em>ChangeLog</em> is an optional system that logs every change 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, changelog has in-memory support only.</p>
 <p>It's disabled by default.</p>
-<p>Here are the configuration element for the <em>ChangeLog</em> elements :</p>
+<p>Configuration options:</p>
 <table>
 <thead>
 <tr>
@@ -344,8 +343,8 @@ Note that bold attributes are mandatory 
 </tbody>
 </table>
 <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>
+<p>The <em>Journal</em> logs every modification on the file system. It's intended to be used if the <em>DirectoryService</em> crashes, as we can re-apply the journal starting from a date in the past where we know that the underlying database is correct.</p>
+<p>Configuration options:</p>
 <table>
 <thead>
 <tr>
@@ -395,8 +394,9 @@ Note that bold attributes are mandatory 
 </tbody>
 </table>
 <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 configured : the <em>authenticationInterceptor</em>. </p>
+<p>The default <em>Interceptors</em> are generally not configurable. You don't want to change their order, or remove anyone from the default interceptors unless you are very familiar with the
+internals of ApacheDS and/or including a custom interceptor.</p>
+<p>However, at least one default <em>Interceptor</em> can be configured : 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 that can be configured in such a case :</p>
 <table>
 <thead>