Chapter 1   Preparing for Installation


This chapter contains the following sections to help you prepare for installation of Sun™ ONE Calendar Server:

• Installation Overview

• System Requirements

• Installation Privileges

• Gathering Your Installation Information

• Using an LDAP Directory Server

• Important Considerations

If you have Calendar Server version 2.x on your system, you can install version 5.1.1, which can then co-exist on the same system. You can also migrate the 2.x calendar data and user information to version 5.1.1. For more information, see Chapter 4 "Migrating Calendar Server Data."

If you have already installed Calendar Server 5.x on your system, you can either upgrade to 5.1.1, or you can remove it and then reinstall the 5.1.1 version.

If you are perform an upgrade, the installation program removes any out-of-date localized resources. For example, suppose you have Calendar Server 5.1 installed on a Solaris system with English, German, Spanish, French, and Japanese localized resources. If you upgrade using an installation archive named ics-5_1_1-export-en-de-es-fr_sparc-sun-solaris2_6_tar.gz, the installation program installs new localized resources for English, German, Spanish, and French, but removes the out-of-date Japanese localized resources.

For the most recent information about known problems with this release, see the Calendar Server Release Notes at:

http://docs.sun.com/db/prod/s1calsrv

Installation Overview

---

There are three basic steps involved in installing the Calendar Server:

1. Gathering Your Installation Information.

2. Using an LDAP Directory Server.

3. Installing the Calendar Server. See Installing Calendar Server on UNIX Systems or Installing Calendar Server on Windows NT Systems.

Considerations for UNIX systems are:

• The installation program uses an X-Windows graphical user interface. It is recommended that you install the Calendar Server using a local terminal window.

• If you cannot use X-Windows remotely or if your machine does not have X-Windows installed, you must use the command line installation. The command line installation follows the same process as the graphical installation. The only difference between the graphical and command line interfaces is in how you invoke the installation setup script.

• If you must run the installation program from a remote terminal, be sure to set your DISPLAY environment variable properly on the remote machine and be sure to allow X-Windows connections from the machine to appear on your terminal (for example, using the utility xhost +).

System Requirements

---

Before you install the Calendar Server, you must ensure you have met the minimum hardware and operating system requirements. For the latest information on the supported platforms and software and hardware requirements, see the Calendar Server Release Notes at:

http://docs.sun.com/db/prod/s1calsrv

Installation Privileges

---

To install, reinstall, or upgrade the Calendar Server, you must have superuser privileges. On Solaris or other UNIX systems, you must login as (or become) root (user ID = 0). On Windows NT systems, you must login as an administrator who has full administration privileges for the system.

Gathering Your Installation Information

---

Before beginning the installation process, it is helpful to gather the installation and configuration information you will need. The information will differ according to the type of installation you select.

The two installation types are:

Typical Installation. This is the simplest type of installation. Most options are automatically configured with default values, but some require that you choose and enter the value you wish to use. This type of installation is recommended for most administrators or for any installation that does not require a custom configuration. For checklist information on completing this type of installation, see Typical Installation Checklist.

Custom Installation. This is a more complex installation than the typical installation. You must choose and enter all configuration values. This type of installation is recommended for advanced administrators only. For checklist information on completing this type of installation, see the Custom Installation Checklist.

Typical Installation Checklist

You need the following information to complete the installation procedure for a Typical Installation.

Component Selection

Choose one or more of the following components (default is all):

• Calendar Server

• Calendar Server API (CSAPI)

Installation Directory

Determine the name and path of the directory in which you want the server to be installed. For example, /opt. If the installation is for a large deployment, ensure that it is installed on a machine with a storage device large enough to handle the load, such as a high capacity hard drive with adequate free space or a Redundant Array of Inexpensive Disks (RAID).

Service Ports

The service port is the TCP port number that you want the Calendar Server to use to provide web (HTTP) access to users (default is 80). It is highly recommended that you choose the Web port number suggested by the installation program because 80 is the default port number used by all Web browsers. If you specify a port number other than 80, calendar users will need to explicitly include this port number in the URL they enter to access their calendars on this Calendar Server. If port 80 is already in use, it is recommended that you free port 80 on the other service before you install the Calendar Server.

Remote administration is planned for a future release. In the current release, the installation program does not allow you to specify an administration (admin) port, and by default, the admin port is disabled (service.admin.port.enable = "no").

Calendar Server User and Group Account (UNIX systems only)

These accounts are the UNIX user and group identity under which the Calendar Server will run. It is recommended to use the defaults icsuser and icsgroup. These accounts will be created automatically by the installation program if they do not already exist.

Calendar Server Administrator (Windows NT systems only)

This is the identity that the Calendar Server will run as on Windows NT systems. The installation program assumes that this identity is the user (and password) that is currently logged in to the system during installation, and it cannot be changed while you are running the installation program.

This user must have full administrator rights to this system.

---

Note	The password for the administrator cannot be blank.

---

Therefore, before you start the installation program, log in as the user that you want the Calendar Server to run as and ensure that this user has full administrator rights to the system where you are installing the Calendar Server.

Calendar Server Administrator

The Calendar Server Administrator is the user account that can manage the Calendar Server. For example, this user account can run the Calendar Server administration utilities to perform actions such as starting and stopping the Calendar Server or listing all logged-in users.

To login to and manage the Calendar Server, the Calendar Server Administrator user account must exist in your user authentication directory server. If your user preferences are stored in another directory server, this user account must also exist in that directory server. If the Calendar Server Administrator user account does not exist in the directory server during installation, you must add it after installation, or the account will not be able to login to the Calendar Server.

The Calendar Server Administrator user ID is stored in the ics.conf file in the service.admin.calmaster.userid parameter. The default is calmaster.

Customizable Files

If you are upgrading or reinstalling the Calendar Server, the installation program overwrites the existing Calendar Server files, including any files you have customized. You can choose, however, to have the installation program save all Calendar Server configuration and customizable files with these extensions:

.xsl .xml .conf .gif .htm

The installation program saves the Calendar Server files with these extensions, even if you have not customized them. The installation program also generates a report that indicates which files have changed. After the installation has finished, you can use this report to merge your customizations from the saved files into the newly installed Calendar Server files.

To save your customizable files, you must specify a directory in the Save Calendar Server Customizable Files window. You can click Browse and select an existing directory, or you can enter a directory name and have the installation program create the directory for you.

In the Calendar Server 5.1.1 release, the visible text strings in the XSL files have been converted to variables for localization purposes and are in the respective i18n.xsl file for each language. The XSL files are installed in the following directories:

server-root/cal/bin/data/language/source

where language identifies the specific language code.

You can localize the i18n.xsl file as required at your site. The i18n.xsl file contains the text strings referenced in non-localized XSL files as well as the text strings used in date_format.xsl (which is localized). You need to localize date_format.xsl only for languages whose format or layout differs from English.

Email and Email Alarms Address

Identify the following:

• Calendar Server Administrator email address. This address uses the syntax: userid@hostname.domainname. For example, calmaster@sesta.com.

• SMTP server host name. This is the fully qualified host name of the SMTP server that the Calendar Server will use to send email messages. For example:

  calhome.sesta.com

  where calhome is the machine's host name and sesta.com is the DNS domain name on which the SMTP server is running.

Calendar Database Directory

Specify the directory to place the Calendar Server database.

• On Solaris, the default is:

     /var/opt/SUNWics5/csdb

• On UNIX systems other than Solaris, the default is:

     /var/opt/iPlanet/CalendarServer5/csdb

• On Windows NT systems, the default is:

     c:\Program Files\iPlanet\CalendarServer5\var\csdb

  Note that on Windows NT systems, this directory must be located on an NTFS formatted drive and not on a FAT file system.

LDAP Server Information

Identify the following LDAP server information for user authentication and preferences:

• Host: The host name of the machine where the LDAP server is installed. The default is the host name of the machine on which you are running the installation program.

• Port: The service port for the LDAP server. The default is 389.

• Base DN: The Base DN (distinguished name) is the entry in your LDAP directory used as the starting point from which searches will occur. For example, if you specify a base DN of ou=people, o=sesta.com, all LDAP search operations executed by the Calendar Server will examine only the ou=people subtree in the o=sesta.com directory tree.

• Administrator Bind DN: The DN of the account that has privileges to manage the attributes of any calendar user in the LDAP directory that stores user preferences. The default is:

  uid=admin,ou=Administrators,ou=TopologyManagement,o=NetscapeRoot

  The default bind DN will work with any 4.x version of Netscape Directory Server or the 5.1 version of iPlanet Directory Server. You can verify that this DN exists by using the directory server ldapsearch utility. For example:

  ./ldapsearch -b o=NetscapeRoot uid=admin

• Administrator Password: The password for the user account of the Administrator Bind DN described above.

• Directory Manager (also known as "Unrestricted User") of the directory server that stores user and group information. This is the username and password of the person who can make changes in the directory server schema. This user has overall administrator privileges on the directory server and all servers that make use of the directory server, such as the Administration Server, and has full administration access to all entries in the directory server.

  The Directory Manager's distinguished name (DN) was supplied when the directory server was installed. The default DN is cn=Directory Manager. This information is needed because the Calendar Server requires specific updates to the LDAP schema.

Custom Installation Checklist

In addition to the information in the Typical Checklist, you will need the following information to complete the Custom Installation procedure:

System Resources

Select the desired values for the following system resource allocations to run the Calendar Server:

• Maximum sessions (default is 5000)

• Maximum threads (default is 1000)

• Number of server processes (default is 1)

Using an LDAP Directory Server

---

Sun ONE Calendar Server stores and manages calendars, calendar properties, access control information, events, todos (tasks), and alarms. To manage storage for user information, however, the Calendar Server requires a directory service to perform operations such as user authentication and the storage and retrieval of user preferences.

The default Calendar Server installation supports users defined and maintained in the following LDAP directory servers:

• iPlanet Directory Server 5.1

• Netscape Directory Server 4.12 and 4.16

If your users are already stored in an LDAP directory, the simplest solution for deploying the Calendar Server is to upgrade your directory server to iPlanet Directory Server 5.1 or Netscape Directory Server 4.12 or 4.16. The Calendar Server installation program will then try to automatically update your directory server schema for Calendar Server 5.1.1.

For information about installing and configuring iPlanet Directory Server or Netscape Directory Server, see:

http://docs.sun.com/db/prod/s1dirsrv

If you are using another directory server, or if the installation program cannot update your directory server, you must modify your schema manually to allow your users to access the Calendar Server.

Updating the LDAP Server Schema Manually

• iPlanet Directory Server 5.1

• Netscape Directory Server 4.12 and 4.16

iPlanet Directory Server 5.1

For iPlanet Directory Server 5.1, the LDAP schema extensions used by the Calendar Server are defined in the following files:

60iplanet-calendar.ldif
um50-common-schema.conf
ns-wcal-schema.conf

The Calendar Server installation program installs these files in the server-root/cal/bin/config directory.

To update iPlanet Directory Server 5.1 manually:

1. Install Calendar Server 5.1.1.

2. Stop the Calendar Server if it is running.

3. Stop the Directory Server 5.1 if it is running.

4. Copy the 60iplanet-calendar.ldif, um50-common-schema.conf, and ns-wcal-schema.conf files to the following directory on the server where your directory server is running:

   server-root/slapd-hostname/config/schema

   where hostname is the name of the server.

5. Restart the Directory Server. If you receive OID errors, see Resolving Conflicting OIDs in the LDAP Schema Directory.

6. Restart the Calendar Server.

Netscape Directory Server 4.12 and 4.16

For Netscape Directory Server 4.12 and 4.16, the LDAP schema extensions used by the Calendar Server are defined in the following files:

• um50-common-schema.conf defines the LDAP attributes and object classes shared by Sun ONE products.

• ics50-schema.conf defines the LDAP attributes and object classes used by the Calendar Server.

The Calendar Server installation program installs these files in the server-root/cal/bin/config directory.

To update Netscape Directory Server 4.12 or 4.16 manually:

1. Install Calendar Server 5.1.1.

2. Copy the LDAP schema files (um50-common-schema.conf and ics50-schema.conf) from server-root/cal/bin/config to the following directory on the server where your directory server is running:

   server-root/slapd-hostname/config

   where hostname is the name of the server.

   For example, on Solaris and other UNIX systems:

   /usr/Netscape/Server4/slapd-sesta/config

3. Stop the Calendar Server if it is running.

4. Stop the Directory Server if it is running.

5. Edit the ns-schema.conf file (in the same directory in which you copied the um50-common-schema.conf and ics50-schema.conf files. At end of the file, if they are not already present, add the following lines to include these files.

   On Solaris and other UNIX systems:

   include /netscape/server4/slapd-hostname/config/um50-common-schema.conf

   include /netscape/server4/slapd-hostname/config/ics50-schema.conf

   On Windows NT systems:

   include "C:\Netscape\Server4\slapd-hostname\config\um50-common-schema.conf"

   include "C:\Netscape\Server4\slapd-hostname\config\ics50-schema.conf"

   where hostname is the name of the server where the directory server is running.

   
   

   ---

   Note	Be sure to add the lines in the order shown above so that um50-common-schema.conf is included before ics50-schema.conf.

   ---

   
   

6. Restart the Netscape Directory Server. If you receive OID errors, see Resolving Conflicting OIDs in the LDAP Schema Directory.

7. Restart the Calendar Server.

Resolving Conflicting OIDs in the LDAP Schema Directory

If your LDAP schema directory contains conflicting OIDs, the Directory Server does not know which OID to use and returns an error message. For example, the following message indicates a conflicting OID for the icsCalendarUser object class for iPlanet Directory Server 5.1:

[24/Jul/2002:23:45:28 -0700] dse - The entry cn=schema in file /export/iplanet/servers/slapd-ical/config/schema/99user.ldif is invalid, error code 20 (Type or value exists) - object class icscalendaruser: The name does not match the OID. Another object class is already using the name or OID.

[24/Jul/2002:23:45:28 -0700] dse - Please edit the file to correct the reported problems and then restart the server.

This problem can occur when you install Calendar Server 5.1.1 and you also had an older Calendar Server release that dynamically updated your LDAP server schema 99user.ldif file.

To resolve the conflicting OIDs, you must edit the 99user.ldif file and remove the older OIDs. For Calendar Server 5.1.1, the following table shows the specific OIDs that might cause problems.

Table 1-1    Calendar Server OIDs in the LDAP Schema Directory

Object Class	Old OID	New OID
icsCalendarUser	2.16.840.1.113730.3.2.141	1.3.6.1.4.1.42.2.27.9.2.2
icsCalendarResource	2.16.840.1.113730.3.2.143	1.3.6.1.4.1.42.2.27.9.2.3
icsCalendarDomain	2.16.840.1.113730.3.2.144	1.3.6.1.4.1.42.2.27.9.2.4

After you edit the 99user.ldif file, restart the Directory Server.

Important Considerations

---

Note the following considerations before installing Sun ONE Calendar Server 5.1.1:

• On UNIX systems, the installation program uses the command /usr/bin/domainname to identify the associated DNS domain name of your system. To verify that this setting is correct, type at the command prompt:

  domainname

  The above command should return the DNS domain name of your system correctly. If this is not the case, set the domain name by typing:

  domainname your-system-domain-name

  If the installation program cannot determine the DNS domain name as described above, it will attempt to read this value in the etc\resolv.conf file, if available.

• On some UNIX systems, the value returned by hostname could not be used in the IP addresses associated with that system. For example, the machine name is x.example.com, but TCP/IP applications must use y.example.com to connect to it. This is probably a badly configured machine.

  If you install Calendar Server on such a machine, entries in the ics.conf file might have incorrect values. Ideally, the machine should be reconfigured. If you cannot change the configuration of the machine, you will have to edit the ics.conf file explicitly using a text editor to correct the host name values.

  Additionally, there are several properties with property names containing the strings "host" and "hostname" that have null values. A null value causes the server to use the value returned by gethostname(3C). You will have to manually add the host name recognized by the TCP/IP subsystem as a value for these properties.