X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman5%2Fslapd.conf.5;h=380bb9999fa25091186fed41bc7bcae262e592e4;hb=6624f68725d97180f89d5481f50e99727d9772bc;hp=827134160f5d734c710fa140e2a9a5ebe510f326;hpb=5de276fa255d438907f2163ee610fbcb9ab63239;p=openldap diff --git a/doc/man/man5/slapd.conf.5 b/doc/man/man5/slapd.conf.5 index 827134160f..380bb9999f 100644 --- a/doc/man/man5/slapd.conf.5 +++ b/doc/man/man5/slapd.conf.5 @@ -1,5 +1,5 @@ -.TH SLAPD.CONF 5 "26 January 2002" "OpenLDAP LDVERSION" -.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved. +.TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION" +.\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. .\" $OpenLDAP$ .SH NAME @@ -35,7 +35,7 @@ is as follows: # comment - these options apply to every database # first database definition & configuration options - database + database # subsequent database definitions & configuration options ... @@ -45,9 +45,12 @@ As many backend-specific sections as desired may be included. Global options can be overridden in a backend (for options that appear more than once, the last appearance in the .B slapd.conf -file is used). Blank lines and comment lines beginning with a `#' -character are ignored. If a line begins with white space, it is -considered a continuation of the previous line. +file is used). +.LP +If a line begins with white space, it is considered a continuation +of the previous line. Blank lines and comment lines beginning with +a `#' character are ignored. (Note: continuation lines are unwrapped +before comment processing is applied.) .LP Arguments on configuration lines are separated by white space. If an argument contains white space, the argument should be enclosed in @@ -56,46 +59,86 @@ backslash character (`\\'), the character should be preceded by a backslash character. .LP The specific configuration options available are discussed below in the -Global Configuration Options, General Backend Options, General Database -Options, LDBM Database-Specific Options, -Shell Database-Specific Options, and Password -Database-Specific Options sections. Refer to the "OpenLDAP -Administrator's Guide" for more details on the slapd configuration -file. +Global Configuration Options, General Backend Options, and General Database +Options. Backend-specific options are discussed in the +.B slapd-(5) +manual pages. Refer to the "OpenLDAP Administrator's Guide" for more +details on the slapd configuration file. .SH GLOBAL CONFIGURATION OPTIONS Options described in this section apply to all backends, unless specifically overridden in a backend definition. Arguments that should be replaced by actual text are shown in brackets <>. .TP -.B access to [ by ]+ +.B access to "[ by ]+" Grant access (specified by ) to a set of entries and/or attributes (specified by ) by one or more requestors (specified by ). -See the "OpenLDAP's Administrator's Guide" for details. +See +.BR slapd.access (5) +and the "OpenLDAP's Administrator's Guide" for details. .TP .B allow Specify a set of features (separated by white space) to allow (default none). .B bind_v2 -allows acceptance of LDAPv2 bind requests. +allows acceptance of LDAPv2 bind requests. Note that +.BR slapd (8) +does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494). .B bind_anon_cred allows anonymous bind when credentials are not empty (e.g. when DN is empty). .B bind_anon_dn allows unauthenticated (anonymous) bind when DN is not empty. +.B update_anon +allow unauthenticated (anonymous) update operations to be processed +(subject to access controls and other administrative limits). .TP .B argsfile The ( absolute ) name of a file that will hold the .B slapd server's command line options if started without the debugging command line option. +.TP +.B attributeoptions [option-name]... +Define tagging attribute options or option tag/range prefixes. +Options must not end with `-', prefixes must end with `-'. +The `lang-' prefix is predefined. +If you use the +.B attributeoptions +directive, `lang-' will no longer be defined and you must specify it +explicitly if you want it defined. + +An attribute description with a tagging option is a subtype of that +attribute description without the option. +Except for that, options defined this way have no special semantics. +Prefixes defined this way work like the `lang-' options: +They define a prefix for tagging options starting with the prefix. +That is, if you define the prefix `x-foo-', you can use the option +`x-foo-bar'. +Furthermore, in a search or compare, a prefix or range name (with +a trailing `-') matches all options starting with that name, as well +as the option with the range name sans the trailing `-'. +That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'. + +RFC 2251 reserves options beginning with `x-' for private experiments. +Other options should be registered with IANA, see RFC 3383 section 3.4. +OpenLDAP also has the `binary' option built in, but this is a transfer +option, not a tagging option. .HP .hy 0 -.B attributetype (\ [NAME\ ] [OBSOLETE]\ +.B attributetype "(\ \ + [NAME\ ]\ [DESC\ ]\ - [SUP\ ] [EQUALITY\ ] [ORDERING\ ]\ - [SUBSTR\ ] [SYNTAX\ ] [SINGLE\-VALUE] [COLLECTIVE]\ - [NO\-USER\-MODIFICATION] [USAGE\ ]\ ) + [OBSOLETE]\ + [SUP\ ]\ + [EQUALITY\ ]\ + [ORDERING\ ]\ + [SUBSTR\ ]\ + [SYNTAX\ ]\ + [SINGLE\-VALUE]\ + [COLLECTIVE]\ + [NO\-USER\-MODIFICATION]\ + [USAGE\ ]\ )" .RS Specify an attribute type using the LDAPv3 syntax defined in RFC 2252. The slapd parser extends the RFC 2252 definition by allowing string @@ -103,29 +146,23 @@ forms as well as numeric OIDs to be used for the attribute OID and attribute syntax OID. (See the .B objectidentifier -description.) Currently the syntax name parser is case-sensitive. -The known syntax names are: -.RS -.RS -.PD 0 -AttributeTypeDescription Audio Binary BitString Certificate CertificateList -CertificatePair DN DeliveryMethod DirectoryString DITContentRuleDescription -DITStructureRuleDescription EnhancedGuide FacsimileTelephoneNumber -GeneralizedTime Guide IA5String Integer MatchingRuleDescription -MatchingRuleUseDescription MailPreference NameAndOptionalUUID -NameFormDescription NumericString ObjectClassDescription OID -OtherMailbox OctetString PostalAddress ProtocolInformation -PresentationAddress PrintableString SupportedAlgorithm TelephoneNumber -TeletexTerminalIdentifier TelexNumber UTCTime LDAPSyntaxDescription -SubstringAssertion NISnetgrouptriple Bootparameter -.PD -.RE -.RE +description.) .RE .TP .B concurrency Specify a desired level of concurrency. Provided to the underlying thread system as a hint. The default is not to provide any hint. +.TP +.B conn_max_pending +Specify the maximum number of pending requests for an anonymous session. +If requests are submitted faster than the server can process them, they +will be queued up to this limit. If the limit is exceeded, the session +is closed. The default is 100. +.TP +.B conn_max_pending_auth +Specify the maximum number of pending requests for an authenticated session. +The default is 1000. +.\"-- NEW_LOGGING option -- .\".TP .\".B debug .\"Specify a logging level for a particular subsystem. The subsystems include @@ -202,6 +239,42 @@ disables Start TLS from forcing session to anonymous status (see also .B tls_authc disables StartTLS if authenticated (see also .BR tls_2_anon ). +.HP +.hy 0 +.B ditcontentrule "(\ \ + [NAME\ ]\ + [DESC\ ]\ + [OBSOLETE]\ + [AUX\ ]\ + [MUST\ ]\ + [MAY\ ]\ + [NOT\ ]\ )" +.RS +Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252. +The slapd parser extends the RFC 2252 definition by allowing string +forms as well as numeric OIDs to be used for the attribute OID and +attribute syntax OID. +(See the +.B objectidentifier +description.) +.RE +.TP +.B gentlehup { on | off } +A SIGHUP signal will only cause a 'gentle' shutdown-attempt: +.B Slapd +will stop listening for new connections, but will not close the +connections to the current clients. Future write operations return +unwilling-to-perform, though. Slapd terminates when all clients +have closed their connections (if they ever do), or \- as before \- +if it receives a SIGTERM signal. This can be useful if you wish to +terminate the server and start a new +.B slapd +server +.B with another database, +without disrupting the currently active clients. +The default is off. You may wish to use +.B idletimeout +along with this option. .TP .B idletimeout Specify the number of seconds to wait before forcibly closing @@ -211,129 +284,7 @@ feature. The default is 0. .B include Read additional configuration information from the given file before continuing with the next line of the current file. -.TP -.B limits [ [...]] -Specify time and size limits based on who initiated an operation. -The argument -.B who -can be any of -.RS -.RS -.TP -anonymous | users | [dn[.