Mac OS X Server Address Book Server Administration Version 10.
KKApple Inc. © 2009 Apple Inc. All rights reserved. Under the copyright laws, this manual may not be copied, in whole or in part, without the written consent of Apple. The Apple logo is a trademark of Apple Inc., registered in the U.S. and other countries. Use of the “keyboard” Apple logo (Option-Shift-K) for commercial purposes without the prior written consent of Apple may constitute trademark infringement and unfair competition in violation of federal and state laws.
Contents 5 5 6 6 7 7 8 8 9 Preface: About This Guide 10 10 11 11 11 12 12 Chapter 1: Understanding Address Book Server 13 13 13 15 15 16 17 18 18 19 19 20 20 21 21 Chapter 2: Setting Up and Managing Address Book Server What’s New in Address Book Server What’s in This Guide Using Onscreen Help Documentation Map Viewing PDF Guides Onscreen Printing PDF Guides Getting Documentation Updates Getting Additional Information Address Book Server Features Open Standards Service Scalability Directory and Cl
22 22 22 23 23 23 24 24 Monitoring Address Book Server Viewing Address Book Server Vital Status Viewing Address Book Server Logs Maintaining Address Book Server Understanding Address Book Server Configuration Files Backing Up and Restoring Address Books Upgrading Contacts from Directory in Mac OS X Server Version 10.
Preface About This Guide This guide provides a starting point for administering Address Book Server using its advanced administration tools. It contains information about managing Address Book Server using Server Admin. Address Book Server Administration may not be the only guide you need when administering Address Book Server, but it gives you the information to get Address Book Server running, as well as information about making modifications afterwards.
What’s in This Guide This guide includes the following chapters: ÂÂ Chapter 1, “Understanding Address Book Server,” explains what the Address Book Server is and how it’s implemented. ÂÂ Chapter 2, “Setting Up and Managing Address Book Server,” describes how to configure and maintain Address Book Server. ÂÂ Chapter 3, “Advanced Address Book Server Information,” explains more advanced information that is helpful for troubleshooting and advanced configuration.
Documentation Map Mac OS X Server has a suite of guides that cover management of individual services. Each service may depend on other services for maximum utility. The documentation map below shows some related guides that you may need to fully configure Address Book Server to your specifications. You can get these guides in PDF format from the Mac OS X Server Resources website: www.apple.
Printing PDF Guides If you want to print a guide, you can take these steps to save paper and ink: ÂÂ Save ink or toner by not printing the cover page. ÂÂ Save color ink on a color printer by looking in the panes of the Print dialog for an option to print in grays or black and white. ÂÂ Reduce the bulk of the printed document and save paper by printing more than one page per sheet of paper. In the Print dialog, change Scale to 115% (155% for Getting Started).
Getting Additional Information For more information, consult these resources: ÂÂ Read Me documents—get important updates and special information. Look for them on the server discs. ÂÂ Mac OS X Server website (www.apple.com/server/macosx/)—enter the gateway to extensive product and technology information. ÂÂ Mac OS X Server Support website (www.apple.com/support/macosxserver/)—access hundreds of articles from Apple’s support organization. ÂÂ Apple Discussions website (discussions.apple.
Understanding Address Book Server 1 Address Book Server is the contact service for Mac OS X Server. Built on open standard protocols, Address Book Server provides a simple–to–implement, secure, hosted address book solution. Now it’s easy to access personal and group contacts across multiple computers within a workgroup, a small business, or a large corporation.
Open Standards Address Book Server is based on open standards, and is built upon a strong foundation of proven standards and familiar technologies, including: HTTP (RFC 2616): HTTP serves as the method of communication between the Address Book clients and the server. WebDAV Class 3 (RFC 4918): WebDAV serves as Address Book Server’s method for reading and writing vCard files on the server. vCard (RFC 2426): A vCard is the data storage model for individual contacts.
To bind Address Book on a client to Address Book Server: 1 Open Address Book on the client computer. The only versions of the Address Book application that support using Address Book Server are those in Mac OS X version 10.6. Earlier versions of Address Book don’t support binding to Address Book Server. 2 Choose Address Book > Preferences, and then click Accounts. 3 Click the Add (+) button. 4 In the Add Account dialog, select Mac OS X Server as the Account Type. 5 Enter the user’s name and password.
Setting Up and Managing Address Book Server 2 Address Book Server is configured using Server Admin, authenticated using Open Directory, and accessed using a CardDAV compatible client. This chapter provides the planning steps and tasks necessary to set up Address Book Server. It also provides information about how to manage and monitor Address Book Server. Minimum Requirements Address Book Server has the same system requirements as Mac OS X Server 10.6.
Step 2: Gather your information You need the following information before you begin: ÂÂ Host name of the server TCP port to respond to Address Book Server connections ÂÂ Authentication method (Digest, Kerberos v5, or Any) ÂÂ Location of the data store ÂÂ Estimated storage quota per user ÂÂ Certificate information for SSL connections (optional) This ensures smooth installation and can help you make planning decisions.
Enabling Administration of Address Book Server You must turn on Address Book Server before you can use Server Admin to configure or enable it. This allows Server Admin to start, stop, and change settings for Address Book Server. To enable Address Book Server for administration: 1 Open Server Admin. 2 Select a server, click the Settings button in the toolbar, and then click the Services tab. 3 Select the checkbox for Address Book Server.
Changing Address Book Server Administration Settings You can customize Address Book Server by using the following settings in Server Admin. Setting Description Directory Searching This allows clients bound to Address Book Server to get contacts and groups from directory servers that Address Book Server is bound to. To change this setting, see “Configuring Directory Search for Address Book Server” on page 17. Data Store This is where the server stores all the users’ vCards.
Configuring Directory Search for Address Book Server Directory searching lets Address Book Server clients search the directory services Address Book Server is bound to. This can include Mac OS X Server version 10.5 implementations that are configured with the Directory application. It can also include any existing LDAP or Active Directory implementations. To allow searching of existing directory services: 1 In Server Admin, select a server and select Address Book. 2 Click the Settings button in the toolbar.
Changing the Address Book Data Store Location The data store is where the server stores all the users’ contacts as vCards. The default location is /Library/AddressBookServer/Documents/. This location is relative to the local file system, so if the storage location is on a network volume, enter the local filesystem mount point, not a network URL. To change the default data store: 1 In Server Admin, select a server and select Address Book. 2 Click the Settings button in the toolbar.
From the command line: 1 sudo serveradmin settings addressbook:UserQuota = QuotaSize Replace QuotaSize with the size in bytes. In Server Admin and Server Preferences, you set the size in megabytes, not bytes. 2 sudo serveradmin stop addressbook 3 sudo serveradmin start addressbook Setting the Address Book Server Host Name When setting up Address Book Server, you must specify the host name of the Address Book Server. It should be a fully qualified domain name matched with a reverse lookup record.
From the command line: 1 sudo serveradmin settings addressbook:HTTPPort = PortNumber Replace PortNumber with the port number clients will used to connect to Address Book Server. 2 sudo serveradmin stop addressbook 3 sudo serveradmin start addressbook Changing the Address Book Server Logging Level The default logging level for Address Book Server is Warning. The Warning level of logging provides the second–lowest level of detail.
Choosing and Enabling Secure Authentication for Address Book Server Users authenticate to Address Book Server through one of the following methods: ÂÂ Kerberos v.5: This method uses strong encryption and is used in Mac OS X for single sign-on to services offered by Mac OS X Server. ÂÂ Digest: (RFC 2617) This method sends secure login names and encrypted passwords without the use of a trusted third party (like the Kerberos realm), and is can be used without maintaining a Kerberos infrastructure.
Monitoring Address Book Server To keep Address Book Server operating smoothly, you must monitor service logs as well as current statistics. The Address Book Server Overview pane lets you keep track of the following vital statistics: ÂÂ Whether the service is running ÂÂ When the services started running ÂÂ How many requests are being responded to each hour The following sections contain more information about monitoring Address Book Server.
Maintaining Address Book Server The following sections contain information to help you keep Address Book Server working smoothly: ÂÂ “Understanding Address Book Server Configuration Files” on page 23 ÂÂ “Backing Up and Restoring Address Books” on page 23 ÂÂ “Upgrading Contacts from Directory in Mac OS X Server Version 10.
For more information about these commands, see their man pages and Introduction to Command-Line Administration. Time Machine isn’t recommended for server file and system backup of advanced configuration servers. You can use the launchdctl command to automate data backup using these commands. For more information about usinglaunchdctl, see Introduction to Command-Line Administration. Upgrading Contacts from Directory in Mac OS X Server Version 10.
Advanced Address Book Server Information 3 This chapter contains detailed information about Address Book Server that is suitable for advanced system administrators. Address Book Server provides contact sharing, collaboration, and synchronization through the CardDAV protocol. CardDAV is a standard for accessing contacts using WebDAV. It’s used to store, query, and retrieve collections of vCards (.vcfs) from a CardDAV-enabled server to any suitable client.
Configuration Tools Address Book Server uses four Mac OS X front-end tools: ÂÂ Server Admin for Mac OS X ÂÂ The serveradmin tool ÂÂ Server Preferences ÂÂ The carddavd tool In each case, the front-end tools reads from a configuration plist file (/etc/carddavd/ carddavd.plist) to set service parameters.
Implementation Details Address Book Server is implemented using Python v2.6 or later, using the Twisted network framework. This open source framework gives excellent network performance using an asynchronous networking model, without using threads. The Twisted framework does’t support WebDAV level 2 locking or WebDAV versioning (neither is required for CardDAV).
About the Source Code for the Address Book Server Apple makes available a reference implementation of a CardDAV server as a part of the Darwin Server project.
Where to Go for Additional Information Additional information about the CardDAV project, the Darwin Calendar Server, and the standards underlying Address Book Server are available online. Related Web Sites ÂÂ Open Source project site: http://www.macosforge.org/ ÂÂ Industry address book consortium:http://tools.ietf.org/wg/vcarddav/ Standards Documents CardDAV is a product of the Internet Engineering Task Force (IETF) Vcarddav working group.
A Address Book Server backup 23 CardDAV protocol 11, 25, 28 client integration 11, 12 configuration files 23 configuration tools 26 daemon process 26 deleting address books 24 enabling 15 file hierarchy 27 load management 26 logs 16, 20, 22 management of 23, 25 monitoring 22 Open Directory 26 open standards 11 overview 10 requirements 13 restoring files 23 scalability 11 security 20, 21 settings 16, 17, 18, 19, 20 setup 13 software dependencies 27 source code 28 starting 15 stoppin
M W O X Mac OS X Server, upgrading contacts 24 mail service 12 Open Directory master 26 WebDAV (Web-Based Distributed Authoring and Versioning) 11 XML property list file 26 P ports HTTP 16, 19 SSL 16 property list (plist) file 26 protocols CardDAV 11, 25, 28 HTTP 11, 16, 19, 25 Python 27 Q quotas, vCard data storage 16, 18 R requirements 13 S searching directory services 16, 17 security authentication 16, 21 certificates 21 SSL 16, 21 self-signed certificates 21 Server Admin
