external/bsd/openldap/man/slapd.backends.5

   1 .TH SLAPD.BACKENDS 5 "2008/07/16" "OpenLDAP 2.4.11"
   2 .\" Copyright 2006-2008 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP: pkg/ldap/doc/man/man5/slapd.backends.5,v 1.3.2.3 2008/02/11 23:26:40 kurt Exp $
   5 .SH NAME
   6 slapd.backends \- backends for slapd, the stand-alone LDAP daemon
   7 .SH DESCRIPTION
   8 The
   9 .BR slapd (8)
  10 daemon can use a variety of different backends for serving LDAP requests.
  11 Backends may be compiled statically into slapd, or when module support
  12 is enabled, they may be dynamically loaded. Multiple instances of a
  13 backend can be configured, to serve separate databases from the same
  14 slapd server.
  15
  16
  17 Configuration options for each backend are documented separately in the
  18 corresponding
  19 .BR slapd-<backend> (5)
  20 manual pages.
  21 .TP
  22 .B bdb
  23 This is the recommended primary backend for a normal slapd database.
  24 It takes care to configure it properly.
  25 It uses the transactional database interface of the Oracle Berkeley
  26 DB (BDB) package to store data.
  27 .TP
  28 .B config
  29 This backend is used to manage the configuration of slapd at run-time.
  30 Unlike other backends, only a single instance of the
  31 .B config
  32 backend may be defined. It also instantiates itself automatically,
  33 so it is always present even if not explicitly defined in the
  34 .BR slapd.conf (5)
  35 file.
  36 .TP
  37 .B dnssrv
  38 This backend is experimental.
  39 It serves up referrals based upon SRV resource records held in the
  40 Domain Name System.
  41 .TP
  42 .B hdb
  43 This is a variant of the
  44 .B bdb
  45 backend that uses a hierarchical database
  46 layout. This layout stores entry DNs more efficiently than the
  47 .B bdb
  48 backend,
  49 using less space and requiring less work to create, delete, and rename
  50 entries. It is also one of the few backends to support subtree renames.
  51 .TP
  52 .B ldap
  53 This backend acts as a proxy to forward incoming requests to another
  54 LDAP server.
  55 .TP
  56 .B ldif
  57 This database uses the filesystem to build the tree structure
  58 of the database, using plain ascii files to store data.
  59 Its usage should be limited to very simple databases, where performance
  60 is not a requirement. This backend also supports subtree renames.
  61 .TP
  62 .B meta
  63 This backend performs basic LDAP proxying with respect to a set of
  64 remote LDAP servers. It is an enhancement of the
  65 .B ldap
  66 backend.
  67 .TP
  68 .B monitor
  69 This backend provides information about the running status of the slapd
  70 daemon. Only a single instance of the
  71 .B monitor
  72 backend may be defined.
  73 .TP
  74 .B null
  75 Operations in this backend succeed but do nothing.
  76 .TP
  77 .B passwd
  78 This backend is provided for demonstration purposes only.
  79 It serves up user account information from the system
  80 .BR passwd (5)
  81 file.
  82 .TP
  83 .B perl
  84 This backend embeds a
  85 .BR perl (1)
  86 interpreter into slapd.
  87 It runs Perl subroutines to implement LDAP operations.
  88 .TP
  89 .B relay
  90 This backend is experimental.
  91 It redirects LDAP operations to another database
  92 in the same server, based on the naming context of the request.
  93 Its use requires the
  94 .B rwm
  95 overlay (see
  96 .BR slapo-rwm (5)
  97 for details) to rewrite the naming context of the request.
  98 It is primarily intended to implement virtual views on databases
  99 that actually store data.
 100 .TP
 101 .B shell
 102 This backend executes external programs to implement LDAP operations.
 103 It is primarily intended to be used in prototypes.
 104 .TP
 105 .B sql
 106 This backend is experimental.
 107 It services LDAP requests from an SQL database.
 108 .SH FILES
 109 .TP
 110 /etc/openldap/slapd.conf
 111 default slapd configuration file
 112 .TP
 113 /etc/openldap/slapd.d
 114 default slapd configuration directory
 115 .SH SEE ALSO
 116 .BR ldap (3),
 117 .BR slapd\-bdb (5),
 118 .BR slapd\-config (5),
 119 .BR slapd\-dnssrv (5),
 120 .BR slapd\-hdb (5),
 121 .BR slapd\-ldap (5),
 122 .BR slapd\-ldif (5),
 123 .BR slapd\-meta (5),
 124 .BR slapd\-monitor (5),
 125 .BR slapd\-null (5),
 126 .BR slapd\-passwd (5),
 127 .BR slapd\-perl (5),
 128 .BR slapd\-relay (5),
 129 .BR slapd\-shell (5),
 130 .BR slapd\-sql (5),
 131 .BR slapd.conf (5),
 132 .BR slapd.overlays (5),
 133 .BR slapd (8).
 134 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 135 .SH ACKNOWLEDGEMENTS
 136 .\" Shared Project Acknowledgement Text
 137 .B "OpenLDAP Software"
 138 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
 139 .B "OpenLDAP Software"
 140 is derived from University of Michigan LDAP 3.3 Release.