← Back to branch summary

~ttx/openldap/lucid-gssapi-495418

« back to all changes in this revision

Viewing changes to doc/man/man5/slapo-translucent.5

  • Committer: Bazaar Package Importer
  • Author(s): Mathias Gug
  • Date: 2008-07-10 14:45:49 UTC
  • Revision ID: james.westby@ubuntu.com-20080710144549-wck73med0e72gfyo
Tags: upstream-2.4.10
Import upstream version 2.4.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man5/slapo-translucent.5
 
1
.TH SLAPO-TRANSLUCENT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 
2
.\" Copyright 2004-2008 The OpenLDAP Foundation All Rights Reserved.
 
3
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 
4
.\" $OpenLDAP: pkg/ldap/doc/man/man5/slapo-translucent.5,v 1.4.2.4 2008/02/11 23:26:40 kurt Exp $
 
5
.SH NAME
 
6
slapo-translucent \- Translucent Proxy overlay to slapd
 
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 must appear 
 
40
after the
 
41
.B overlay
 
42
directive.
 
43
.TP
 
44
.B translucent_strict
 
45
By default, attempts to delete attributes in either the local or remote
 
46
databases will be silently ignored. The
 
47
.B translucent_strict
 
48
directive causes these modifications to fail with a Constraint Violation.
 
49
.TP
 
50
.B translucent_no_glue
 
51
This configuration option disables the automatic creation of "glue" records
 
52
for an
 
53
.B add
 
54
or
 
55
.B modrdn
 
56
operation, such that all parents of an entry added to the local database
 
57
must be created by hand. Glue records are always created for a
 
58
.B modify
 
59
operation.
 
60
.TP
 
61
.B translucent_local <attr[,attr...]>
 
62
Specify a list of attributes that should be searched for in the local database
 
63
when used in a search filter. By default, search filters are only handled by
 
64
the remote database. With this directive, search filters will be split into a
 
65
local and remote portion, and local attributes will be searched locally.
 
66
.TP
 
67
.B translucent_remote <attr[,attr...]>
 
68
Specify a list of attributes that should be searched for in the remote database
 
69
when used in a search filter. This directive complements the
 
70
.B translucent_local
 
71
directive. Attributes may be specified as both local and remote if desired.
 
72
.LP
 
73
If neither
 
74
.B translucent_local
 
75
nor
 
76
.B translucent_remote
 
77
are specified, the default behavior is to search the remote database with the
 
78
complete search filter. If only
 
79
.B translucent_local
 
80
is specified, searches will only be run on the local database. Likewise, if only
 
81
.B translucent_remote
 
82
is specified, searches will only be run on the remote database. In any case, both
 
83
the local and remote entries corresponding to a search result will be merged
 
84
before being returned to the client.
 
85
 
 
86
.SH CAVEATS
 
87
.LP
 
88
The Translucent Proxy overlay will disable schema checking in the local database,
 
89
so that an entry consisting of overlay attributes need not adhere to the
 
90
complete schema.
 
91
.LP
 
92
Because the translucent overlay does not perform any DN rewrites,  the local
 
93
and remote database instances must have the same suffix.  Other configurations
 
94
will probably fail with No Such Object and other errors.
 
95
.SH FILES
 
96
.TP
 
97
ETCDIR/slapd.conf
 
98
default slapd configuration file
 
99
.SH SEE ALSO
 
100
.BR slapd.conf (5),
 
101
.BR slapd-ldap (5).