1SLAPD.PLUGIN(5) File Formats Manual SLAPD.PLUGIN(5)
2
6 slapd.plugin - plugin configuration for slapd, the stand-alone LDAP
7 daemon
8
10 /etc/openldap/slapd.conf
11
13 The slapd.conf(5) file contains configuration information for the
14 slapd(8) daemon. This configuration file is also used by the SLAPD
15 tools slapadd(8), slapcat(8), and slapindex(8).
16 The slapd.conf file consists of a series of global configuration op‐
18 tions that apply to slapd as a whole (including all backends), followed
19 by zero or more database backend definitions that contain information
20 specific to a backend instance.
21 The general format of slapd.conf is as follows:
23 # comment - these options apply to every database
25 <global configuration options>
26 # first database definition & configuration options
27 database <backend 1 type>
28 <configuration options specific to backend 1>
29 # subsequent database definitions & configuration options
30 ...
31 If slapd is compiled with --enable-slapi, support for plugins according
33 to Netscape's Directory Server Plug-Ins. Version 4 of the API is cur‐
34 rently implemented, with some extensions from version 5.
35 Both global and database specific data may contain plugin information.
37 Plugins associated with a specific database are called before global
38 plugins. This manpage details the slapd(8) configuration statements
39 that affect the loading of SLAPI plugins.
40 Arguments that should be replaced by actual text are shown in brackets
42 <>.
43 The structure of the plugin directives is
45 plugin <type> <lib_path> <init_function> [<arguments>]
47 Load a plugin of the specified type for the current database.
48 The <type> can be one of preoperation, that is executed before process‐
50 ing the operation for the specified database, postoperation, that is
51 executed after the operation for the specified database has been pro‐
52 cessed, extendedop, that is used when executing an extended operation,
53 or object. The latter is used for miscellaneous types such as ACL,
54 computed attribute and search filter rewriter plugins.
55 The <libpath> argument specifies the path to the plugin loadable ob‐
57 ject; if a relative path is given, the object is looked for according
58 to the underlying dynamic loading package (libtool's ltdl is used).
59 The <init_function> argument specifies what symbol must be called when
61 the plugin is first loaded. This function should register the func‐
62 tions provided by the plugin for the desired operations. It should be
63 noted that it is this init function, not the plugin type specified as
64 the first argument, that determines when and for what operations the
65 plugin will be invoked. The optional <arguments> list is passed to the
66 init function.
67 pluginlog <file>
69 Specify an alternative path for the plugin log file (default is
70 /var/errors).
71 modulepath <pathspec>
73 This statement sets the module load path for dynamically load‐
74 able backends, as described in slapd.conf(5); however, since
75 both the dynamically loadable backends and the SLAPI plugins use
76 the same underlying library (libtool's ltdl) its value also af‐
77 fects the plugin search path. In general the search path is
78 made of colon-separated paths; usually the user-defined path is
79 searched first; then the value of the LTDL_LIBRARY_PATH environ‐
80 ment variable, if defined, is used; finally, the system-specific
81 dynamic load path is attempted (e.g. on Linux the value of the
82 environment variable LD_LIBRARY_PATH). Please carefully read
83 the documentation of ltdl because its behavior is very platform
84 dependent.
85
87 /etc/openldap/slapd.conf
88 default slapd configuration file
89 /var/errors
91 default plugin log file
92
94 slapd(8),
95 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
97
99 OpenLDAP Software is developed and maintained by The OpenLDAP Project
100 <http://www.openldap.org/>. OpenLDAP Software is derived from the Uni‐
101 versity of Michigan LDAP 3.3 Release.
102OpenLDAP 2.4.57 2021/01/18 SLAPD.PLUGIN(5)