diff --git a/CHANGES b/CHANGES index 8734e9bd89f7551f72cb5446139ba6645a4f4ce6..ca3c9bb601647ab726de6990e09dcfb4a3c19a02 100644 --- a/CHANGES +++ b/CHANGES @@ -44,6 +44,7 @@ OpenLDAP 2.4.17 Engineering Documentation admin24 fixed example regex (ITS#6052) admin24 removed temporary back-monitor note (ITS#6130) + admin24 slapd.conf to cn=config conversion process (ITS#6060) man page consistency fixes (ITS#6023) ldapsearch(1) output format description (ITS#6146) ldap.conf(5) improve sizelimit/timelimit limits (ITS#6127) diff --git a/doc/guide/admin/access-control.sdf b/doc/guide/admin/access-control.sdf index 610467e71b317a87556a6b4c29834fad713dee61..9de4b1c0f266df16e41f3d8c62f802f11297518a 100644 --- a/doc/guide/admin/access-control.sdf +++ b/doc/guide/admin/access-control.sdf @@ -988,7 +988,7 @@ E: 52. olcAccess: to * by users read H3: Converting from {{slapd.conf}}(5) to a {{B:cn=config}} directory format -Discuss slap* -f slapd.conf -F slapd.d/ (man slapd-config) +See the related section in {{SECT:Configuring slapd}}. H2: Access Control Common Examples diff --git a/doc/guide/admin/slapdconf2.sdf b/doc/guide/admin/slapdconf2.sdf index 292026cb29729bde48741f431c4637f6d12f8617..cbf4df4aaad1ed51b0f2e283ac2da81e81c4c488 100644 --- a/doc/guide/admin/slapdconf2.sdf +++ b/doc/guide/admin/slapdconf2.sdf @@ -5,34 +5,51 @@ H1: Configuring slapd Once the software has been built and installed, you are ready -to configure {{slapd}}(8) for use at your site. Unlike previous +to configure {{slapd}}(8) for use at your site. + +Unlike previous OpenLDAP releases, the slapd(8) runtime configuration in 2.3 (and later) is fully LDAP-enabled and can be managed using the standard LDAP operations with data in {{TERM:LDIF}}. The LDAP configuration engine allows all of slapd's configuration options to be changed on the fly, generally without requiring a server restart for the changes -to take effect. The old style {{slapd.conf}}(5) file is still +to take effect. + +The old style {{slapd.conf}}(5) file is still supported, but must be converted to the new {{slapd-config}}(5) format to allow runtime changes to be saved. While the old style configuration uses a single file, normally installed as {{F:/usr/local/etc/openldap/slapd.conf}}, the new style uses a slapd backend database to store the configuration. The configuration database normally resides in the -{{F:/usr/local/etc/openldap/slapd.d}} directory. When -converting from the slapd.conf format to slapd.d format, any -include files will also be integrated into the resulting configuration -database. +{{F:/usr/local/etc/openldap/slapd.d}} directory. An alternate configuration +directory (or file) can be specified via a command-line option to +{{slapd}}(8). -An alternate configuration directory (or file) can be specified via -a command-line option to {{slapd}}(8). This chapter describes the -general format of the configuration system, followed by a detailed -description of commonly used config settings. +This chapter briefly discusses converting to the new style configuration, +then describes the general format of the configuration system, followed by +a detailed description of commonly used config settings. Note: some of the backends and of the distributed overlays do not support runtime configuration yet. In those cases, the old style {{slapd.conf}}(5) file must be used. +H2: Converting old style {{slapd.conf}}(5) file to {{cn=config}} format + +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 + +You can then discard the old {{slapd.conf}}(5) file. Make sure to launch +{{slapd}}(8) with the {{-F}} option to specify the configuration directory. + +Note: When converting from the slapd.conf format to slapd.d format, any +included files will also be integrated into the resulting configuration +database. + + H2: Configuration Layout The slapd configuration is stored as a special LDAP directory with