<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[15665] CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/15665">15665</a></dd>
<dt>Author</dt> <dd>dre@apple.com</dd>
<dt>Date</dt> <dd>2016-06-09 16:36:59 -0700 (Thu, 09 Jun 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Added info about ldap attribute indexing</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkdocAdminDirectoryServiceLDAPrst">CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkdocAdminDirectoryServiceLDAPrst"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst (15664 => 15665)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst 2016-06-09 22:16:11 UTC (rev 15664)
+++ CalendarServer/trunk/doc/Admin/DirectoryService-LDAP.rst 2016-06-09 23:36:59 UTC (rev 15665)
</span><span class="lines">@@ -1,3 +1,4 @@
</span><ins>+=======================
</ins><span class="cx"> LDAP Directory Service
</span><span class="cx"> =======================
</span><span class="cx">
</span><span class="lines">@@ -8,15 +9,17 @@
</span><span class="cx">
</span><span class="cx"> .. _twext.who.ldap: http://trac.calendarserver.org/browser/twext/trunk/twext/who/ldap
</span><span class="cx">
</span><del>-When using this service, a separate process called the Directory Proxy Service
</del><ins>+When using this service, a separate process called the Directory Proxy Service (DPS)
</ins><span class="cx"> is instantiated to handle interactions with the LDAP server. This process
</span><span class="cx"> maintains an in-memory cache of directory services data. Worker processes
</span><span class="cx"> communicate with the DPS over an AMP socket. Each worker process also maintains
</span><span class="cx"> an in-memory cache of directory services data. Each cache TTL can be configured
</span><span class="cx"> separately.
</span><span class="cx">
</span><del>-**Configuring the Calendar Server**
</del><span class="cx">
</span><ins>+Configuring the Calendar Server
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
</ins><span class="cx"> A sample caldavd.plist configuration is shown below. To use LDAP with CalendarServer,
</span><span class="cx"> you will almost certainly have to customize at least some of the config
</span><span class="cx"> options, due to the nature of LDAP's arbitrary and often site-specific
</span><span class="lines">@@ -133,8 +136,10 @@
</span><span class="cx"> </dict>
</span><span class="cx"> </dict>
</span><span class="cx">
</span><del>-**Configuring Principals**
</del><span class="cx">
</span><ins>+Configuring Principals
+~~~~~~~~~~~~~~~~~~~~~~~
+
</ins><span class="cx"> The "mapping" section of the above configuration defines the mapping
</span><span class="cx"> between record attributes used by CalendarServer and the LDAP
</span><span class="cx"> attribute used to store this information in the configured LDAP
</span><span class="lines">@@ -189,10 +194,9 @@
</span><span class="cx"> scheduling message arrives, if it does not conflict with an existing
</span><span class="cx"> meeting it can be automatically accepted into the principal's main
</span><span class="cx"> calendar; if it does conflict it can be automatically declined. The
</span><del>- available modes are:
</del><ins>+ available modes can be seen here:
+ http://trac.calendarserver.org/browser/CalendarServer/trunk/calendarserver/tools/principals.py#L47
</ins><span class="cx">
</span><del>-http://trac.calendarserver.org/browser/CalendarServer/trunk/calendarserver/tools/principals.py#L47
-
</del><span class="cx"> ``autoAcceptGroup``
</span><span class="cx">
</span><span class="cx"> Specifies the uid of a group whose members will be excempt from any
</span><span class="lines">@@ -214,8 +218,10 @@
</span><span class="cx"> whose members are granted read-only proxy (delegate) access to the
</span><span class="cx"> corresponding principal.
</span><span class="cx">
</span><del>-**Other LDAP params**
</del><span class="cx">
</span><ins>+Other LDAP params
+~~~~~~~~~~~~~~~~~~
+
</ins><span class="cx"> The following settings are available in the 'params' dictionary of the LDAP configuration.
</span><span class="cx">
</span><span class="cx"> ``threadPoolmax``
</span><span class="lines">@@ -240,8 +246,10 @@
</span><span class="cx">
</span><span class="cx"> A boolean that instructs the DPS to connect to the LDAP service using TLS.
</span><span class="cx">
</span><del>-**Related settings**
</del><span class="cx">
</span><ins>+Related settings
+~~~~~~~~~~~~~~~~~
+
</ins><span class="cx"> The following settings are available *outside* the LDAP directory service configuration (i.e.
</span><span class="cx"> the DirectoryProxy dict is a top-level dict in caldavd.plist):
</span><span class="cx">
</span><span class="lines">@@ -267,3 +275,21 @@
</span><span class="cx"> ``InSidecarCachingSeconds``
</span><span class="cx">
</span><span class="cx"> The TTL of directory services data in worker processes and the DPS, respectively.
</span><ins>+
+
+LDAP attribute indexing
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use the following guidance to properly configure attribute indexing on the LDAP server.
+
++------------+-----------------------+
+| Attribute | Search type |
++============+=======================+
+| fullName | substring (subany) |
++------------+-----------------------+
+| guid | exact |
++------------+-----------------------+
+| shortName | exact |
++------------+-----------------------+
+| mail | substring (subfinal) |
++------------+-----------------------+
</ins></span></pre>
</div>
</div>
</body>
</html>