[CalendarServer-changes] [658] CalendarServer/trunk/README

Mon Dec 4 17:15:09 PST 2006

Revision: 658
          http://trac.macosforge.org/projects/calendarserver/changeset/658
Author:   wsanchez at apple.com
Date:     2006-12-04 17:15:07 -0800 (Mon, 04 Dec 2006)

Log Message:
-----------
formatting, note python 2.4

Modified Paths:
--------------
    CalendarServer/trunk/README

Modified: CalendarServer/trunk/README
===================================================================

--- CalendarServer/trunk/README	2006-12-05 01:04:02 UTC (rev 657)
+++ CalendarServer/trunk/README	2006-12-05 01:15:07 UTC (rev 658)
@@ -22,7 +22,7 @@
 
 Place this source directory into an empty development directory, such
 as '~/Developer/Collaboration/CalendarServer/'.  The server requires a
-number of libraries in order to operate.  The "run" script in the
+number of libraries in order to operate.  The 'run' script in the
 sources will automatically download or check out the appropriate
 libraries and build them for you:
 
@@ -40,22 +40,22 @@
 Some of the directory services which are supported by the calendar
 server include:
 
-   - XMLDirectoryService: this service is configurable via an XML file
-	 that contains principal information.  The file 'conf/accounts.xml'
-	 provides an example principals configuration.
+ * XMLDirectoryService: this service is configurable via an XML file
+   that contains principal information.  The file 'conf/accounts.xml'
+   provides an example principals configuration.
 
-   - OpenDirectoryService: this service uses OpenDirectory (which in
-	 turn uses ADAP, Active Directory, etc.) to obtain principal
-	 information.
+ * OpenDirectoryService: this service uses OpenDirectory (which in
+   turn uses LDAP, Active Directory, etc.) to obtain principal
+   information.
 
-   - BasicDirectoryService and DigestDirectoryService: these services
-     are configurable using configuration files in the same formats as
-	 used by the Apache HTTP server, allowing you to use the same
-	 user/group setup as a separately-running Apache server.
+ * BasicDirectoryService and DigestDirectoryService: these services
+   are configurable using configuration files in the same formats as
+   used by the Apache HTTP server, allowing you to use the same
+   user/group setup as a separately-running Apache server.
 
-     Note that the current implementation does not allow for
-	 configuring resources, since Apache doesn't have resource
-	 principals.
+   Note that the current implementation does not allow for
+   configuring resources, since Apache doesn't have resource
+   principals.
 
 The 'caldavd-test.plist' configuration uses XMLDirectoryService by
 default, set up to use 'conf/accounts-test.xml'.
@@ -65,7 +65,7 @@
 
 You can then run the server thusly:
 
-	./run
+    ./run
 
 This should start up and bind to port 8008 for HTTP and 8443 for
 HTTPS.  You should then be able to connect to the server using your
@@ -78,13 +78,13 @@
 
 The server implements the following specifications:
 
- - HTTP/1.1, RFC 2616
- - HTTP Authentication, RFC 2617
- - WebDAV level 1, RFC 2518
- - WebDAV Access Control Protocol, RFC 3744
- - WebDAV Quota and Size Properties, RFC 4331
- - CalDAV, draft-dusseault-caldav-15
- - CalDAV Scheduling Extensions, draft-desruisseaux-caldav-sched-02
+ * HTTP/1.1, RFC 2616
+ * HTTP Authentication, RFC 2617
+ * WebDAV level 1, RFC 2518
+ * WebDAV Access Control Protocol, RFC 3744
+ * WebDAV Quota and Size Properties, RFC 4331
+ * CalDAV, draft-dusseault-caldav-15
+ * CalDAV Scheduling Extensions, draft-desruisseaux-caldav-sched-02
 
 Note that while the server does support WebDAV, it does not support
 WebDAV level 2, which means it does not implement the LOCK and UNLOCK
@@ -97,17 +97,17 @@
 Portability may be limited in this release.
 
 The server requires:
- - Python 2.4
- - Zope Interface 3.1.0c1
- - PyXML 0.8.4
- - pyOpenSSL 0.6
- - python-dateutil-1.0
- - xattr 0.2 (Bob Ippolito's implementation)
- - pysqlite-2.2.2
- - Twisted
- - vObject
- - PyKerberos
- - PyOpenDirectory
+ * Python 2.4
+ * Zope Interface 3.1.0c1
+ * PyXML 0.8.4
+ * pyOpenSSL 0.6
+ * python-dateutil-1.0
+ * xattr 0.2 (Bob Ippolito's implementation)
+ * pysqlite-2.2.2
+ * Twisted
+ * vObject
+ * PyKerberos
+ * PyOpenDirectory
 
 It also requires, naturally, anything these components depend on.  For
 example, pyOpenSSL requires the OpenSSL library.
@@ -125,18 +125,38 @@
 If you are using other operating systems, there may be additional
 coding work required before you can get started.
 
+WEBDAV PROPERTY STORAGE
+-----------------------
+
 For starters, twisted.web2.dav requires Bob Ippolito's xattr library
 to access file system extended attributes, which are used to store
 WebDAV properties.  File system extended attributes are available
 on all file systems in Mac OS X, and on some file systems on Linux
-and FreeBSD.
+and FreeBSD.  Another alternative is to implement a new property store
+class which does not use extended attributes. The Apache HTTP Server, for
+example, uses a database to keep track of properties on files, and this
+method works on many more platforms and file systems.
 
 Linux and FreeBSD users have has some success running our calendar
 server.  Check our bug tracker for status:
 
 	http://trac.macosforge.org/projects/calendarserver/report/1
 
+PYTHON 2.4
+----------
 
+The Calendar Server was implemented using Python 2.4. A number of
+things would need to happen to get it to run using Python 2.3:
+
+ * All libraries the server depends on will need to work on Python 2.3.
+   vObject is known to require Python 2.4.
+ * We use several Python 2.4 features.  Most are easy enough to back-port,
+   but nice to use if you have them:
+   * built-in set objects
+   * generator expressions
+   * decorator syntax
+
+
 GETTING INVOLVED
 ================
 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20061204/29bfa572/attachment.html
