~ubuntu-branches/ubuntu/trusty/openldap/trusty-updates

« back to all changes in this revision

Viewing changes to doc/guide/admin/slapdconf2.sdf

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-01-23 10:01:13 UTC
  • mfrom: (1.3.4)
  • mto: This revision was merged to the branch mainline in revision 47.
  • Revision ID: package-import@ubuntu.com-20120123100113-z3mg83hvuplv9lyj
Tags: upstream-2.4.28
ImportĀ upstreamĀ versionĀ 2.4.28

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# $OpenLDAP: pkg/openldap-guide/admin/slapdconf2.sdf,v 1.20.2.23 2011/03/24 01:35:20 quanah Exp $
 
1
# $OpenLDAP$
2
2
# Copyright 2005-2011 The OpenLDAP Foundation, All Rights Reserved.
3
3
# COPYING RESTRICTIONS APPLY, see COPYRIGHT.
4
4
 
7
7
Once the software has been built and installed, you are ready
8
8
to configure {{slapd}}(8) for use at your site.
9
9
 
10
 
Unlike previous
11
 
OpenLDAP releases, the slapd(8) runtime configuration in 2.3 (and later)
12
 
is fully LDAP-enabled and can be managed using the standard LDAP
13
 
operations with data in {{TERM:LDIF}}. The LDAP configuration engine
14
 
allows all of slapd's configuration options to be changed on the fly,
 
10
OpenLDAP 2.3 and later have transitioned to using a dynamic runtime
 
11
configuration engine, {{slapd-config}}(5).  {{slapd-config}}(5)
 
12
* is fully LDAP-enabled
 
13
* is managed using the standard LDAP operations
 
14
* stores its configuration data in an {{TERM:LDIF}} database, generally
 
15
in the {{F:/usr/local/etc/openldap/slapd.d}} directory.
 
16
* allows all of slapd's configuration options to be changed on the fly,
15
17
generally without requiring a server restart for the changes
16
18
to take effect.
17
19
 
18
 
The old style {{slapd.conf}}(5) file is still
19
 
supported, but must be converted to the new {{slapd-config}}(5) format
20
 
to allow runtime changes to be saved. While the old style
21
 
configuration uses a single file, normally installed as
22
 
{{F:/usr/local/etc/openldap/slapd.conf}}, the new style
23
 
uses a slapd backend database to store the configuration. The
24
 
configuration database normally resides in the
25
 
{{F:/usr/local/etc/openldap/slapd.d}} directory. An alternate configuration
26
 
directory (or file) can be specified via a command-line option to
27
 
{{slapd}}(8).
28
 
 
29
 
This chapter
30
 
describes the general format of the configuration system, followed by
31
 
a detailed description of commonly used config settings.
32
 
 
33
 
Note: some of the backends 
34
 
do not support runtime configuration yet.  In those cases,
35
 
the old style {{slapd.conf}}(5) file must be used.
 
20
This chapter describes the general format of the {{slapd-config}}(5)
 
21
configuration system, followed by a detailed description of commonly used
 
22
settings.
 
23
 
 
24
The older style {{slapd.conf}}(5) file is still supported, but its use
 
25
is deprecated and support for it will be withdrawn in a future OpenLDAP
 
26
release.  Configuring {{slapd}}(8) via {{slapd.conf}}(5) is described in
 
27
the next chapter.
 
28
 
 
29
Refer to {{slapd}}(8) for information on how to have slapd automatically
 
30
convert from {{slapd.conf}}(5) to {{slapd-config}}(5).
 
31
 
 
32
 
 
33
Note: Although the {{slapd-config}}(5) system stores its configuration
 
34
as (text-based) LDIF files, you should {{1:never}} edit any of
 
35
the LDIF files directly.  Configuration changes should be performed via LDAP
 
36
operations, e.g. {{ldapadd}}(1), {{ldapdelete}}(1), or {{ldapmodify}}(1).
 
37
 
 
38
 
 
39
Note: You will need to continue to use the older {{slapd.conf}}(5)
 
40
configuration system if your OpenLDAP installation requires the use of one
 
41
or more backends or overlays that have not been updated to use the
 
42
{{slapd-config}}(5) system.  As of OpenLDAP 2.4.25, the only official backends
 
43
that have not yet been updated to use {{slapd-config}}(5) are {{slapd-meta}}(5)
 
44
and {{slapd-sql}}(5).  There may be additional contributed or experimental
 
45
overlays that also have not been updated.
36
46
 
37
47
 
38
48
H2: Configuration Layout