Chapter 3 Configuring Calendar Server

Previous Contents Index Next
Sun Java System Calendar Server Administration Guide

Chapter 3
Configuring Calendar Server

After you install Calendar Server, and before running it, you must configure it. It is important that you run the two configuration programs in the following order:

comm_dssetup.pl – Configure the LDAP directory server as instructed in Chapter 2, "Configuring Your LDAP Directory".

csconfigurator.sh – Configure Calendar Server as described in this chapter.

This chapter contains the following topics:

Gathering Your Configuration Information

Running csconfigurator.sh

Note

If you had an earlier version of Calendar Server or Messaging Server installed, you might need to migrate your LDAP directory entries from Schema 1 to Schema 2.

DO NOT run the configuration utility described in this chapter until you have read the Sun Java System Communications Services 6 2004Q2 Schema Migration Guide. It will instruct you on the timing and options for running the configuration utilities. This guide can be found at:

http://docs.sun.com/coll/CalendarServer_04q2

Gathering Your Configuration Information

The Calendar Server configuration program csconfigurator.sh, creates a new ics.conf configuration file in the following directory:

/etc/opt/SUNWics5/config

The configuration program will ask you many questions for which you must enter specific information about your installation.

Before running the configuration program, you should gather the following configuration information:

Administration, User Preferences and Authentication Options

Email and Email Alarms Options

Runtime Configuration Options

Database, Logs, and Temporary Files Directories

To help you keep track of the configuration information, use the worksheets in Appendix B, "Calendar Server Configuration Worksheet". (However, you should determine this information before you run the Java Enterprise System installer to avoid conflicts (such as port numbers) with other component products.)

Administration, User Preferences and Authentication Options

User Preferences Directory

Sun Java System Calendar Server requires a directory server for user authentication and for the storage and retrieval of user preferences.

Table 3-1  User Preferences Directory Options

Option

Description

LDAP Server Host Name

Host name of the LDAP directory server you are using for user authentication and user preferences. The default is the current host.

LDAP Server Port

Port number that the LDAP directory server listens on. The default is 389.

Base DN

Entry in the LDAP directory used as the starting point from which searches will occur. The default is o=currentdomain.

Directory Manager DN

User name that can make changes in the directory server schema. The default is cn=Directory Manager.

Directory Manager Password

Password of the Directory Manager DN. There is no default.

Calendar Server Administrator

The Calendar Server Administrator is the user account that overrides any other Calendar Server ACLs. The Calendar Server Administrator user account must exist in your user authentication directory server. It is also used for proxy authentication.

Table 3-2  Calendar Server Administrator Options

Option

Description

Administrator User ID

User ID of the Calendar Server Administrator; must be a user in the above LDAP directory server. The default is calmaster.

Administrator Password

Password of the Calendar Server Administrator. There is no default.

Email and Email Alarms Options

You can configure Calendar Server to send an email alarm message to a Calendar Server Administrator in case a server problem occurs.

Table 3-3  Email and Email Alarms Options

Option

Description

Email Alarms

Enables or disables email alarms. The default is Enabled.

Administrator Email Address

Email address of the Calendar Server Administrator who will receive the email alarm messages.

SMTP Host Name

Host name of the SMTP server where Calendar Server sends the email alarm messages. The default is the current host.

Runtime Configuration Options

You can configure the following Calendar Server runtime and system resource options.

Table 3-4  Runtime Configuration Options

Option

Description

Service Port

Port number that Calendar Server listens on to provide Web (HTTP) access to users. The default is 80.

Maximum Sessions

Maximum number of Calendar Server sessions to allow concurrently. The default is 5000.

Maximum Threads

Maximum number of Calendar Server threads to allow concurrently. The default is 20.

Number of Server Processes

Maximum number of Calendar Server processes to run concurrently. The default is the number of CPUs on the server where you are installing Calendar Server.

Runtime User ID

UNIX user name under which Calendar Server will run. This user name should not be root. If the account does not exist, the configuration program will create it. The default is icsuser.

Runtime Group ID

UNIX group under which Calendar Server will run. If the group does not exist, the configuration program will create it. The default is icsgroup.

Calendar Server Startup

You can configure the following options to automatically start Calendar Server.

Table 3-5  Calendar Server Startup Options

Option

Description

Start after successful installation

Whether to start Calendar Server automatically after a successful installation. The default is checked.

Start on system startup

Whether to start Calendar Server automatically after a system startup. The default is checked.

Database, Logs, and Temporary Files Directories

Calendar Server creates and stores information in calendar database files, log files, and temporary files in specific directories.

Table 3-6  Database, Logs, and Temporary Files Directories Options

Option

Description

Database Directory

Directory where Calendar Server should create and store the calendar database (*.db) files. The default is:

/var/opt/SUNWics5/csdb

Logs Directory

Directory where Calendar Server writes log files. The default is:

/var/opt/SUNWics5/logs

Temporary Files Directory

Directory where the Calendar Server writes temporary files. The default is:

/var/opt/SUNWics5/tmp

Note

Do not change the location or names of the logs and temporary files directories.

Running csconfigurator.sh

The configuration program uses a graphical user interface (GUI). If you run the program remotely, you must set your DISPLAY environment variable properly and allow X-Windows connections from the server to display on your computer. For example, to use the xhost utility, execute the following command on your computer: xhost +.

To run the configuration program, login as or become superuser (root) and change to the /opt/SUNWics5/cal/sbin directory. Then, issue this command:

# sh ./csconfigurator.sh

The configuration program displays the following series of panels:

Welcome Panel

Administration, User Preferences and Authentication Panel

Email and Email Alarms Panel

Runtime Configuration Panel

Select Directories Panel

Ready to Configure Panel

Configuration Summary Panel

Caution

The configuration program only configures a single domain. If you plan to use multiple domains (virtual domains, hosted domains), you need to add the domains using the User Management Utility.

Welcome Panel

Figure 3-1  Calendar Server Configuration Program Welcome Panel

Click Next to continue or Cancel to exit.

Administration, User Preferences and Authentication Panel

Figure 3-2  Calendar Server Configuration Program Administration, User Preferences and Authentication Panel

User Preferences Directory Options

LDAP Server Host Name–Host name of the LDAP directory server you are using for user authentication. Default: current host

LDAP Server Port–Port number that the LDAP server listens on. Default: 389

Base DN–Entry in the LDAP directory used as the starting point from which searches will occur. Default: o=currentdomain. This can be modified to fit your deployment needs.

To retrieve the root suffix created by comm_dssetup.pl, click Get. The baseDN obtained this way is only a suggestion created from the current settings. Whatever you use for the baseDN, it must be consistent with the LDAP content.

Note Before you click Get, you must enter the Directory Manager DN and password to authenticate to the directory server.

Directory Manager DN–User name that can make changes in the directory server schema. Default: cn=Directory Manager.

Directory Manager Password–Password of the Directory Manager. Default: None

Calendar Server Administrator Options

Administrator User ID–User ID of the Calendar Server Administrator; must be a user in the above LDAP directory server. Default: calmaster

Administrator Password–Password of the Calendar Server Administrator. Default: None

Click Next to continue, Back to return to the previous panel, or Cancel to exit.

Email and Email Alarms Panel

Figure 3-3  Calendar Server Configuration Program Email and Email Alarms Panel

Email Alarms–Specifies whether Calendar Server should send an email alarm message to a Calendar Server administrator in case a server problem occurs. Default: Enabled.

Administrator Email Address–Email address of the Calendar Server Administrator who will receive the email alarm messages. Default: None.

SMTP Host Name–Host name of the SMTP server where email alarm messages should be sent. Default: current host.

Click Next to continue, Back to return to the previous panel, or Cancel to exit.

Runtime Configuration Panel

Figure 3-4  Calendar Server Configuration Program Runtime Configuration Panel

Service Port–Port number that Calendar Server listens on to provide Web (HTTP) access to users. Default: 80.

Maximum Sessions–Maximum number of concurrent Calendar Server sessions. Default: 5000

Maximum Threads–Maximum number of concurrent Calendar Server threads. Default: 20

Number of Server Processes–Maximum number of Calender Server processes to run on the server. Default: Number of CPUs on the server where you are installing Calendar Server

Runtime User ID–UNIX user name under which Calendar Server will run. This name should not be root. If the account does not exist, the configuration program will create it. Default: icsuser

Runtime Group ID–UNIX group under which Calendar Server will run. If the group does not exist, the configuration program will create it. Default: icsgroup

Calendar Server Startup Options

Start after successful installation–Specifies whether to start Calendar Server automatically after a successful installation. Default: checked

Start on system startup–Specifies whether to start Calendar Server automatically after a system startup. Default: checked

Click Next to continue, Back to return to the previous panel, or Cancel to exit.

Select Directories Panel

Figure 3-5  Calendar Server Configuration Program Select Directories Panel

Config Directory – Directory where the configuration file (ics.conf) is stored.

Database Directory – Directory where Calendar Server should create and store the calendar database files. Default: /var/opt/SUNWics5/csdb

Logs Directory – Directory where Calendar Server writes log files. Default: /var/opt/SUNWics5/logs

Temporary Files Directory – Directory where the Calendar Server writes temporary files. Default: /var/opt/SUNWics5/tmp

For each directory, you can accept the default directory, type the full path of another directory, or click Browse... and choose a directory. Then, Click Next to continue, Back to return to the previous panel, or Cancel to exit.

Ready to Configure Panel

Figure 3-6  Calendar Server Configuration Program Ready to Configure Panel

Click Configure Now to configure Calendar Server, Back to return to the previous panel, or Cancel to exit.

Configuration Summary Panel

Figure 3-7  Calendar Server Configuration Program Summary Panel

Click Details... to view the details of the configuration log or Close to exit the configuration program.

Previous      Contents      Index      Next

Copyright 2004 Sun Microsystems, Inc. All rights reserved.


Note	If you had an earlier version of Calendar Server or Messaging Server installed, you might need to migrate your LDAP directory entries from Schema 1 to Schema 2. DO NOT run the configuration utility described in this chapter until you have read the Sun Java System Communications Services 6 2004Q2 Schema Migration Guide. It will instruct you on the timing and options for running the configuration utilities. This guide can be found at: http://docs.sun.com/coll/CalendarServer_04q2

Option	Description
LDAP Server Host Name	Host name of the LDAP directory server you are using for user authentication and user preferences. The default is the current host.
LDAP Server Port	Port number that the LDAP directory server listens on. The default is 389.
Base DN	Entry in the LDAP directory used as the starting point from which searches will occur. The default is o=currentdomain.
Directory Manager DN	User name that can make changes in the directory server schema. The default is cn=Directory Manager.
Directory Manager Password	Password of the Directory Manager DN. There is no default.

Option	Description
Administrator User ID	User ID of the Calendar Server Administrator; must be a user in the above LDAP directory server. The default is calmaster.
Administrator Password	Password of the Calendar Server Administrator. There is no default.

Option	Description
Email Alarms	Enables or disables email alarms. The default is Enabled.
Administrator Email Address	Email address of the Calendar Server Administrator who will receive the email alarm messages.
SMTP Host Name	Host name of the SMTP server where Calendar Server sends the email alarm messages. The default is the current host.

Option	Description
Service Port	Port number that Calendar Server listens on to provide Web (HTTP) access to users. The default is 80.
Maximum Sessions	Maximum number of Calendar Server sessions to allow concurrently. The default is 5000.
Maximum Threads	Maximum number of Calendar Server threads to allow concurrently. The default is 20.
Number of Server Processes	Maximum number of Calendar Server processes to run concurrently. The default is the number of CPUs on the server where you are installing Calendar Server.
Runtime User ID	UNIX user name under which Calendar Server will run. This user name should not be root. If the account does not exist, the configuration program will create it. The default is icsuser.
Runtime Group ID	UNIX group under which Calendar Server will run. If the group does not exist, the configuration program will create it. The default is icsgroup.

Option	Description
Start after successful installation	Whether to start Calendar Server automatically after a successful installation. The default is checked.
Start on system startup	Whether to start Calendar Server automatically after a system startup. The default is checked.

Option	Description
Database Directory	Directory where Calendar Server should create and store the calendar database (*.db) files. The default is: /var/opt/SUNWics5/csdb
Logs Directory	Directory where Calendar Server writes log files. The default is: /var/opt/SUNWics5/logs
Temporary Files Directory	Directory where the Calendar Server writes temporary files. The default is: /var/opt/SUNWics5/tmp


Note	Do not change the location or names of the logs and temporary files directories.


Caution	The configuration program only configures a single domain. If you plan to use multiple domains (virtual domains, hosted domains), you need to add the domains using the User Management Utility.