]> git.sur5r.net Git - openldap/blobdiff - doc/guide/admin/slapdconfig.sdf
ITS#2945 fix typo, add more examples
[openldap] / doc / guide / admin / slapdconfig.sdf
index 8a06d339922225c7e3192559b74afec9eba6927e..0ea54b908920b46d1fdde7f6457357af558f6f4a 100644 (file)
@@ -307,13 +307,14 @@ given, the standard LDAP port number (389 or 636) is used.
 URI such as {{EX:ldap://slave.example.com:389}} or
 {{EX:ldaps://slave.example.com:636}}.
 
-The {{EX:binddn=}} parameter gives the DN to bind as for updates to
-the slave slapd. It should be a DN which has read/write
-access to the slave slapd's database, typically given as a
-{{EX:rootdn}} in the slave's config file. It must also match the
-{{EX:updatedn}} directive in the slave slapd's config file. Since DNs are
-likely to contain embedded spaces, the entire {{EX:"binddn=<DN>"}}
-string should be enclosed in double quotes.
+The {{EX:binddn=}} parameter gives the DN to bind as for updates
+to the slave slapd. It should be a DN which has read/write access
+to the slave slapd's database.  It must also match the {{EX:updatedn}}
+directive in the slave slapd's config file.  Generally, this DN
+{{should not}} be the same as the {{EX:rootdn}} of the master
+database.  Since DNs are likely to contain embedded spaces, the
+entire {{EX:"binddn=<DN>"}} string should be enclosed in double
+quotes.
 
 The {{EX:bindmethod}} is {{EX:simple}} or {{EX:kerberos}} or {{EX:sasl}},
 depending on whether simple password-based authentication or Kerberos
@@ -416,7 +417,7 @@ prefix of another, it must appear after it in the config file.
 
 H4: syncrepl
 
->      syncrepl id=<replica ID>
+>      syncrepl rid=<replica ID>
 >              provider=ldap[s]://<hostname>[:port]
 >              [type=refreshOnly|refreshAndPersist]
 >              [interval=dd:hh:mm:ss]
@@ -448,11 +449,11 @@ kept up-to-date with the master content using the LDAP Content
 Synchronization protocol. See {{EX:draft-zeilenga-ldup-sync-xx.txt}}
 ({{a work in progress}}) for more information on the protocol.
 
-The {{EX:id}} parameter is used for identification of the current
-{{EX:syncrepl}} directive in the database, where {{EX:<replica ID>}}
-uniquely identifies the syncrepl specification described by the current
-{{EX:syncrepl}} directive. {{EX:<replica ID>}} is non-negative and is no
-more than three digits in length.
+The {{EX:rid}} parameter is used for identification of the current
+{{EX:syncrepl}} directive within the replication consumer server,
+where {{EX:<replica ID>}} uniquely identifies the syncrepl specification
+described by the current {{EX:syncrepl}} directive. {{EX:<replica ID>}}
+is non-negative and is no more than three decimal digits in length.
 
 The {{EX:provider}} parameter specifies the replication provider site
 containing the master content as an LDAP URI. The {{EX:provider}}
@@ -500,13 +501,12 @@ schema conformance. The default is off.
 
 The {{EX:updatedn}} parameter specifies the DN in the consumer site
 which is allowed to make changes to the replica. This DN is used
-locally by the syncrepl engine when updating the replica with
-the entries received from the provider site by using the
-internal operation mechanism. The update of the replica content
-is subject to the access control privileges of the DN.
-The DN should have read/write access to the replica database.
-It is typically given as a {{EX:rootdn}} in the consumer site's
-config file.
+locally by the syncrepl engine when updating the replica with the
+entries received from the provider site by using the internal
+operation mechanism. The update of the replica content is subject
+to the access control privileges of the DN.  The DN should have
+read/write access to the replica database.  Generally, this DN
+{{should not}} be the same as {{EX:rootdn}}.
 
 The {{EX:binddn}} parameter gives the DN to bind as for the
 syncrepl searches to the provider slapd. It should be a DN
@@ -592,31 +592,28 @@ containing the database and associated indices live.
 H4: sessionlog <sid> <limit>
 
 This directive specifies a session log store in the syncrepl 
-replication provider site which contains information on
-the entries that have been scoped out of the content of the
-replication session identified by {{EX:<sid>}}.
-The first syncrepl search request having the same sid value in the
-cookie establishes the session log store in the provider site.
+replication provider server which contains information on
+the entries that have been scoped out of the replication
+content identified by {{EX:<sid>}}.
+The first syncrepl search request having the same {{EX:<sid>}} value
+in the cookie establishes the session log store in the provider server.
 The number of the entries in the session log store is limited
 by {{EX:<limit>}}. Excessive entries are removed from the store
 in the FIFO order. Both {{EX:<sid>}} and {{EX:<limit>}} are
-non-negative integers. {{EX:<sid>}} has no more than three digits.
+non-negative integers. {{EX:<sid>}} has no more than three decimal digits.
 
 The LDAP Content Synchronization operation that falls into a pre-existing
-session uses the session log store in order to reduce the amount
+session can use the session log store in order to reduce the amount
 of synchronization traffic. If the replica is not so outdated that
 it can be made up-to-date by the information in the session store,
 the provider slapd will send the consumer slapd the identities of the
 scoped-out entries together with the in-scope entries added to or
 modified within the replication content. If the replica status is
-beyond the coverage of the history store, then the provider slapd will
-send the identities of the unchanged in-scope entries along with the
-changed in-scope entries. The consumer slapd will then remove those
-entries in the replica which are not identified as present in the
-master content.
-
-An access control mechanism is to be further provided to
-make the session joining controllable.
+outdated too much and beyond the coverage of the history store,
+then the provider slapd will send the identities of the unchanged
+in-scope entries along with the changed in-scope entries.
+The consumer slapd will then remove those entries in the replica
+which are not identified as present in the provider content.
 
 
 H3: LDBM Database Directives
@@ -739,7 +736,7 @@ access line is:
 >              [aci=<attrname>]
 >      <access> ::= [self]{<level>|<priv>}
 >      <level> ::= none | auth | compare | search | read | write
->      <priv> ::= {=|+|-}{w|r|s|c|x}+
+>      <priv> ::= {=|+|-}{w|r|s|c|x|0}+
 >      <control> ::= [stop | continue | break]
 
 where the <what> part selects the entries and/or attributes to which
@@ -759,9 +756,9 @@ and attributes to which the access control applies.  Entries are
 commonly selected in two ways: by DN and by filter.  The following
 qualifiers select entries by DN:
 
->      by *
->      by dn[.<basic-style>]=<regex>
->      by dn.<scope-style>=<DN>
+>      to *
+>      to dn[.<basic-style>]=<regex>
+>      to dn.<scope-style>=<DN>
 
 The first form is used to select all entries.  The second form may
 be used to select entries by matching a regular expression against
@@ -796,17 +793,17 @@ For example, if the directory contained entries named:
 
 Entries may also be selected using a filter:
 
->      by filter=<ldap filter>
+>      to filter=<ldap filter>
 
 where <ldap filter> is a string representation of an LDAP
 search filter, as described in {{REF:RFC2254}}.  For example:
 
->      by filter=(objectClass=person)
+>      to filter=(objectClass=person)
 
 Note that entries may be selected by both DN and filter by
 including both qualifiers in the <what> clause.
 
->      by dn.one="ou=people,o=suffix" filter=(objectClass=person)
+>      to dn.one="ou=people,o=suffix" filter=(objectClass=person)
 
 Attributes within an entry are selected by including a comma-separated
 list of attribute names in the <what> selector:
@@ -879,7 +876,7 @@ The kind of <access> granted can be one of the following:
 !block table; colaligns="LRL"; coltags="EX,EX,N"; align=Center; \
        title="Table 5.4: Access Levels"
 Level  Privileges      Description
-none                   no access
+none   =0              no access
 auth   =x              needed to bind
 compare        =cx             needed to compare
 search =scx            needed to apply search filters