slapdconf2.sdf 40.5 KB
Newer Older
Howard Chu's avatar
Howard Chu committed
1
# $OpenLDAP$
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
2
# Copyright 2005-2020 The OpenLDAP Foundation, All Rights Reserved.
3
4
5
6
7
# COPYING RESTRICTIONS APPLY, see COPYRIGHT.

H1: Configuring slapd

Once the software has been built and installed, you are ready
8
9
to configure {{slapd}}(8) for use at your site.

10
11
12
13
14
15
16
OpenLDAP 2.3 and later have transitioned to using a dynamic runtime
configuration engine, {{slapd-config}}(5).  {{slapd-config}}(5)
* is fully LDAP-enabled
* is managed using the standard LDAP operations
* stores its configuration data in an {{TERM:LDIF}} database, generally
in the {{F:/usr/local/etc/openldap/slapd.d}} directory.
* allows all of slapd's configuration options to be changed on the fly,
17
generally without requiring a server restart for the changes
18
19
to take effect.

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
This chapter describes the general format of the {{slapd-config}}(5)
configuration system, followed by a detailed description of commonly used
settings.

The older style {{slapd.conf}}(5) file is still supported, but its use
is deprecated and support for it will be withdrawn in a future OpenLDAP
release.  Configuring {{slapd}}(8) via {{slapd.conf}}(5) is described in
the next chapter.

Refer to {{slapd}}(8) for information on how to have slapd automatically
convert from {{slapd.conf}}(5) to {{slapd-config}}(5).


Note: Although the {{slapd-config}}(5) system stores its configuration
as (text-based) LDIF files, you should {{1:never}} edit any of
the LDIF files directly.  Configuration changes should be performed via LDAP
operations, e.g. {{ldapadd}}(1), {{ldapdelete}}(1), or {{ldapmodify}}(1).


Note: You will need to continue to use the older {{slapd.conf}}(5)
configuration system if your OpenLDAP installation requires the use of one
or more backends or overlays that have not been updated to use the
42
43
{{slapd-config}}(5) system.  As of OpenLDAP 2.4.33, all of the official
backends have been updated.  There may be additional contributed or experimental
44
overlays that also have not been updated.
45

46
47
48
49
50
51
52
53
54

H2: Configuration Layout

The slapd configuration is stored as a special LDAP directory with
a predefined schema and DIT. There are specific objectClasses used to
carry global configuration options, schema definitions, backend and
database definitions, and assorted other items. A sample config tree
is shown in Figure 5.1.

55
!import "config_dit.png"; align="center"; title="Sample configuration tree"
56
57
58
59
60
FT[align="Center"] Figure 5.1: Sample configuration tree.

Other objects may be part of the configuration but were omitted from
the illustration for clarity.

61
The {{slapd-config}} configuration tree has a very specific structure. The
62
63
64
65
66
67
68
69
70
71
root of the tree is named {{EX:cn=config}} and contains global configuration
settings. Additional settings are contained in separate child entries:
* Dynamically loaded modules
.. These may only be used if the {{EX:--enable-modules}} option was
used to configure the software.
* Schema definitions
.. The {{EX:cn=schema,cn=config}} entry contains the system schema (all
the schema that is hard-coded in slapd).
.. Child entries of {{EX:cn=schema,cn=config}} contain user schema as
loaded from config files or added at runtime.
72
* Backend-specific configuration
73
74
75
76
77
78
* Database-specific configuration
.. Overlays are defined in children of the Database entry.
.. Databases and Overlays may also have other miscellaneous children.

The usual rules for LDIF files apply to the configuration information:
Comment lines beginning with a '{{EX:#}}' character
79
are ignored.  If a line begins with a single space, it is considered a
80
continuation of the previous line (even if the previous line is a
81
comment) and the single leading space is removed. Entries are separated by blank lines.
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

The general layout of the config LDIF is as follows:

>	# global configuration settings
>	dn: cn=config
>	objectClass: olcGlobal
>	cn: config
>	<global config settings>
>
>	# schema definitions
>	dn: cn=schema,cn=config
>	objectClass: olcSchemaConfig
>	cn: schema
>	<system schema>
>
>	dn: cn={X}core,cn=schema,cn=config
>	objectClass: olcSchemaConfig
>	cn: {X}core
>	<core schema>
>
>	# additional user-specified schema
>	...
>
>	# backend definitions
Howard Chu's avatar
Howard Chu committed
106
>	dn: olcBackend=<typeA>,cn=config
107
>	objectClass: olcBackendConfig
Howard Chu's avatar
Howard Chu committed
108
>	olcBackend: <typeA>
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
>	<backend-specific settings>
>
>	# database definitions
>	dn: olcDatabase={X}<typeA>,cn=config
>	objectClass: olcDatabaseConfig
>	olcDatabase: {X}<typeA>
>	<database-specific settings>
>
>	# subsequent definitions and settings
>	...

Some of the entries listed above have a numeric index {{EX:"{X}"}} in
their names. While most configuration settings have an inherent ordering
dependency (i.e., one setting must take effect before a subsequent one
may be set), LDAP databases are inherently unordered. The numeric index
is used to enforce a consistent ordering in the configuration database,
so that all ordering dependencies are preserved. In most cases the index
does not have to be provided; it will be automatically generated based
on the order in which entries are created.

Howard Chu's avatar
Howard Chu committed
129
130
131
132
133
134
135
136
137
138
Configuration directives are specified as values of individual
attributes.
Most of the attributes and objectClasses used in the slapd
configuration have a prefix of {{EX:"olc"}} (OpenLDAP Configuration)
in their names. Generally there is a one-to-one correspondence
between the attributes and the old-style {{EX:slapd.conf}} configuration
keywords, using the keyword as the attribute name, with the "olc"
prefix attached.

A configuration directive may take arguments.  If so, the arguments are
139
separated by whitespace.  If an argument contains whitespace,
140
the argument should be enclosed in double quotes {{EX:"like this"}}.
Howard Chu's avatar
Howard Chu committed
141
142
In the descriptions that follow, arguments that should be replaced
by actual text are shown in brackets {{EX:<>}}.
143
144
145
146
147
148
149
150
151
152
153

The distribution contains an example configuration file that will
be installed in the {{F: /usr/local/etc/openldap}} directory.
A number of files containing schema definitions (attribute types
and object classes) are also provided in the
{{F: /usr/local/etc/openldap/schema}} directory.


H2: Configuration Directives

This section details commonly used configuration directives.  For
154
a complete list, see the {{slapd-config}}(5) manual page.  This section
Howard Chu's avatar
Howard Chu committed
155
156
157
158
will treat the configuration directives in a top-down order, starting
with the global directives in the {{EX:cn=config}} entry. Each
directive will be described along with its default value (if any) and
an example of its use.
159
160


Howard Chu's avatar
Howard Chu committed
161
H3: cn=config
162

Howard Chu's avatar
Howard Chu committed
163
Directives contained in this entry generally apply to the server as a whole.
164
165
Most of them are system or connection oriented, not database related. This
entry must have the {{EX:olcGlobal}} objectClass.
166
167


Howard Chu's avatar
Howard Chu committed
168
H4: olcIdleTimeout: <integer>
169
170

Specify the number of seconds to wait before forcibly closing
Howard Chu's avatar
Howard Chu committed
171
an idle client connection.  A value of 0, the default,
172
173
174
disables this feature.


Howard Chu's avatar
Howard Chu committed
175
H4: olcLogLevel: <level>
176
177
178
179
180
181

This directive specifies the level at which debugging statements
and operation statistics should be syslogged (currently logged to
the {{syslogd}}(8) {{EX:LOG_LOCAL4}} facility). You must have
configured OpenLDAP {{EX:--enable-debug}} (the default) for this
to work (except for the two statistics levels, which are always
Howard Chu's avatar
Howard Chu committed
182
183
184
enabled). Log levels may be specified as integers or by keyword.
Multiple log levels may be used and the levels are additive.
To display what levels
185
correspond to what kind of debugging, invoke slapd with {{EX:-d?}}
Howard Chu's avatar
Howard Chu committed
186
or consult the table below. The possible values for <level> are:
187
188
189

!block table; colaligns="RL"; align=Center; \
	title="Table 5.1: Debugging Levels"
190
191
Level	Keyword		Description
-1	any		enable all debugging
Gavin Henry's avatar
Gavin Henry committed
192
0			no debugging
Howard Chu's avatar
Howard Chu committed
193
1	(0x1 trace)	trace function calls
194
195
196
197
198
199
200
201
202
203
204
205
206
2	(0x2 packets)	debug packet handling
4	(0x4 args)	heavy trace debugging
8	(0x8 conns)	connection management
16	(0x10 BER)	print out packets sent and received
32	(0x20 filter)	search filter processing
64	(0x40 config)	configuration processing
128	(0x80 ACL)	access control list processing
256	(0x100 stats)	stats log connections/operations/results
512	(0x200 stats2)	stats log entries sent
1024	(0x400 shell)	print communication with shell backends
2048	(0x800 parse)	print entry parsing debugging
16384	(0x4000 sync)	syncrepl consumer processing
32768	(0x8000 none)	only messages that get logged whatever log level is set
207
208
!endblock

209
The desired log level can be input as a single integer that
210
combines the (ORed) desired levels, both in decimal or in hexadecimal
211
212
213
214
215
216
217
218
219
220
notation, as a list of integers (that are ORed internally), or as a list of the names that are shown between brackets, such that

>		olcLogLevel 129
>		olcLogLevel 0x81
>		olcLogLevel 128 1
>		olcLogLevel 0x80 0x1
>		olcLogLevel acl trace

are equivalent.

221
\Examples:
222

223
E: olcLogLevel -1
224
225
226
227

This will cause lots and lots of debugging information to be
logged.

228
E: olcLogLevel conns filter
229

Howard Chu's avatar
Howard Chu committed
230
Just log the connection and search filter processing.
231

232
E: olcLogLevel none
233
234
235
236
237

Log those messages that are logged regardless of the configured loglevel. This
differs from setting the log level to 0, when no logging occurs. At least the
{{EX:None}} level is required to have high priority messages logged.

Howard Chu's avatar
Howard Chu committed
238
\Default:
239

240
E: olcLogLevel stats
241

242
243
244
Basic stats logging is configured by default. However, if no olcLogLevel is
defined, no logging occurs (equivalent to a 0 level).

245

Howard Chu's avatar
Howard Chu committed
246
H4: olcReferral <URI>
247
248
249
250
251
252

This directive specifies the referral to pass back when slapd
cannot find a local database to handle a request.

\Example:

Howard Chu's avatar
Howard Chu committed
253
>	olcReferral: ldap://root.openldap.org
254
255
256
257
258
259
260
261

This will refer non-local queries to the global root LDAP server
at the OpenLDAP Project. Smart LDAP clients can re-ask their
query at that server, but note that most of these clients are
only going to know how to handle simple LDAP URLs that
contain a host part and optionally a distinguished name part.


Howard Chu's avatar
Howard Chu committed
262
H4: Sample Entry
263

Howard Chu's avatar
Howard Chu committed
264
265
266
267
268
269
>dn: cn=config
>objectClass: olcGlobal
>cn: config
>olcIdleTimeout: 30
>olcLogLevel: Stats
>olcReferral: ldap://root.openldap.org
270
271


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
H3: cn=module

If support for dynamically loaded modules was enabled when configuring
slapd, {{EX:cn=module}} entries may be used to specify sets of modules to load.
Module entries must have the {{EX:olcModuleList}} objectClass.


H4: olcModuleLoad: <filename>

Specify the name of a dynamically loadable module to load. The filename
may be an absolute path name or a simple filename. Non-absolute names
are searched for in the directories specified by the {{EX:olcModulePath}}
directive.


H4: olcModulePath: <pathspec>

Specify a list of directories to search for loadable modules. Typically the
path is colon-separated but this depends on the operating system.


H4: Sample Entries

>dn: cn=module{0},cn=config
>objectClass: olcModuleList
>cn: module{0}
>olcModuleLoad: /usr/local/lib/smbk5pwd.la
>
>dn: cn=module{1},cn=config
>objectClass: olcModuleList
>cn: module{1}
>olcModulePath: /usr/local/lib:/usr/local/lib/slapd
>olcModuleLoad: accesslog.la
>olcModuleLoad: pcache.la


Howard Chu's avatar
Howard Chu committed
308
H3: cn=schema
309

Howard Chu's avatar
Howard Chu committed
310
311
312
313
The cn=schema entry holds all of the schema definitions that are hard-coded
in slapd. As such, the values in this entry are generated by slapd so no
schema values need to be provided in the config file. The entry must still
be defined though, to serve as a base for the user-defined schema to add
314
315
in underneath. Schema entries must have the {{EX:olcSchemaConfig}}
objectClass.
316

Howard Chu's avatar
Howard Chu committed
317

Kurt Zeilenga's avatar
Kurt Zeilenga committed
318
H4: olcAttributeTypes: <{{REF:RFC4512}} Attribute Type Description>
Howard Chu's avatar
Howard Chu committed
319
320
321
322
323
324

This directive defines an attribute type.
Please see the {{SECT:Schema Specification}} chapter
for information regarding how to use this directive.


Kurt Zeilenga's avatar
Kurt Zeilenga committed
325
H4: olcObjectClasses: <{{REF:RFC4512}} Object Class Description>
Howard Chu's avatar
Howard Chu committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341

This directive defines an object class.
Please see the {{SECT:Schema Specification}} chapter for
information regarding how to use this directive.


H4: Sample Entries

>dn: cn=schema,cn=config
>objectClass: olcSchemaConfig
>cn: schema
>
>dn: cn=test,cn=schema,cn=config
>objectClass: olcSchemaConfig
>cn: test
>olcAttributeTypes: ( 1.1.1
342
343
344
>  NAME 'testAttr'
>  EQUALITY integerMatch
>  SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 )
Howard Chu's avatar
Howard Chu committed
345
>olcAttributeTypes: ( 1.1.2 NAME 'testTwo' EQUALITY caseIgnoreMatch
346
>  SUBSTR caseIgnoreSubstringsMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.44 )
Howard Chu's avatar
Howard Chu committed
347
>olcObjectClasses: ( 1.1.3 NAME 'testObject'
348
>  MAY ( testAttr $ testTwo ) AUXILIARY )
Howard Chu's avatar
Howard Chu committed
349
350
351
352
353


H3: Backend-specific Directives

Backend directives apply to all database instances of the
354
same type and, depending on the directive, may be overridden
355
356
by database directives. Backend entries must have the
{{EX:olcBackendConfig}} objectClass.
357

Howard Chu's avatar
Howard Chu committed
358
H4: olcBackend: <type>
359

Howard Chu's avatar
Howard Chu committed
360
This directive names a backend-specific configuration entry.
361
362
363
364
365
366
{{EX:<type>}} should be one of the
supported backend types listed in Table 5.2.

!block table; align=Center; coltags="EX,N"; \
	title="Table 5.2: Database Backends"
Types	Description
Howard Chu's avatar
Howard Chu committed
367
config	Slapd configuration backend
368
369
dnssrv	DNS SRV backend
ldap	Lightweight Directory Access Protocol (Proxy) backend
Howard Chu's avatar
Howard Chu committed
370
ldif	Lightweight Data Interchange Format backend
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
371
mdb	Memory-Mapped DB backend
372
373
374
375
376
377
378
379
380
381
meta	Meta Directory backend
monitor	Monitor backend
passwd	Provides read-only access to {{passwd}}(5)
perl	Perl Programmable backend
shell	Shell (extern program) backend
sql	SQL Programmable backend
!endblock

\Example:

382
>	olcBackend: mdb
383

Howard Chu's avatar
Howard Chu committed
384
385
386
387
There are no other directives defined for this entry.  Specific backend
types may define additional attributes for their particular use but so
far none have ever been defined.  As such, these directives usually do
not appear in any actual configurations.
Howard Chu's avatar
Howard Chu committed
388
389
390
391


H4: Sample Entry

392
> dn: olcBackend=mdb,cn=config
Howard Chu's avatar
Howard Chu committed
393
> objectClass: olcBackendConfig
394
> olcBackend: mdb
395
396


Howard Chu's avatar
Howard Chu committed
397
H3: Database-specific Directives
398

Howard Chu's avatar
Howard Chu committed
399
Directives in this section are supported by every type of database.
400
Database entries must have the {{EX:olcDatabaseConfig}} objectClass.
401

Howard Chu's avatar
Howard Chu committed
402
H4: olcDatabase: [{<index>}]<type>
403

Howard Chu's avatar
Howard Chu committed
404
405
406
This directive names a specific database instance. The numeric {<index>} may
be provided to distinguish multiple databases of the same type. Usually the
index can be omitted, and slapd will generate it automatically.
407
{{EX:<type>}} should be one of the
Howard Chu's avatar
Howard Chu committed
408
409
410
411
412
413
supported backend types listed in Table 5.2 or the {{EX:frontend}} type.

The {{EX:frontend}} is a special database that is used to hold
database-level options that should be applied to all the other
databases. Subsequent database definitions may also override some
frontend settings.
414

Howard Chu's avatar
Howard Chu committed
415
416
417
418
419
The {{EX:config}} database is also special; both the {{EX:config}} and
the {{EX:frontend}} databases are always created implicitly even if they
are not explicitly configured, and they are created before any other
databases.

420
421
\Example:

422
>	olcDatabase: mdb
Howard Chu's avatar
Howard Chu committed
423

424
This marks the beginning of a new {{TERM:MDB}} database instance.
425
426


427
H4: olcAccess: to <what> [ by <who> [<accesslevel>] [<control>] ]+
428

Howard Chu's avatar
Howard Chu committed
429
430
This directive grants access (specified by <accesslevel>) to a
set of entries and/or attributes (specified by <what>) by one or
Gavin Henry's avatar
Gavin Henry committed
431
more requestors (specified by <who>).
432
See the {{SECT:Access Control}} section of this guide for basic usage.
Howard Chu's avatar
Howard Chu committed
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447

!if 0
More detailed discussion of this directive can be found in the
{{SECT:Advanced Access Control}} chapter.
!endif

Note: If no {{EX:olcAccess}} directives are specified, the default
access control policy, {{EX:to * by * read}}, allows all
users (both authenticated and anonymous) read access.

Note: Access controls defined in the frontend are appended to all
other databases' controls.


H4: olcReadonly { TRUE | FALSE }
448
449
450

This directive puts the database into "read-only" mode. Any
attempts to modify the database will return an "unwilling to
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
451
452
perform" error.  If set on a consumer, modifications sent by
syncrepl will still occur.
453
454
455

\Default:

Howard Chu's avatar
Howard Chu committed
456
457
>	olcReadonly: FALSE

458

Howard Chu's avatar
Howard Chu committed
459
H4: olcRootDN: <DN>
460
461
462
463
464
465
466
467
468

This directive specifies the DN that is not subject to
access control or administrative limit restrictions for
operations on this database.  The DN need not refer to
an entry in this database or even in the directory. The
DN may refer to a SASL identity.

Entry-based Example:

469
>	olcRootDN: cn=Manager,dc=example,dc=com
470
471
472

SASL-based Example:

473
>	olcRootDN: uid=root,cn=example.com,cn=digest-md5,cn=auth
474
475
476
477
478

See the {{SECT:SASL Authentication}} section for information on
SASL authentication identities.


Howard Chu's avatar
Howard Chu committed
479
H4: olcRootPW: <password>
480

Howard Chu's avatar
Howard Chu committed
481
This directive can be used to specify a password for the DN for
482
483
484
485
the rootdn (when the rootdn is set to a DN within the database).

\Example:

Howard Chu's avatar
Howard Chu committed
486
>	olcRootPW: secret
487

Kurt Zeilenga's avatar
Kurt Zeilenga committed
488
489
490
It is also permissible to provide a hash of the password in
{{REF:RFC2307}} form.  {{slappasswd}}(8) may be used to generate
the password hash.
491
492
493

\Example:

Howard Chu's avatar
Howard Chu committed
494
>	olcRootPW: {SSHA}ZKKuqbEKJfKSXhUbHG3fG8MDn9j1v4QN
495
496
497
498

The hash was generated using the command {{EX:slappasswd -s secret}}.


Howard Chu's avatar
Howard Chu committed
499
500
501
502
503
504
505
506
507
H4: olcSizeLimit: <integer>

This directive specifies the maximum number of entries to return
from a search operation.

\Default:

>	olcSizeLimit: 500

508
509
See the {{SECT:Limits}} section of this guide and slapd-config(5)
for more details.
Howard Chu's avatar
Howard Chu committed
510
511
512


H4: olcSuffix: <dn suffix>
513
514
515

This directive specifies the DN suffix of queries that will be
passed to this backend database. Multiple suffix lines can be
Howard Chu's avatar
Howard Chu committed
516
517
518
519
given, and usually at least one is required for each database
definition. (Some backend types, such as {{EX:frontend}} and
{{EX:monitor}} use a hard-coded suffix which may not be overridden
in the configuration.)
520
521
522

\Example:

523
>	olcSuffix: dc=example,dc=com
524
525
526
527
528

Queries with a DN ending in "dc=example,dc=com"
will be passed to this backend.

Note: When the backend to pass a query to is selected, slapd
Howard Chu's avatar
Howard Chu committed
529
530
531
looks at the suffix value(s) in each database definition in the
order in which they were configured. Thus, if one database suffix is a
prefix of another, it must appear after it in the configuration.
532
533


Howard Chu's avatar
Howard Chu committed
534
H4: olcSyncrepl
535

Howard Chu's avatar
Howard Chu committed
536
>	olcSyncrepl: rid=<replica ID>
537
538
539
540
>		provider=ldap[s]://<hostname>[:port]
>		[type=refreshOnly|refreshAndPersist]
>		[interval=dd:hh:mm:ss]
>		[retry=[<retry interval> <# of retries>]+]
541
>		searchbase=<base DN>
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
>		[filter=<filter str>]
>		[scope=sub|one|base]
>		[attrs=<attr list>]
>		[attrsonly]
>		[sizelimit=<limit>]
>		[timelimit=<limit>]
>		[schemachecking=on|off]
>		[bindmethod=simple|sasl]
>		[binddn=<DN>]
>		[saslmech=<mech>]
>		[authcid=<identity>]
>		[authzid=<identity>]
>		[credentials=<passwd>]
>		[realm=<realm>]
>		[secprops=<properties>]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
557
558
559
560
561
562
>		[starttls=yes|critical]
>		[tls_cert=<file>]
>		[tls_key=<file>]
>		[tls_cacert=<file>]
>		[tls_cacertdir=<path>]
>		[tls_reqcert=never|allow|try|demand]
563
>		[tls_cipher_suite=<ciphers>]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
564
565
566
567
>		[tls_crlcheck=none|peer|all]
>		[logbase=<base DN>]
>		[logfilter=<filter str>]
>		[syncdata=default|accesslog|changelog]
568
569


570
571
This directive specifies the current database as a consumer of the
provider content by establishing the current {{slapd}}(8) as a
572
replication consumer site running a syncrepl replication engine.
573
574
575
The provider database is located at the provider site
specified by the {{EX:provider}} parameter. The consumer database is
kept up-to-date with the provider content using the LDAP Content
Howard Chu's avatar
Howard Chu committed
576
577
Synchronization protocol. See {{REF:RFC4533}}
for more information on the protocol.
578
579
580
581
582
583
584
585

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
586
containing the provider content as an LDAP URI. The {{EX:provider}}
587
588
589
590
591
592
parameter specifies a scheme, a host and optionally a port where the
provider slapd instance can be found. Either a domain name or IP
address may be used for <hostname>. Examples are
{{EX:ldap://provider.example.com:389}} or {{EX:ldaps://192.168.1.1:636}}.
If <port> is not given, the standard LDAP port number (389 or 636) is used.
Note that the syncrepl uses a consumer-initiated protocol, and hence its
593
specification is located on the consumer.
594

595
The content of the syncrepl consumer is defined using a search
596
597
598
599
600
specification as its result set. The consumer slapd will
send search requests to the provider slapd according to the search
specification. The search specification includes {{EX:searchbase}},
{{EX:scope}}, {{EX:filter}}, {{EX:attrs}}, {{EX:attrsonly}},
{{EX:sizelimit}}, and {{EX:timelimit}} parameters as in the normal
601
602
603
604
605
search specification. The {{EX:searchbase}} parameter has no
default value and must always be specified. The {{EX:scope}} defaults
to {{EX:sub}}, the {{EX:filter}} defaults to {{EX:(objectclass=*)}},
{{EX:attrs}} defaults to {{EX:"*,+"}} to replicate all user and operational
attributes, and {{EX:attrsonly}} is unset by default. Both {{EX:sizelimit}}
606
607
and {{EX:timelimit}} default to "unlimited", and only positive integers
or "unlimited" may be specified.
608

Kurt Zeilenga's avatar
Kurt Zeilenga committed
609
The {{TERM[expand]LDAP Sync}} protocol has two operation
610
611
612
613
614
615
616
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
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
Kurt Zeilenga's avatar
Kurt Zeilenga committed
617
remains persistent in the provider {{slapd}} instance. Further updates to the
618
provider will generate {{EX:searchResultEntry}} to the consumer slapd
619
620
621
622
as the search responses to the persistent synchronization search.

If an error occurs during replication, the consumer will attempt to reconnect
according to the retry parameter which is a list of the <retry interval>
623
and <# of retries> pairs. For example, retry="60 10 300 3" lets the consumer
624
625
626
627
628
629
630
retry every 60 seconds for the first 10 times and then retry every 300 seconds
for the next three times before stop retrying. + in <#  of retries> means
indefinite number of retries until success.

The schema checking can be enforced at the LDAP Sync consumer site
by turning on the {{EX:schemachecking}} parameter.
If it is turned on, every replicated entry will be checked for its
631
632
schema as the entry is stored on the consumer.
Every entry in the consumer should contain those attributes
633
634
635
636
637
638
639
required by the schema definition.
If it is turned off, entries will be stored without checking
schema conformance. The default is off.

The {{EX:binddn}} parameter gives the DN to bind as for the
syncrepl searches to the provider slapd. It should be a DN
which has read access to the replication content in the
640
provider database. 
641
642
643
644

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
Kurt Zeilenga's avatar
Kurt Zeilenga committed
645
to the provider {{slapd}} instance.
646
647
648

Simple authentication should not be used unless adequate data
integrity and confidentiality protections are in place (e.g. TLS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
649
or IPsec). Simple authentication requires specification of {{EX:binddn}}
650
651
652
653
654
655
656
657
658
659
660
661
662
and {{EX:credentials}} parameters.

SASL authentication is generally recommended.  SASL authentication
requires specification of a mechanism using the {{EX:saslmech}} parameter.
Depending on the mechanism, an authentication identity and/or
credentials can be specified using {{EX:authcid}} and {{EX:credentials}},
respectively.  The {{EX:authzid}} parameter may be used to specify
an authorization identity.

The {{EX:realm}} parameter specifies a realm which a certain
mechanisms authenticate the identity within. The {{EX:secprops}}
parameter specifies Cyrus SASL security properties.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
663
The {{EX:starttls}} parameter specifies use of the StartTLS extended
Kurt Zeilenga's avatar
Kurt Zeilenga committed
664
operation to establish a TLS session before authenticating to the provider.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
665
If the {{EX:critical}} argument is supplied, the session will be aborted
Kurt Zeilenga's avatar
Kurt Zeilenga committed
666
if the StartTLS request fails.  Otherwise the syncrepl session continues
667
668
without TLS.  The tls_reqcert setting defaults to {{EX:"demand"}} and the
other TLS settings default to the same as the main slapd TLS settings.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
669

Kurt Zeilenga's avatar
Kurt Zeilenga committed
670
671
672
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
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
673
{{EX:logbase}} and {{EX:logfilter}} parameters must be set appropriately
Kurt Zeilenga's avatar
Kurt Zeilenga committed
674
675
676
677
678
679
680
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.

681
682
The {{syncrepl}} replication mechanism is supported by the {{mdb}}
backend.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
683
684
685

See the {{SECT:LDAP Sync Replication}} chapter of this guide for
more information on how to use this directive.
686
687


Howard Chu's avatar
Howard Chu committed
688
689
690
691
692
693
694
695
696
697
698
H4: olcTimeLimit: <integer>

This directive specifies the maximum number of seconds (in real
time) slapd will spend answering a search request. If a
request is not finished in this time, a result indicating an
exceeded timelimit will be returned.

\Default:

>	olcTimeLimit: 3600

699
700
701
See the {{SECT:Limits}} section of this guide and slapd-config(5)
for more details.

Howard Chu's avatar
Howard Chu committed
702
703

H4: olcUpdateref: <URL>
704

705
706
This directive is only applicable in a {{replica}} (or {{shadow}})
{{slapd}}(8) instance. It
707
708
709
710
711
712
specifies the URL to return to clients which submit update
requests upon the replica.
If specified multiple times, each {{TERM:URL}} is provided.

\Example:

713
>	olcUpdateref:	ldap://provider.example.net
714
715


Howard Chu's avatar
Howard Chu committed
716
H4: Sample Entries
Howard Chu's avatar
Howard Chu committed
717
718
719

>dn: olcDatabase=frontend,cn=config
>objectClass: olcDatabaseConfig
Howard Chu's avatar
Howard Chu committed
720
>objectClass: olcFrontendConfig
Howard Chu's avatar
Howard Chu committed
721
722
>olcDatabase: frontend
>olcReadOnly: FALSE
Howard Chu's avatar
Howard Chu committed
723
724
725
726
727
728
>
>dn: olcDatabase=config,cn=config
>objectClass: olcDatabaseConfig
>olcDatabase: config
>olcRootDN: cn=Manager,dc=example,dc=com

Howard Chu's avatar
Howard Chu committed
729

730
H3: MDB Database Directives
731

732
733
Directives in this category apply to the {{TERM:MDB}}
database backend.
Howard Chu's avatar
Howard Chu committed
734
They are used in an olcDatabase entry in addition to the generic
735
database directives defined above.  For a complete reference
736
737
738
of MDB configuration directives, see {{slapd-mdb}}(5). In
addition to the {{EX:olcDatabaseConfig}} objectClass, MDB
database entries must have the {{EX:olcMdbConfig}} objectClass.
739
740


Howard Chu's avatar
Howard Chu committed
741
H4: olcDbDirectory: <directory>
742

743
This directive specifies the directory where the MDB files
744
745
746
747
containing the database and associated indices live.

\Default:

Howard Chu's avatar
Howard Chu committed
748
749
750
>	olcDbDirectory: /usr/local/var/openldap-data


751
H4: olcDbCheckpoint: <kbyte> <min>
752

753
754
755
This directive specifies the frequency for flushing the database disk
buffers. This directive is only needed if the {{olcDbNoSync}} option is
{{EX:TRUE}}.
756
The checkpoint will occur if either <kbyte> data has been written or
Gavin Henry's avatar
Gavin Henry committed
757
<min> minutes have passed since the last checkpoint. Both arguments default
758
759
to zero, in which case they are ignored. When the <min> argument is
non-zero, an internal task will run every <min> minutes to perform the
760
checkpoint. Note: currently the _kbyte_ setting is unimplemented.
761

762
\Example:
763

764
>	olcDbCheckpoint: 1024 10
765
766


767
H4: olcDbEnvFlags: {nosync,nometasync,writemap,mapasync,nordahead}
768

769
770
This option specifies flags for finer-grained control of  the  LMDB  library's
operation.
771

772
* {{F:nosync}}: This is exactly the same as the dbnosync directive.
773

774
775
776
777
778
* {{F:nometasync}}: Flush the data on a commit, but skip the sync of the meta
page. This mode is slightly faster than doing a full sync, but can
potentially lose the last committed transaction if the operating system
crashes. If both nometasync and nosync are set, the nosync flag takes
precedence.
779

780
781
782
* {{F:writemap}}: Use a writable memory map instead of just read-only. This
speeds up write operations but makes the database vulnerable to corruption in
case any bugs in slapd cause stray writes into the mmap region.
783

784
785
786
787
* {{F:mapasync}}: When using a writable memory map and performing flushes on
each commit, use an asynchronous flush instead of a synchronous flush (the
default). This option has no effect if writemap has not been set. It also has
no effect if nosync is set.
788

789
790
791
792
* {{F:nordahead}}: Turn off file readahead. Usually the OS performs readahead
on every read request. This usually boosts read performance but can be
harmful to random access read performance if the system's memory is full and
the DB is larger than RAM. This option is not implemented on Windows.
793
794


795
H4: olcDbIndex: {<attrlist> | default} [pres,eq,approx,sub,none]
796
797
798

This directive specifies the indices to maintain for the given
attribute. If only an {{EX:<attrlist>}} is given, the default
Howard Chu's avatar
Howard Chu committed
799
800
indices are maintained. The index keywords correspond to the
common types of matches that may be used in an LDAP search filter.
801
802
803

\Example:

804
805
806
807
>	olcDbIndex: default pres,eq
>	olcDbIndex: uid
>	olcDbIndex: cn,sn pres,eq,sub
>	olcDbIndex: objectClass eq
808
809
810
811
812
813
814
815
816

The first line sets the default set of indices to maintain to
present and equality.  The second line causes the default (pres,eq)
set of indices to be maintained for the {{EX:uid}} attribute type.
The third line causes present, equality, and substring indices to
be maintained for {{EX:cn}} and {{EX:sn}} attribute types.  The
fourth line causes an equality index for the {{EX:objectClass}}
attribute type.

Howard Chu's avatar
Howard Chu committed
817
818
819
820
821
There is no index keyword for inequality matches. Generally these
matches do not use an index. However, some attributes do support
indexing for inequality matches, based on the equality index.

A substring index can be more explicitly specified as {{EX:subinitial}},
822
{{EX:subany}}, or {{EX:subfinal}}, corresponding to the three
Howard Chu's avatar
Howard Chu committed
823
824
825
826
827
828
829
830
831
832
833
834
possible components
of a substring match filter. A subinitial index only indexes
substrings that appear at the beginning of an attribute value.
A subfinal index only indexes substrings that appear at the end
of an attribute value, while subany indexes substrings that occur
anywhere in a value.

Note that by default, setting an index for an attribute also
affects every subtype of that attribute. E.g., setting an equality
index on the {{EX:name}} attribute causes {{EX:cn}}, {{EX:sn}}, and every other
attribute that inherits from {{EX:name}} to be indexed.

835
836
837
By default, no indices are maintained.  It is generally advised
that minimally an equality index upon objectClass be maintained.

838
>	olcDbIndex: objectClass eq
839

Howard Chu's avatar
Howard Chu committed
840
841
842
843
844
845
846
847
Additional indices should be configured corresponding to the
most common searches that are used on the database.
Presence indexing should not be configured for an attribute
unless the attribute occurs very rarely in the database, and
presence searches on the attribute occur very frequently during
normal use of the directory. Most applications don't use presence
searches, so usually presence indexing is not very useful.

848
849
850
851
852
853
If this setting is changed while slapd is running, an internal task
will be run to generate the changed index data. All server operations
can continue as normal while the indexer does its work.  If slapd is
stopped before the index task completes, indexing will have to be
manually completed using the slapindex tool.

854

855
856
857
858
859
860
861
H4: olcDbMaxReaders: <integer>

This directive specifies the maximum number of threads that may have
concurrent read access to the database. Tools such as slapcat count as a
single thread, in addition to threads in any active slapd processes. The
default is 126.

862

863
864
865
866
867
868
869
870
871
872
H4: olcDbMaxSize: <bytes>

This directive specifies the maximum size of the database in bytes. A memory
map of this size is allocated at startup time and the database will not be
allowed to grow beyond this size. The default is 10485760 bytes (10MB). This
setting may be changed upward if the configured limit needs to be increased.

Note: It is important to set this to as large a value as possible, (relative
to anticipated growth of the actual data over time) since growing the size
later may not be practical when the system is under heavy load.
873

874

Gavin Henry's avatar
Gavin Henry committed
875
H4: olcDbMode: { <octal> | <symbolic> }
876
877

This directive specifies the file protection mode that newly
Gavin Henry's avatar
Gavin Henry committed
878
879
created database index files should have. This can be in the form
{{EX:0600}} or {{EX:-rw-------}}
880
881
882

\Default:

883
884
>	olcDbMode: 0600

885

886
887
888
889
890
891
892
893
894
895
896
897
H4: olcDbRtxnsize: <entries>

This directive specifies the maximum number of entries to process in a single
read transaction when executing a large search. Long-lived read transactions
prevent old database pages from being reused in write transactions, and so
can cause significant growth of the database file when there is heavy write
traffic. This setting causes the read transaction in large searches to be
released and reacquired after the given number of entries has been read, to
give writers the opportunity to reclaim old database pages. The default is
10000.


898
899
900
H4: olcDbSearchStack: <integer>

Specify the depth of the stack used for search filter evaluation.
Gavin Henry's avatar
Gavin Henry committed
901
Search filters are evaluated on a stack to accommodate nested {{EX:AND}} /
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
{{EX:OR}} clauses. An individual stack is allocated for each server thread.
The depth of the stack determines how complex a filter can be evaluated
without requiring any additional memory allocation. Filters that are
nested deeper than the search stack depth will cause a separate stack to
be allocated for that particular search operation. These separate allocations
can have a major negative impact on server performance, but specifying
too much stack will also consume a great deal of memory. Each search
uses 512K bytes per level on a 32-bit machine, or 1024K bytes per level
on a 64-bit machine. The default stack depth is 16, thus 8MB or 16MB
per thread is used on 32 and 64 bit machines, respectively. Also the
512KB size of a single stack slot is set by a compile-time constant which
may be changed if needed; the code must be recompiled for the change
to take effect.

\Default:

>	olcDbSearchStack: 16


921
H4: olcDbNosync: { TRUE | FALSE }
922

923
924
925
This directive causes on-disk database contents to not be immediately
synchronized with in memory changes upon change.  Setting this option
to {{EX:TRUE}} may improve performance at the expense of data integrity.
926
927
928
929


H4: Sample Entry

930
>dn: olcDatabase=mdb,cn=config
931
>objectClass: olcDatabaseConfig
932
933
>objectClass: olcMdbConfig
>olcDatabase: mdb
934
>olcSuffix: dc=example,dc=com
935
936
>olcDbDirectory: /usr/local/var/openldap-data
>olcDbIndex: objectClass eq
937
938
939
940
941
942


H2: Configuration Example

The following is an example configuration, interspersed
with explanatory text. It defines two databases to handle
943
different parts of the {{TERM:X.500}} tree; both are {{TERM:MDB}}
944
945
946
947
948
949
950
951
952
database instances. The line numbers shown are provided for
reference only and are not included in the actual file. First, the
global configuration section:

E:  1.    # example config file - global configuration entry
E:  2.    dn: cn=config
E:  3.    objectClass: olcGlobal
E:  4.    cn: config
E:  5.    olcReferral: ldap://root.openldap.org
953
E:  6.
954
955
956
957
958
959
960
961
962
963
964
965
966

Line 1 is a comment. Lines 2-4 identify this as the global
configuration entry.
The {{EX:olcReferral:}} directive on line 5
means that queries not local to one of the databases defined
below will be referred to the LDAP server running on the
standard port (389) at the host {{EX:root.openldap.org}}.
Line 6 is a blank line, indicating the end of this entry.

E:  7.    # internal schema
E:  8.    dn: cn=schema,cn=config
E:  9.    objectClass: olcSchemaConfig
E: 10.    cn: schema
967
E: 11.
968
969
970
971
972
973
974
975

Line 7 is a comment. Lines 8-10 identify this as the root of
the schema subtree. The actual schema definitions in this entry
are hardcoded into slapd so no additional attributes are specified here.
Line 11 is a blank line, indicating the end of this entry.

E: 12.    # include the core schema
E: 13.    include: file:///usr/local/etc/openldap/schema/core.ldif
976
E: 14.
977
978
979
980
981
982
983
984
985
986
987
988
989
990

Line 12 is a comment. Line 13 is an LDIF include directive which
accesses the {{core}} schema definitions in LDIF format. Line 14
is a blank line.

Next comes the database definitions. The first database is the
special {{EX:frontend}} database whose settings are applied globally
to all the other databases.

E: 15.    # global database parameters
E: 16.    dn: olcDatabase=frontend,cn=config
E: 17.    objectClass: olcDatabaseConfig
E: 18.    olcDatabase: frontend
E: 19.    olcAccess: to * by * read
991
E: 20.
992
993
994
995

Line 15 is a comment. Lines 16-18 identify this entry as the global
database entry. Line 19 is a global access control. It applies to all
entries (after any applicable database-specific access controls).
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
Line 20 is a blank line.

The next entry defines the config backend.

E: 21.    # set a rootpw for the config database so we can bind.
E: 22.    # deny access to everyone else.
E: 23.    dn: olcDatabase=config,cn=config
E: 24.    objectClass: olcDatabaseConfig
E: 25.    olcDatabase: config
E: 26.    olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
E: 27.    olcAccess: to * by * none
E: 28.

Lines 21-22 are comments. Lines 23-25 identify this entry as the config
database entry. Line 26 defines the {{super-user}} password for this
database. (The DN defaults to {{"cn=config"}}.) Line 27 denies all access
to this database, so only the super-user will be able to access it. (This
is already the default access on the config database. It is just listed
here for illustration, and to reiterate that unless a means to authenticate
as the super-user is explicitly configured, the config database will be
inaccessible.)

Line 28 is a blank line.
1019

1020
The next entry defines an MDB backend that will handle queries for things
1021
1022
1023
1024
in the "dc=example,dc=com" portion of the tree. Indices are to be maintained
for several attributes, and the {{EX:userPassword}} attribute is to be
protected from unauthorized access.

1025
1026
E: 29.    # MDB definition for example.com
E: 30.    dn: olcDatabase=mdb,cn=config
1027
E: 31.    objectClass: olcDatabaseConfig
1028
1029
E: 32.    objectClass: olcMdbConfig
E: 33.    olcDatabase: mdb
Howard Chu's avatar
Howard Chu committed
1030
E: 34.    olcSuffix: dc=example,dc=com
1031
E: 35.    olcDbDirectory: /usr/local/var/openldap-data
Howard Chu's avatar
Howard Chu committed
1032
E: 36.    olcRootDN: cn=Manager,dc=example,dc=com
1033
1034
E: 37.    olcRootPW: secret
E: 38.    olcDbIndex: uid pres,eq
Howard Chu's avatar
Howard Chu committed
1035
E: 39.    olcDbIndex: cn,sn pres,eq,approx,sub
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
E: 40.    olcDbIndex: objectClass eq
E: 41.    olcAccess: to attrs=userPassword
E: 42.      by self write
E: 43.      by anonymous auth
E: 44.      by dn.base="cn=Admin,dc=example,dc=com" write
E: 45.      by * none
E: 46.    olcAccess: to *
E: 47.      by self write
E: 48.      by dn.base="cn=Admin,dc=example,dc=com" write
E: 49.      by * read
1046
E: 50.
1047

1048
Line 29 is a comment. Lines 30-33 identify this entry as a MDB database
1049
1050
configuration entry.  Line 34 specifies the DN suffix
for queries to pass to this database. Line 35 specifies the directory
1051
1052
in which the database files will live.

1053
Lines 36 and 37 identify the database {{super-user}} entry and associated
1054
1055
1056
password. This entry is not subject to access control or size or
time limit restrictions.

1057
Lines 38 through 40 indicate the indices to maintain for various
1058
1059
attributes.

1060
Lines 41 through 49 specify access control for entries in this
1061
1062
1063
1064
1065
1066
database. For all applicable entries, the {{EX:userPassword}} attribute is writable
by the entry itself and by the "admin" entry.  It may be used for
authentication/authorization purposes, but is otherwise not readable.
All other attributes are writable by the entry and the "admin"
entry, but may be read by all users (authenticated or not).

1067
Line 50 is a blank line, indicating the end of this entry.
1068

1069
The next entry defines another
1070
MDB database. This one handles queries involving the
1071
{{EX:dc=example,dc=net}} subtree but is managed by the same entity
1072
as the first database.  Note that without line 60, the read access
1073
1074
would be allowed due to the global access rule at line 19.

1075
1076
E: 51.    # MDB definition for example.net
E: 52.    dn: olcDatabase=mdb,cn=config
1077
E: 53.    objectClass: olcDatabaseConfig
1078
1079
E: 54.    objectClass: olcMdbConfig
E: 55.    olcDatabase: mdb
1080
E: 56.    olcSuffix: dc=example,dc=net
1081
E: 57.    olcDbDirectory: /usr/local/var/openldap-data-net
1082
E: 58.    olcRootDN: cn=Manager,dc=example,dc=com
1083
1084
E: 59.    olcDbIndex: objectClass eq
E: 60.    olcAccess: to * by users read
1085
1086
1087
1088


H2: Converting old style {{slapd.conf}}(5) file to {{cn=config}} format

1089
Before converting to the {{cn=config}} format you should make sure that the
Howard Chu's avatar
Howard Chu committed
1090
1091
1092
1093
1094
1095
config backend is properly configured in your existing config file. While
the config backend is always present inside slapd, by default it is only
accessible by its rootDN, and there are no default credentials assigned
so unless you explicitly configure a means to authenticate to it, it will be
unusable.

1096
1097
1098
1099
If you do not already have a {{EX:database config}} section, add something
like this to the end of {{EX:slapd.conf}}

> database config
Howard Chu's avatar
Howard Chu committed
1100
1101
1102
1103
1104
1105
1106
> rootpw VerySecret

Note: Since the config backend can be used to load arbitrary code into the
slapd process, it is extremely important to carefully guard whatever
credentials are used to access it. Since simple passwords are vulnerable to
password guessing attacks, it is usually better to omit the rootpw and only
use SASL authentication for the config rootDN.
1107

1108
1109
1110
1111
1112
An existing {{slapd.conf}}(5) file can be converted to the new format using
{{slaptest}}(8) or any of the slap tools:

>	slaptest -f /usr/local/etc/openldap/slapd.conf -F /usr/local/etc/openldap/slapd.d

Howard Chu's avatar
Howard Chu committed
1113
1114
Test that you can access entries under {{EX:cn=config}} using the
default {{rootdn}} and the {{rootpw}} configured above:
1115

Howard Chu's avatar
Howard Chu committed
1116
>	ldapsearch -x -D cn=config -w VerySecret -b cn=config
1117

1118
You can then discard the old {{slapd.conf}}(5) file. Make sure to launch
Howard Chu's avatar
Howard Chu committed
1119
1120
{{slapd}}(8) with the {{-F}} option to specify the configuration directory
if you are not using the default directory path.
1121
1122
1123
1124

Note: When converting from the slapd.conf format to slapd.d format, any
included files will also be integrated into the resulting configuration
database.