X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fguide%2Fadmin%2Fslapdconf2.sdf;h=4db17e6d77554d4e3793811f3fd48136cfbfd444;hb=488cf455996e435e5dd362bc575446ce4134435d;hp=9c0d49bb0e05cd4ee168ede5c028c3c568a89370;hpb=76556ab6932506ebdc5942552737648c940d4b87;p=openldap diff --git a/doc/guide/admin/slapdconf2.sdf b/doc/guide/admin/slapdconf2.sdf index 9c0d49bb0e..4db17e6d77 100644 --- a/doc/guide/admin/slapdconf2.sdf +++ b/doc/guide/admin/slapdconf2.sdf @@ -25,6 +25,10 @@ command-line option to {{slapd}}(8) or {{slurpd}}(8). This chapter 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. + Note: the current version of {{slurpd}} has not been updated for compatibility with this new configuration engine. If you must use slurpd for replication at your site, you will have to maintain an @@ -67,9 +71,9 @@ loaded from config files or added at runtime. The usual rules for LDIF files apply to the configuration information: Comment lines beginning with a '{{EX:#}}' character -are ignored. If a line begins with white space, it is considered a +are ignored. If a line begins with a single space, it is considered a continuation of the previous line (even if the previous line is a -comment). Entries are separated by blank lines. +comment) and the single leading space is removed. Entries are separated by blank lines. The general layout of the config LDIF is as follows: @@ -128,9 +132,7 @@ prefix attached. A configuration directive may take arguments. If so, the arguments are separated by white space. If an argument contains white space, -the argument should be enclosed in double quotes {{EX:"like this"}}. If -an argument contains a double quote or a backslash character `{{EX:\}}', -the character should be preceded by a backslash character `{{EX:\}}'. +the argument should be enclosed in double quotes {{EX:"like this"}}. In the descriptions that follow, arguments that should be replaced by actual text are shown in brackets {{EX:<>}}. @@ -345,13 +347,13 @@ H4: Sample Entries >objectClass: olcSchemaConfig >cn: test >olcAttributeTypes: ( 1.1.1 -> NAME 'testAttr' -> EQUALITY integerMatch -> SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 ) +> NAME 'testAttr' +> EQUALITY integerMatch +> SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 ) >olcAttributeTypes: ( 1.1.2 NAME 'testTwo' EQUALITY caseIgnoreMatch -> SUBSTR caseIgnoreSubstringsMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.44 ) +> SUBSTR caseIgnoreSubstringsMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.44 ) >olcObjectClasses: ( 1.1.3 NAME 'testObject' -> MAY ( testAttr $ testTwo ) AUXILIARY ) +> MAY ( testAttr $ testTwo ) AUXILIARY ) H3: Backend-specific Directives @@ -371,7 +373,9 @@ supported backend types listed in Table 5.2. title="Table 5.2: Database Backends" Types Description bdb Berkeley DB transactional backend +config Slapd configuration backend dnssrv DNS SRV backend +hdb Hierarchical variant of bdb backend ldap Lightweight Directory Access Protocol (Proxy) backend ldbm Lightweight DBM backend ldif Lightweight Data Interchange Format backend @@ -387,9 +391,10 @@ sql SQL Programmable backend > olcBackend: bdb -There are no other directives defined for this entry, so generally -it will not be needed. However, specific backend types may define -additional attributes for their particular use. +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. H4: Sample Entry @@ -417,6 +422,11 @@ database-level options that should be applied to all the other databases. Subsequent database definitions may also override some frontend settings. +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. + \Example: > olcDatabase: bdb @@ -761,12 +771,19 @@ If specified multiple times, each {{TERM:URL}} is provided. > olcUpdateref: ldap://master.example.net -H4: Sample Entry +H4: Sample Entries >dn: olcDatabase=frontend,cn=config >objectClass: olcDatabaseConfig +>objectClass: olcFrontendConfig >olcDatabase: frontend >olcReadOnly: FALSE +> +>dn: olcDatabase=config,cn=config +>objectClass: olcDatabaseConfig +>olcDatabase: config +>olcRootDN: cn=Manager,dc=example,dc=com + H3: BDB and HDB Database Directives @@ -774,9 +791,10 @@ Directives in this category apply to both the {{TERM:BDB}} and the {{TERM:HDB}} database. They are used in an olcDatabase entry in addition to the generic database directives defined above. For a complete reference -of BDB/HDB configuration directives, see {{slapd-bdb}}(5). BDB and -HDB database entries must have the {{EX:olcBdbConfig}} objectClass in -addition to the {{EX:olcDatabaseConfig}} class. +of BDB/HDB configuration directives, see {{slapd-bdb}}(5). In +addition to the {{EX:olcDatabaseConfig}} objectClass, BDB and HDB +database entries must have the {{EX:olcBdbConfig}} and +{{EX:olcHdbConfig}} objectClass, respectively. H4: olcDbDirectory: @@ -970,7 +988,7 @@ H4: Sample Entry >dn: olcDatabase=hdb,cn=config >objectClass: olcDatabaseConfig ->objectClass: olcBdbConfig +>objectClass: olcHdbConfig >olcDatabase: hdb >olcSuffix: "dc=example,dc=com" >olcDbDirectory: /usr/local/var/openldap-data