diff --git a/doc/guide/admin/quickstart.sdf b/doc/guide/admin/quickstart.sdf index 242cf1efb678ac04d59bb427902ea5676b6657de..6c3b0320ae19961afd950e5ecdae2e3e9165acb5 100644 --- a/doc/guide/admin/quickstart.sdf +++ b/doc/guide/admin/quickstart.sdf @@ -8,19 +8,20 @@ The following is a quick start guide to [[DOC_NAME]], including the Standalone {{TERM:LDAP}} Daemon, {{slapd}}(8). It is meant to walk you through the basic steps needed to install -and configure OpenLDAP Software. It should be used in conjunction -with the other chapters of this document, manual pages, and other -materials provided with the distribution (e.g. the {{F:INSTALL}} -document) or on the OpenLDAP web site (in particular, the OpenLDAP -Software {{TERM:FAQ}}). +and configure {{PRD:OpenLDAP Software}}. It should be used in +conjunction with the other chapters of this document, manual pages, +and other materials provided with the distribution (e.g. the +{{F:INSTALL}} document) or on the {{PRD:OpenLDAP}} web site +({{URL: http://www.OpenLDAP.org}}), in particular the OpenLDAP +Software {{TERM:FAQ}} ({{URL: http://www.OpenLDAP.org/faq/?file=2}}). If you intend to run OpenLDAP Software seriously, you should review all of this document before attempting to install the software. Note: This quick start guide does not use strong authentication nor any integrity or confidential protection services. These -services are described in other chapters of the OpenLDAP Administrator's -Guide. +services are described in other chapters of the +OpenLDAP Administrator's Guide. .{{S: }} @@ -179,7 +180,7 @@ by running the command: . To check to see if the server is running and configured correctly, you can run a search against it with {{ldapsearch}}(1). By default, -ldapsearch is installed as {{F:/usr/local/bin/ldapsearch}}: +{{ldapsearch}} is installed as {{F:/usr/local/bin/ldapsearch}}: ..{{EX:ldapsearch -x -b '' -s base '(objectclass=*)' namingContexts}} diff --git a/doc/guide/admin/slapdconf2.sdf b/doc/guide/admin/slapdconf2.sdf index bfc546ca2e4cf164ce7e866c133b47f9ff38bed7..4706819b7ff6675c00ef80ceb2686f97e512d6d0 100644 --- a/doc/guide/admin/slapdconf2.sdf +++ b/doc/guide/admin/slapdconf2.sdf @@ -684,7 +684,7 @@ attributes, and {{EX:attrsonly}} is unset by default. Both {{EX:sizelimit}} and {{EX:timelimit}} default to "unlimited", and only positive integers or "unlimited" may be specified. -The LDAP Content Synchronization protocol has two operation +The {{TERM[expand]LDAP Sync}} protocol has two operation types: {{EX:refreshOnly}} and {{EX:refreshAndPersist}}. The operation type is specified by the {{EX:type}} parameter. In the {{EX:refreshOnly}} operation, the next synchronization search operation @@ -692,7 +692,7 @@ is periodically rescheduled at an interval time after each synchronization operation finishes. The interval is specified by the {{EX:interval}} parameter. It is set to one day by default. In the {{EX:refreshAndPersist}} operation, a synchronization search -remains persistent in the provider slapd. Further updates to the +remains persistent in the provider {{slapd}} instance. Further updates to the master replica will generate {{EX:searchResultEntry}} to the consumer slapd as the search responses to the persistent synchronization search. @@ -720,7 +720,7 @@ master database. The {{EX:bindmethod}} is {{EX:simple}} or {{EX:sasl}}, depending on whether simple password-based authentication or {{TERM:SASL}} authentication is to be used when connecting -to the provider slapd. +to the provider {{slapd}} instance. Simple authentication should not be used unless adequate data integrity and confidentiality protections are in place (e.g. TLS @@ -739,29 +739,30 @@ mechanisms authenticate the identity within. The {{EX:secprops}} parameter specifies Cyrus SASL security properties. The {{EX:starttls}} parameter specifies use of the StartTLS extended -operation to establish a TLS session before Binding to the provider. +operation to establish a TLS session before authenticating to the provider. If the {{EX:critical}} argument is supplied, the session will be aborted -if the StartTLS request fails. Otherwise the syncrepl session continues +if the StartTLS request fails. Otherwise the syncrepl session continues without TLS. Note that the main slapd TLS settings are not used by the -syncrepl engine; by default the TLS parameters from {{EX:ldap.conf}} -will be used. TLS settings may be specified here, in which case the -{{EX:ldap.conf}} settings will be completely ignored. +syncrepl engine; by default the TLS parameters from a {{ldap.conf}}(5) +configuration file will be used. TLS settings may be specified here, +in which case any {{ldap.conf}}(5) settings will be completely ignored. -Rather than replicating whole entries, the consumer can query logs of -data modifications. This mode of operation is referred to as -{{EX:delta syncrepl}}. In addition to the above parameters, the +Rather than replicating whole entries, the consumer can query logs +of data modifications. This mode of operation is referred to as +{{delta syncrepl}}. In addition to the above parameters, the {{EX:logbase}} and {{EX:logfilter}} parameters must be set appropriately -for the log that will be used. The {{EX:syncdata}} parameter must be set -to either "accesslog" if the log conforms to the {{EX:slapo-accesslog (5)}} -log format, or "changelog" if the log conforms to the obsolete -{{EX:changelog}} format. If the {{EX:syncdata}} parameter is omitted or set -to "default" then the log parameters are ignored. - -The syncrepl replication mechanism is supported by the -two native backends: back-bdb and back-hdb. - -See the {{SECT:LDAP Sync Replication}} chapter of the admin guide -for more information on how to use this directive. +for the log that will be used. The {{EX:syncdata}} parameter must +be set to either {{EX:"accesslog"}} if the log conforms to the +{{slapo-accesslog}}(5) log format, or {{EX:"changelog"}} if the log +conforms to the obsolete {{changelog}} format. If the {{EX:syncdata}} +parameter is omitted or set to {{EX:"default"}} then the log +parameters are ignored. + +The {{syncrepl}} replication mechanism is supported by the {{bdb}} and +{{hdb}} backends. + +See the {{SECT:LDAP Sync Replication}} chapter of this guide for +more information on how to use this directive. H4: olcTimeLimit: <integer>