[CalendarServer-changes] [4668] CalendarServer/trunk/doc/Admin

[source_changes at macosforge.org]

Revision: 4668
          http://trac.macosforge.org/projects/calendarserver/changeset/4668
Author:   wsanchez at apple.com
Date:     2009-10-29 13:49:52 -0700 (Thu, 29 Oct 2009)
Log Message:
-----------
New docs

Modified Paths:
--------------
    CalendarServer/trunk/doc/Admin/DirectoryService-XML.txt
    CalendarServer/trunk/doc/Admin/DirectoryServices.txt

Added Paths:
-----------
    CalendarServer/trunk/doc/Admin/DirectoryService-OpenDirectory.txt

Added: CalendarServer/trunk/doc/Admin/DirectoryService-OpenDirectory.txt
===================================================================
--- CalendarServer/trunk/doc/Admin/DirectoryService-OpenDirectory.txt	                        (rev 0)
+++ CalendarServer/trunk/doc/Admin/DirectoryService-OpenDirectory.txt	2009-10-29 20:49:52 UTC (rev 4668)
@@ -0,0 +1,44 @@
+Open Directory Service
+======================
+
+The Open Directory directory service provides principal information
+that is obtained using Apple's Open Directory service.
+
+Open Directory provides principal information for users, groups,
+locations, and resources.
+
+For more information about configuring Open Directory and running Open
+Directory services, see Apple's `Open Directory Administration`_
+document.
+
+.. _Open Directory Administration: http://images.apple.com/server/macosx/docs/Open_Directory_Admin_v10.6.pdf
+
+Configuring the Calendar Server
+-------------------------------
+
+The full name of the service is
+``twistedcaldav.directory.appleopendirectory.OpenDirectoryService``
+and the service takes a ``node`` parameter which contains the name of
+the directory node to bind to.
+
+For example:
+
+::
+
+  <!-- Open Directory Service -->
+  <key>DirectoryService</key>
+  <dict>
+    <key>type</key>
+    <string>twistedcaldav.directory.appleopendirectory.OpenDirectoryService</string>
+  
+    <key>params</key>
+    <dict>
+      <key>node</key>
+      <string>/Search</string>
+    </dict>
+  </dict>
+
+The special Open Directory node ``/Search`` causes the server to use
+the default directory search path that the host system the server is
+running on is configured to use. To bind to a specific LDAP service, a
+node in the form ``/LDAPv3/ldapserver.example.com`` may be specified.


Property changes on: CalendarServer/trunk/doc/Admin/DirectoryService-OpenDirectory.txt
___________________________________________________________________
Added: svn:mime-type
   + text/plain

Modified: CalendarServer/trunk/doc/Admin/DirectoryService-XML.txt
===================================================================
--- CalendarServer/trunk/doc/Admin/DirectoryService-XML.txt	2009-10-29 20:30:00 UTC (rev 4667)
+++ CalendarServer/trunk/doc/Admin/DirectoryService-XML.txt	2009-10-29 20:49:52 UTC (rev 4668)
@@ -4,6 +4,9 @@
 The XML directory service provides principal information that is read
 from an XML file.
 
+The XML file provides principal information for users, groups,
+locations, and resources.
+
 One advantage to this directory service implementation is that it does
 not require a networked directory server to be running somewhere,
 instead simply relying on a file.
@@ -42,36 +45,17 @@
 Principals are expressed in an XML document. The root element
 ``accounts`` has an attribute ``realm`` which describes the
 authentication realm. It contains principal elements which in turn
-contain elements describing the principal. The element itself denotes
-the principal type.
+contain elements describing the principal. The element itself
+(``user``, ``group``, ``location``, ``resource``) denotes the
+principal type.
 
-The principal types supported by the XML directory service are:
-
-users
-
-  Individual (typically human) users of the system. XML element: ``user``
-
-groups
-
-  Principals that contain other principals ("members"). Members can be
-  principals of any type, including other group principals.  XML
-  element: ``group``
-
-locations
-
-  Locations that can be scheduled. XML element: ``location``
-
-resources
-
-  Other resources (eg. projectors) which can be scheduled. XML
-  element: ``resource``
-
 Principal elements can contain the following elements which provide
 information about the principal:
 
 ``uid``
 
-  The login identifier for the principal (ie. "username" or "short name").
+  The login identifier for the principal (ie. "user name" or "short
+  name").
 
 ``guid``
 

Modified: CalendarServer/trunk/doc/Admin/DirectoryServices.txt
===================================================================
--- CalendarServer/trunk/doc/Admin/DirectoryServices.txt	2009-10-29 20:30:00 UTC (rev 4667)
+++ CalendarServer/trunk/doc/Admin/DirectoryServices.txt	2009-10-29 20:49:52 UTC (rev 4668)
@@ -44,10 +44,33 @@
 users, groups, resources, and so on. Calendar Server keeps this
 distinction, and some types are treated specially.
 
+Principal types commonly provided by directory services include:
+
+users
+
+  Individual (typically human) users of the system.
+
+groups
+
+  Principals that contain other principals ("members"). Members can be
+  principals of any type, including other group principals.
+
+locations
+
+  Locations that can be scheduled.
+
+resources
+
+  Other resources (eg. projectors) which can be scheduled.
+
 For example, only user principals are allowed to authenticate with
 (log into) the server. Only group principals have members, and group
 principals do not have calendars.
 
+
+Configuration
+=============
+
 The directory service used by the server is configured in the
 ``caldavd.plist`` file by specifying the directory service
 implementation to use, as well as its configuration options. Options
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20091029/2e4f5088/attachment.html>