Calendar Server 6.3 Initial Runtime Configuration Program

h1. {anchor:ACACR} Initial Runtime Configuration Program for Calendar Server 6.3 Software (csconfigurator.sh)

This chapter contains the following topics:
{toc:minLevel=2|maxLevel=2}
{info:title=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 version 1 to Schema version 2.

Do not run the configuration utility described in this chapter until you have read the [_Sun Java Communications Suite 5 Schema Migration Guide_|http://docs.sun.com/doc/819-4436]. It will instruct you on the timing and options for running the configuration utilities.
{info}

h2. {anchor:ACACS} Gathering Your Configuration Information for Calendar Server 6.3 Software

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

For Solaris: _cal-svr-base_{{/config}}

For Linux: _cal-svr-base_{{/config}}

The configuration program will ask you many questions for which you must enter specific information about your installation. Use the [Calendar Server Worksheet|Configuration Worksheets - Calendar Server] to gather your information before running the configuration program. (You should determine this information before you run the install any Communications Suite or Java ES components to avoid conflicts (such as port numbers) with other component products.)
{excerpt:hidden=true}

h3. {anchor:ACACT} LDAP Server Options

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

h6. {anchor:FUNJZ} 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. |

h3. {anchor:ACACU} Directory Manager Options

The following table lists the options used to gather the name and password of the user that is designated the Directory Manager.

h6. {anchor:FUNJT} Directory Manager Options

|| Option || Description ||
| 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. The password is not stored. There is no default. |

h3. {anchor:ACACV} 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. The following table lists the options used to gather the Calendar Server Administrator's user ID and password.

h6. {anchor:FUNJV} 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. |

h3. {anchor:ACACW} 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. The following table lists the options used to gather email information.

h6. {anchor:FUNJR} 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 used by the Calendar Server system to send email alarm messages. The default is the current host. |

h3. {anchor:ACACX} Runtime Configuration Options

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

h6. {anchor:FUNJX} 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 | For Solaris: 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. \\
\\ *For Linux:* Only one process can run at a time. |
| 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}}. |

h3. {anchor:ACACY} Calendar Server Startup

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

h6. {anchor:FUNJQ} 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. |

h3. {anchor:ACACZ} Database, Logs, and Temporary Files Directories

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

h6. {anchor:FUNJN} Database, Logs, and Temporary Files Directories Options

|| Option || Description ||
| Database Directory | Directory where the Calendar Server system creates and stores 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 system writes temporary files. The default is: \\
\\ {{/var/opt/SUNWics5/tmp}} |
| Archive and hot backup Directories | Directory where the Calendar Server system writes archive backups. User defined directory for storing the daily snapshot and transactions logs. If both types of backups are desired, then place them in different directories. If no directory is specified, backups are stored in the current directory. |
| Attachment Store Directory | Directory where the Calendar Server system stores attachments to events and tasks. |{excerpt}

h2. {anchor:ACADA} Running csconfigurator.sh

You can run the configuration program from a graphical user interface (GUI), or from the command line.

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 +}}

This section contains the following topics:
* [To Run the Configuration Program from the Command Line|#FUNKK]
* [To Run the Configuration Program from the GUI|#FUNJY]

h6. {anchor:FUNKK} To Run the Configuration Program from the Command Line

# Log in as or become superuser ({{root}}).
# Change to the _cal-svr-base_{{/sbin}} directory.
# Run the script using the options chosen from the following table:
|| Option || Description ||
| \-nodisplay | Run the configuration script in text-only mode (non-GUI). |
| \-noconsole | Do not display text output. Use this with \-nodisplay to run the configuration script in silent mode. |
| \-novalidate | Do not validate input field text. |
| \-saveState _statefile_ | Save the answers that you input in response to configuration questions to a state file (text file). Unless you specify a fully qualified path for the state file, it will be saved in the default directory: {{/opt/SUNWics5/cal/jconfigure}}. |
| \-state _statefile_ | Use the state file for setting input values. This option must be used in conjunction with {{\-novalidate}} and {{\-noconsole}}. |
For example, to run the configuration script in command-line mode, issue the following command:

{{./csconfigurator.sh \-nodisplay}}

The command-line version asks for the same information and in the same order as the GUI. Default values are indicated in square brackets,{{\[\]}}. To accept a default value, press Enter on your keyboard.
{info:title=Note}For the text of the information contained in the various questions presented by the script, refer to the [Calendar Server Worksheet|Configuration Worksheets - Calendar Server] or see the text in the GUI section that follows.
{info}

h6. {anchor:FUNJY} To Run the Configuration Program from the GUI

# Log in as or become superuser ({{root}}).
# Change to the _cal-svr-base_{{/sbin}} directory.
# Run the command:
\\
\\ {{./csconfigurator.sh}}
The configuration program displays the Welcome Screen.
{note:title=Caution}The configuration program only configures a single domain. If you plan to use multiple domains, you need to add the domains using Delegated Administrator.
{note}
# Click Next to continue or Cancel to exit.
The Administration, User Preferences and Authentication Screen appears.
# Type your information and click Next.
The User Preferences Directory Options Screen appears.
# Type your information and click Next.
Use the following information for assistance in filling out this screen.
{section}
{column:width=15%}LDAP Server Host Name
{column}
{column:width=85%}Host name of the LDAP directory server you are using for user authentication. Default: current host
{column}
{section}
{section}
{column:width=15%}LDAP Server Port
{column}
{column:width=85%}Port number that the LDAP server listens on. Default: {{389}}
{column}
{section}
{section}
{column:width=15%}Directory Manager DN
{column}
{column:width=85%}User name that can make changes in the directory server schema. Default: {{cn=Directory Manager}}
{column}
{section}
{section}
{column:width=15%}Directory Manager Password
{column}
{column:width=85%}Password of the Directory Manager. This will not be stored in plain text. Default: None
{column}
{section}The Virtual Domains and Calendar Administrator Screen appears.
# Type your information and click Next.
Use the following information for assistance in filling out this screen.
{info:title=Note}Virtual domains, hosted domains and multiple domains are all names for the same ability to have more than one LDAP domain with its corresponding user and group records.
{info}If you are upgrading from a non-virtual domain environment, the Enable Virtual Domains Support checkbox must be selected. If you already have a multiple domain environment, the checkbox is greyed out. Virtual domains support is now the default behavior of Calendar Server, and is not optional.
*Figure 2-1 Virtual Domain Structure*
!CommSuite:Communications Suite Attachments^csagCreatingHostedDomains2.gif|alt="This figure shows the default virtual domain structure for Calendar Server."!
\\
Virtual domains support is now the default behavior for Calendar Server for fresh installations. Using the configuration program graphical user interface, enter a default domain name in the New Default domain input box. The configuration program then creates the domain for you.
\\
\\Choose your default domain from one of those showing in the Default domain box. If you already used multiple domains in the previous version of Calendar Server, and you do not want to use the domain showing in the Default domain box, click the box to see the list of domains you can choose from and select a new default domain.
The Calendar Administrator Name and Password Screen appears.
# Type your information and click Next.
Use the following information for assistance in filling out this screen.
{section}
{column:width=15%}Username
{column}
{column:width=85%}Username of the Calendar Server Administrator. Default: {{calmaster}}
{column}
{section}
{section}
{column:width=15%}Administrator Password
{column}
{column:width=85%}Password of the Calendar Server Administrator. Default: {{None}}
{column}
{section}
{section}
{column:width=15%}Email Address
{column}
{column:width=85%}Email address for the Calendar Server Administrator.
{column}
{section}
{section}
{column:width=15%}Site Administrator
{column}
{column:width=85%}The Site Administrator is the user that has proxy authentication rights across domains.
\\
\\
Click the appropriate response: {{Yes}} if the Calendar Administrator is also the Site Administrator. {{No}} if the Calendar Administrator is not the Site Administrator.
{column}
{section}The Email and Email Alarms Screen appears.
# Type your information and click Next.
Use the following information for assistance in filling out this screen.
{section}
{column:width=15%}Email Alarms
{column}
{column:width=85%}Specifies whether Calendar Server should send an email alarm message to a Calendar Server administrator in case a server problem occurs. Default: {{disabled}}. If you choose {{Disabled}}, no administrator receives email alarms for server problems.
{column}
{section}
{section}
{column:width=15%}Administrator Email Address
{column}
{column:width=85%}Email address of the Calendar Server Administrator who will receive the email alarm messages. Default: {{None}}
{column}
{section}
{section}
{column:width=15%}SMTP Host Name
{column}
{column:width=85%}Host name of the SMTP server where used to send alarm messages. Default: {{current host}}.
{column}
{section}The Runtime Configuration Screen appears.
# Type your information and click Next.
Use the following information for assistance in filling out this screen.
{section}
{column:width=15%}Service Port
{column}
{column:width=85%}Port number that Calendar Server listens on to provide Web (HTTP) access to users. Default: {{80}}.
{column}
{section}
{section}
{column:width=15%}Maximum Sessions
{column}
{column:width=85%}Maximum number of concurrent Calendar Server sessions. Default: {{5000}}
{column}
{section}
{section}
{column:width=15%}Maximum Threads
{column}
{column:width=85%}Maximum number of concurrent Calendar Server threads. Default: {{20}}
{column}
{section}
{section}
{column:width=15%}Number of Server Processes
{column}
{column:width=85%}Maximum number of Calendar Server processes to run on the server. Default: Number of CPUs on the server where you are installing Calendar Server.
{column}
{section}
{section}
{column:width=15%}Runtime User ID
{column}
{column:width=85%}UNIX user name under which Calendar Server will run. If the account does not exist, the configuration program will create it. Default: {{icsuser}}
{note:title=Caution}Do not use {{root}} as the Runtime User ID.
{note}
{column}
{section}
{section}
{column:width=15%}Runtime Group ID
{column}
{column:width=85%}UNIX group under which Calendar Server will run. If the group does not exist, the configuration program will create it. Default: {{icsgroup}}
{column}
{section}
{section}
{column:width=15%}Calendar Server Startup Options
{column}
{column:width=85%}Select one or both options by clicking in the check box.
* Start after successful configuration
\\
\\
Specifies whether to start Calendar Server automatically after this configuration program successfully finishes running.
* Start on system startup
\\
\\
Specifies whether to start Calendar Server automatically after a system startup.
{info:title=Note}By default, only the Start on system startup checkbox is selected.
{info}
{column}
{section}The Set Up a Front End-Back End Deployment Screen appears.
# Choose whether to configure this server as a single server deployment, or a front-end, back-end deployment. If you choose to have a single server instance of Calendar Server, do not select the check box on this screen. If you want to put your Calendar Server databases on one or more servers, while keeping the processes that communicate with the client on a different server, select the check box. \\
\\For instructions on how to configure an instance of Calendar Server as a front end or a back end server, see [Configuring a Front End or Back End Calendar Server|CSFrontEndDeployment].\\
The Directories to Store Configuration and Data Files Screen appears.\\
\\
# Accept the default directories on this screen. While you are allowed to choose the store configuration and data files directories, it is not advised.
Click Next to continue. The Select Directories Configuration Screen appears.
# Type your information and click Next.
Use the following information for assistance in filling out this screen.
{section}
{column:width=15%}
Config Directory
{column}
{column:width=85%}
Directory where the configuration file ({{ics.conf}}) resides.
{column}
{section}
{section}
{column:width=15%}
Database Directory
{column}
{column:width=85%}
Directory where Calendar Server creates and stores the calendar database files. Default: {{/var/opt/SUNWics5/csdb}}
{column}
{section}
{section}
{column:width=15%}
Attachment Store Directory
{column}
{column:width=85%}
Directory where the attachment store resides. Default: {{/var/opt/SUNWics5/astore}}
{column}
{section}
{section}
{column:width=15%}
Logs Directory
{column}
{column:width=85%}
Directory where Calendar Server writes log files. Default: {{/var/opt/SUNWics5/logs}}
{column}
{section}
{section}
{column:width=15%}
Temporary Files Directory
{column}
{column:width=85%}
Directory where the Calendar Server writes temporary files. Default: {{/var/opt/SUNWics5/tmp}}
{column}
{section}
{info:title=Note}
If any of these directories do not already exist, a pop-up window appears for each missing directory. Click the appropriate button to choose whether to have the configuration program create the new directory, or to return you to the screen where you can choose a different directory.
\\
\\
For any directory that already exists but is not empty, a pop-up window appears with two choices. Click the appropriate button to accept the directory anyway, or to return to the screen where you can choose a different directory.
{info}
The Archive and Hot Backup Configuration Screen appears.
# Type your information and click Next.
This screen enables you to select both automatic backup types, or either one of the two, or none. Select or deselect the boxes appropriately. Using both archive backups and hot backups is strongly recommended.
{info:title=Tip}
Prevent the catastrophic loss of all your database copies due to an equipment failure. Keep your automatic backup copies on a disk or disk system other than the one where your live databases reside.
{info}
For information on automatic backups, see "Chapter 9, Configuring Automatic Backups (csstored)" in the _Sun Java System Calendar Server 6.3 Administration Guide_.
The Archive and hot backup Configuration Screen appears.
# Type your information and click Next.
Use the following information for assistance in filling out this screen.
{section}
{column:width=15%}
Enable Archive
{column}
{column:width=85%}
When this box is selected (default), {{csstored}} will take a snapshot of your calendar databases every 24 hours. Throughout the day, at regular intervals, it stores the transaction log files for that day with the snapshot in the archive backup directory.
\\
\\
If this box is not checked, the Archive Directory input field is greyed out.
{column}
{section}
{section}
{column:width=15%}
Archive Directory
{column}
{column:width=85%}
Choose the backup directory by clicking Browse, or accept the default.
{column}
{section}
{section}
{column:width=15%}
Enable Hot Backup
{column}
{column:width=85%}
When this box is selected (default), {{csstored}} takes a snapshot of your calendar databases every 24 hours, then applies the transaction logs to the snapshot at a set interval (default is two minutes), throughout the day, ensuring a nearly complete duplicate of your live database.
\\
\\
If this box is not checked, the Hot Backup Directory input field is greyed out.
{column}
{section}
{section}
{column:width=15%}
Hot Backup Directory
{column}
{column:width=85%}
Choose the backup directory by clicking Browse, or accept the default.
{column}
{section}
{section}
{column:width=15%}
Keep Archives for (in days)
{column}
{column:width=85%}
This field is only active if the Enable Archive box is selected; otherwise, it is greyed out.
\\
\\
Click the up or down arrows in the Minimum and Maximum fields to select range of days of archival backups to keep in the backup directory.
{column}
{section}
{section}
{column:width=15%}
Keep Hot Backups for (in days)
{column}
{column:width=85%}
This field is only active if the Enable Hot Backup box is selected; otherwise, it is greyed out.
You can set the number of hot backups to keep in two ways:
* Click the up or down arrows in the Minimum and Maximum fields to select the range of days of hot backups to keep in the directory.
\\
\\
The number of copies actually stored at any one time depends on the size of the files and the size of the directory. When either the size limits, or maximum number of copies exceeds the limit, the oldest copies are purged down to the minimum number specified on this configuration screen.
* If you want the same settings for Hot Backups as for Archival Backups, you can check the Same As Archive box.
{column}
{section}
The Ready to Configure Screen appears.
# Click Configure Now to configure Calendar Server.
Up to now the screens have been gathering data needed for the configuration and performing some validity checking. You can go back and redo the configuration information at this point, or start the configuration.
The Sequence Completed Screen appears.
This panel provides a running update of all the tasks and the disposition (passed or failed). When the message "All Tasks Passed", the configuration has finished. Check the log files indicated to see if there are any error messages.
\\
\\
# Click Next when the configuration program completes.
The Configuration Summary Screen appears.
# Click Details to view the details of the configuration log or Close to exit the configuration program.

h2. {anchor:gfxeg} Automatic Base 64 Encoding of Passwords for Calendar Server 6.3
\\In the past, the Calendar Server configuration file had some passwords in clear text. Though there are read permission restrictions on {{ics.conf}}, someone can see the passwords when the Administrator is editing the configuration file. In Calendar Server 6.3, the passwords have been moved to another file and obfuscated by base 64 encoding them. This will prevent someone from seeing the passwords accidentally. Since no encryption is done, the file must still be read protected and prevented from falling into the wrong hands to keep the passwords secure.\\
\\If you are installing Calendar Server for the first time, the configuration program encodes the passwords you create during the configuration process, and stores them in a separate password configuration file. \\
\\If you are upgrading your existing Calendar Server software to the Calendar Server 6.3 version, the configuration program encodes the existing passwords found in the {{ics.conf}} file, and moves them to the password configuration file. \\
\\In both cases, the configuration program also adds a new {{ics.conf}} parameter to indicate the location of the password file, as shown in the following example:\\
\\ {{local.passwordfile="/etc/opt/SUNWics5/config/icspassword.conf"}}
\\It is not advisable to change this configuration parameter.\\
\\The configuration parameters moved out of ics.conf due to this change are the following:
* {{local.authldapbindcred}}
* {{local.enduseradmincred}}
* {{local.lookupldapbindcred}}
* {{service.siteadmin.cred}}
{info:title=Note}
The LDAP bind passwords that are generated by the configurator are re-generated each time the configurator is run, once they are moved out of the {{ics.conf}} file.
{info}