Calendar Server 6.3 Initial Runtime Configuration Program

Skip to end of metadata
Go to start of metadata

Initial Runtime Configuration Program for Calendar Server 6.3 Software (csconfigurator.sh)

After you configure Calendar Server after installing the Calendar Server softare, and before using it, run the two configuration programs in the following order:

  1. comm_dssetup.pl
    Configure the LDAP directory server.
  2. csconfigurator.sh
    Configure Calendar Server as described in this chapter.

This chapter contains the following topics:

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. It will instruct you on the timing and options for running the configuration utilities.

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 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.)

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
  1. Log in as or become superuser (root).
  2. Change to the cal-svr-base/sbin directory.
  3. 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.

Note
For the text of the information contained in the various questions presented by the script, refer to the Calendar Server Worksheet or see the text in the GUI section that follows.
To Run the Configuration Program from the GUI
  1. Log in as or become superuser (root).
  2. Change to the cal-svr-base/sbin directory.
  3. Run the command:

    ./csconfigurator.sh
    The configuration program displays the Welcome Screen.
    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.
  4. Click Next to continue or Cancel to exit.
    The Administration, User Preferences and Authentication Screen appears.
  5. Type your information and click Next.
    The User Preferences Directory Options Screen appears.
  6. Type your information and click Next.
    Use the following information for assistance in filling out this screen.

    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

    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. This will not be stored in plain text. Default: None

    The Virtual Domains and Calendar Administrator Screen appears.

  7. Type your information and click Next.
    Use the following information for assistance in filling out this screen.
    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.

    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
    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.

  8. Type your information and click Next.
    Use the following information for assistance in filling out this screen.

    Username

    Username of the Calendar Server Administrator. Default: calmaster

    Administrator Password

    Password of the Calendar Server Administrator. Default: None

    Email Address

    Email address for the Calendar Server Administrator.

    Site Administrator

    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.

    The Email and Email Alarms Screen appears.

  9. Type your information and click Next.
    Use the following information for assistance in filling out this screen.

    Email Alarms

    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.

    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 used to send alarm messages. Default: current host.

    The Runtime Configuration Screen appears.

  10. Type your information and click Next.
    Use the following information for assistance in filling out this screen.

    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 Calendar 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. If the account does not exist, the configuration program will create it. Default: icsuser

    Caution
    Do not use root as the Runtime User ID.

    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

    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.
      Note
      By default, only the Start on system startup checkbox is selected.
    The Set Up a Front End-Back End Deployment Screen appears.

  11. 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.
    The Directories to Store Configuration and Data Files Screen appears.

  12. 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.
  13. Type your information and click Next.
    Use the following information for assistance in filling out this screen.

    Config Directory

    Directory where the configuration file (ics.conf) resides.

    Database Directory

    Directory where Calendar Server creates and stores the calendar database files. Default: /var/opt/SUNWics5/csdb

    Attachment Store Directory

    Directory where the attachment store resides. Default: /var/opt/SUNWics5/astore

    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

    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.

    The Archive and Hot Backup Configuration Screen appears.

  14. 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.
    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.

    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.

  15. Type your information and click Next.
    Use the following information for assistance in filling out this screen.

    Enable Archive

    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.

    Archive Directory

    Choose the backup directory by clicking Browse, or accept the default.

    Enable Hot Backup

    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.

    Hot Backup Directory

    Choose the backup directory by clicking Browse, or accept the default.

    Keep Archives for (in days)

    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.

    Keep Hot Backups for (in days)

    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.

    The Ready to Configure Screen appears.

  16. 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.

  17. Click Next when the configuration program completes.
    The Configuration Summary Screen appears.
  18. Click Details to view the details of the configuration log or Close to exit the configuration program.

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
    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.
Labels:
configuring configuring Delete
calendarserver calendarserver Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Oracle community and they might not be employed or in any way formally affiliated with Oracle. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Oracle nor any other party necessarily agrees with them.