git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-translucent.5

   1 .TH SLAPO-TRANSLUCENT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2004-2007 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo-translucent \- Translucent Proxy overlay
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The Translucent Proxy overlay can be used with a backend database such as
  11 .BR slapd-bdb (5)
  12 to create a "translucent proxy".  Entries retrieved from a remote LDAP
  13 server may have some or all attributes overridden, or new attributes
  14 added, by entries in the local database before being presented to the
  15 client.
  16 .LP
  17 A
  18 .BR search
  19 operation is first populated with entries from the remote LDAP server, the
  20 attributes of which are then overridden with any attributes defined in the
  21 local database. Local overrides may be populated with the
  22 .BR add ,
  23 .B modify ,
  24 and
  25 .B modrdn
  26 operations, the use of which is restricted to the root user.
  27 .LP
  28 A
  29 .BR compare
  30 operation will perform a comparison with attributes defined in the local
  31 database record (if any) before any comparison is made with data in the
  32 remote database.
  33 .SH CONFIGURATION
  34 The Translucent Proxy overlay uses a remote LDAP server which is configured
  35 with the options shown in
  36 .BR slapd-ldap (5).
  37 These
  38 .B slapd.conf
  39 options are specific to the Translucent Proxy overlay; they may appear anywhere
  40 after the
  41 .B overlay
  42 directive and before any subsequent
  43 .B database
  44 directive.
  45 .TP
  46 .B translucent_strict
  47 By default, attempts to delete attributes in either the local or remote
  48 databases will be silently ignored. The
  49 .B translucent_strict
  50 directive causes these modifications to fail with a Constraint Violation.
  51 .TP
  52 .B translucent_no_glue
  53 This configuration option disables the automatic creation of "glue" records
  54 for an
  55 .B add
  56 or
  57 .B modrdn
  58 operation, such that all parents of an entry added to the local database
  59 must be created by hand. Glue records are always created for a
  60 .B modify
  61 operation.
  62 .SH CAVEATS
  63 .LP
  64 The Translucent Proxy overlay will disable schema checking in the local database,
  65 so that an entry consisting of overlay attributes need not adhere to the
  66 complete schema.
  67 .LP
  68 Because the translucent overlay does not perform any DN rewrites,  the local
  69 and remote database instances must have the same suffix.  Other configurations
  70 will probably fail with No Such Object and other errors.
  71 .SH FILES
  72 .TP
  73 ETCDIR/slapd.conf
  74 default slapd configuration file
  75 .SH SEE ALSO
  76 .BR slapd.conf (5),
  77 .BR slapd-ldap (5).