Calendar Server Installation Guide
Chapter
1: Preparing for Installation
This chapter contains the following sections:
Installation
Overview
There are three basic steps involved in installing the Calendar Server:
The installation program is based on a Java installer front-end and produces
an X-Window graphical user interface. We recommend you install using a
local terminal window. If you cannot use X-Windows remotely
or if your machine does not have an X-Window installed, you must use the
command line install. The command line installation
follows the same path as the graphical installation. The difference
is in how you would invoke the installation setup script. Go to the
instructions at Command Line Installation
for more information.
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-Window connections from the machine to appear on
your terminal (i.e. xhost +).
Note: A web browser, such as Netscape
Communicator 4.61, is required to use the Calendar Express client bundled
with the Calendar Server. An LDAP server, such as Netscape
Directory Server 4.1, is required. An SMTP server, such as Netscape
Messaging Server 4.1, is required for mail notifications of calendar
entries. The installation package is a GNU-zipped tar file. To unzip it,
you will need a copy of gunzip.
The following sections provide detailed information about these steps.
Supported Platforms
This release of Calendar Server supports the following platforms:
-
Solaris 2.6 with recommended patches
-
Solaris 2.7 with recommended patches
-
HPUX 11.0 with recommended patches
System Requirements
This section describes the hardware and software requirements.
Hardware Requirements:
-
Roughly 100 MB of free disk space for the installation.
-
Approximately 2 MB of disk space for each user.
-
At least 64 MB of RAM.
-
Optionally, RAID disk storage for fast access.
Software Requirements:
Solaris 2.6 / Solaris 2.7: with recommended patches
See: http://sunsolve.sun.com/pubpatch
HPUX 11.0: (PA-RISC1.1 or better) with recommended patches (PHKL_18543
(mmap() patch), PHNE_16017 (cumulative ARPA Transport patch). See
http://hp.com
for information on these recommended patches.
See the iPlanet Calendar Server 2.0 release notes listed at http://developer.netscape.com/docs/manuals/calendar.html
for information on kernel tuning your OS.
Chapter 2: 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. 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, go to
the
Typical Installation Checklist.
-
Custom Installation
This is a more complex type. You must choose and enter more configuration
values. This type of installation is recommended for advanced administrators
only. For checklist information on completing this type of installation,
go to the Custom Installation Checklist.
Note: Installations on Solaris use the path /<installation
directory>/SUNWicsrv as the server-root for the server
software files. For example, if you chose the default installation directory
(/opt), the server-root directory would be /opt/SUNWicsrv/.
For HPUX the server root would be /<installation directory>/iPlanet/CalendarServer/.
In this guide the conventions for installation on Solaris are used.
Typical Installation Checklist
You need the following information to complete the Typical Installation
procedure for a Typical, Custom or Command Line installation.
Type of Installation
Determine the type of installation you want to use: typical or custom.
Component Selection
Choose one or more of the following:
-
Calendar Server - Server Software (31.8 Mb on Solaris, 59.9 on HPUX)
-
Calendar Server - API (2.3 Mb - all UNIX)
Installation Directory
Determine the name and path of the directory in which you want the server(s)
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 TCP ports that you wish the server services to listen on:
Web Port (default 80)
Admin Port (randomly selected default)
Server User and Group Account
This is the Unix user and group account under which server will run. It
is recommended to use the defaults icsuser and icsgroup.
These will be created by the install program if they do not already exist.
Master Enduser Administrator
The user that can manage your iPlanet Calendar Server. This must be a userid
that already exists in your user authentication LDAP directory. This user
will be used by the administration utilities to authenticate to the Calendar
Server for commands like stop the Calendar Server or list all the logged-in
users. No verification is done to check if this userid exists in the directory.
Email and Email Alarms Address
Identify the following:
Calendar master email address. This address uses the syntax: userid@hostname.domainname.
For example, JSmith@airius.com
SMTP server host name: The fully qualified host name. For example,
calhome.airius.com,
where calhome is the machine host name and airius.com
is the domain name.
User Authentication Preferences
Identify the following LDAP server information for user authentication
and preferences:
Host: Host machine where the LDAP Server resides.
Port: Service port for the LDAP server. The default is 389.
Base DN: the Base DN (distinguished name) of the LDAP server installation.
Administrator Bind DN: the DN (distinguished name) of the account
which has full access to the user preferences directory. The default is:
uid=admin,ou=Administrators,ou=TopologyManagement,o=NetscapeRoot
Administrator Password: The password for the above DN.
The Administrator Bind DN is the account that has privileges to manage
the attributes of any calendar user. The default DN will work with any
4.x version of the Netscape/iPlanet LDAP directory. You can verify this
admin DN by using the directory server ldapsearch utility, for example:
./ldapsearch -b o=NetscapeRoot uid=admin
Custom Installation Checklist
In addition to the information in the Typical
Checklist, you will need the following information to complete the
Custom Installation procedure:
Temporary File Location
Choose the location where you want temporary files created by the Calendar
Server to be placed. The default is /var/opt/SUNWicsrv/tmp.
System Resources
Select desired values for the following system resources:
Maximum sessions (default is 5000)
Maximum threads (default is 1000)
Number of server processes (default is 1)
User Database Directory
Specify the directory to place the server database. The default is:
/var/opt/SUNWicsrv/csdb.
Chapter 3 Installing
and Configuring your LDAP Server
To install and configure the Netscape Directory Server 4.1 go to http://home.netscape.com/eng/server/directory/4.1/install/contents.htm.
Note: Netscape Directory Server 4.1 has the iPlanet
Calendar Server schema already configured into the default schema. If you
have Netscape Directory Server 4.0 installed you will first have to install
iPlanet Calendar Server 2.0, then copy the ns-wcal-schema.conf
file from the <server-root>/SUNWicsrv/cal/bin/config
directory into the <Directory Server 4.0 server-root>/slapd-<machine
name>/config directory. Next, you must edit the ns-schema.conf
file (in the same directory that you copied the ns-wcal-schema.conf
file to) to include ns-wcal-schema.conf. Stop the Calendar
Server if it's running, then stop and restart the Directory Server,
then start the Calendar Server.
Chapter 4: Installing
iPlanet Calendar Server 2.0
This chapter contains the following sections:
Running the Setup Program
Create a directory (such as /tmp/calsvr) on the machine that will
host the Calendar Server and download (or copy) the iPlanet Calendar Server
archive file to that directory. Make sure that the download directory has
adequate disk space for unzipping/untarring the file. Go to the directory
where you copied the archive file and extract the contents. On Unix,
type:
gunzip -c archive.tar.gz | /usr/bin/tar xvf -
where archive identifies the name of the platform archive file
you chose to download.
Note: On UNIX, you must use /usr/bin/tar. This
should be the tar utility that is distributed with your operating system
and not a third party tar, such as gnu.
The installation directory in which you untarred the Calendar Server
files, contains the setup installation program on Unix.
Note: The installation steps below describe a custom
installation which requires that you supply answers to all of the configuration
options involved in the installation process. If you choose a Typical installation,
the program will skip some of the following questions because they are
configured for you.
To install Calendar Server, follow these steps:
-
Review the contents of the license agreements included with the software.
As part of the installation process, you will be asked if you agree to
the terms listed in this file.
-
Login as or setuid to root. You must have superuser privileges (that is,
be logged in as root or administrator) to run the installation program.
-
Go to the directory where you downloaded and unzipped
the installation files.
-
To run the java graphical installation program type: ./setup
The installation program displays a Welcome Message.
-
Click "Next" to continue. The license agreement is displayed.
-
Read the license agreement and click "Next" to accept it and continue.
-
Select the type of installation you wish to use. The same software is installed
with each type of installation. The difference between the types of installations
is the number of choices you have to make during the installation process:
-
Typical Installation. This type of installation is the simplest to run,
but provides the fewest configuration options. This is the default
installation type. For a complete list of these options, see Typical
Installation Checklist.
-
Custom Installation. This type of installation provides more configuration
options and is intended for advanced users only. For a complete list of
these options, see
Custom Installation Checklist.
-
Select the software that you want to install. The default is to install
Calendar Server and API software.
Note: The following instructions assume that you install both
Calendar Server and Calendar Server API components.
-
Specify the directory where you want to install the Calendar Server software,
for example, /opt.
-
Specify the TCP port numbers that you wish the Calendar Server services
to listen on.
-
Enter the user and group on behalf of whom the Calendar Server will run.
-
Specify the Calendar master enduser administrator. This is the user which
has privileges for the calendar server admin utilities, such as csstart
and csstop.
-
Select the options for automatically starting the Calendar server.
Choose between starting the server after successful installation and/or
starting the server on system startup. If you do not wish to start
the server after the installation or upon server startup then uncheck both
boxes.
-
Enter the full email address of the administrator for this Calendar server
installation and the name of the system running the SMTP server.
Also choose whether you want to enable the email alarms for the Calendar
server.
-
Specify the location where you want temporary files created by the Calendar
Server to be placed (custom installation only).
-
Enter the LDAP server information for user authentication (custom
installation only).
-
Identify the following LDAP server information for user authentication
and preferences:
-
Host: Host machine where the LDAP Server resides.
-
Port: Service port for the LDAP server. The default is 389.
-
Base DN: the Base DN (distinguished name) of the LDAP server installation.
-
Administrator Bind DN: the DN (distinguished name) of the
account which has write access to the Configuration Server Directory. The
default is: uid=admin,ou=Administrators,ou=TopologyManagement,o=NetscapeRoot
-
Administrator Password: The password for LDAP server administrator.
Note: If the installation program does not detect an
LDAP server running on the specified port, a message box will appear stating
that the Calendar server will not run if an LDAP server is not available.
If this is acceptable, click Accept. Otherwise, click Choose New
and re-enter LDAP configuration parameters.
-
(Custom installation only.) Select desired
values for the following system resources: Maximum sessions (default is
5000) Maximum threads (default is 1000) Number of server processes (default
is 1).
-
(Custom installation only.) Specify the directory
to place the server database..
-
The installation verifies adequate disk space and then returns ready to
install the server software. To complete the Calendar server
installation click "Install Now".
Command Line
Installation
iPlanet Calendar Server 2.0 provides
you the option of running the installation script without using the graphical
interface. To run the command line installation program, you would
first follow the same steps described above to unzip and untar the calendar
archive file. Then, type the setup command (step 4 above) as
follows options:
./setup -nodisplay
where the nodisplay option
tells the setup program to run from the command line. The installation
program will run in the current window and ask all of the configuration
questions described in the Running the Setup Program
section above.
Uninstalling the
Calendar Server
To uninstall iPlanet Calendar Server, follow these steps:
-
Go to the installation server-root (such as /opt)
directory and then change to the directory to SUNWicsrv/cal. The
uninst
script resides in this location. (It can be run without options if you
want to use the java graphical interface, or as a command line script by
using the -nodisplay option as described below).
-
At the command line enter./uninst
-
The program displays instructions on how to disable client access control.
Press Enter to continue.
-
The java uninstaller window will appear. Click Next to continue.
-
Choose between a Full or a Partial uninstall. The Full uninstall
removes all of the binaries (Calendar Server Software and Calendar Server
API). The Partial uninstall lets you choose between uninstalling
either the Calendar Server Software, the Calendar Server API, or both.
-
Click Uninstall Now to proceed with the uninstallation.
The command line version of the uninstallation programs proceed in the
same way as the the java GUI version. To run the command line uninstallation
program, enter:
./uninst -nodisplay
When prompted, enter the appropriate number for the options given.
Important Notes
The installation program uses the unix command /usr/bin/domainname
to identify the associated domain name of your system. To verify that this
setting is correct, at the command prompt type:
domainname
This command should return the domain name of your system correctly.
If this is not the case, set the domain name by typing:
domainname <your system domain name>
-
To customize the bundled Calendar Express to use your company logo, your
company name, etc., use the Perl script provided in the uicust directory.
You must have Perl5.004 or later to
use this script.
-
We have encountered systems where the value returned by hostname
could not be used in the IP addresses associated with that system. That
is, the machines name was x.example.com, but TCP/IP applications
had to use y.example.com to connect to it. We believe this to
be a badly configured machine. If you install this product on a such a
machine, entries in the server.conf file may have incorrect values.
Ideally, the machine should be reconfigured. If you cannot change the configuration
of the machine, you will have to edit the server.conf file explicitly
(using vi, emacs, etc) to correct the hostname values. Additionally, there
are several properties with property names containing "host" and
"hostname" that have null values. The null value signals the server
to use the value returned by gethostname(3C). You will have to
add the host name recognized by the TCP/IP subsystem as a value for these
properties.
Copyright
1999 Sun Microsystems, Inc. Some preexisting portions Copyright ©
Netscape Communications Corp. All rights reserved.
