Oracle® Secure Enterprise Search

1.1.1 General Requirements for Installing Oracle Software

The following sections describe the general requirements for installing Oracle software:

• Logging In to the System as root

• Required Operating System Group and User

Logging In to the System as root

Before you install Oracle software, you must complete several tasks as the root user. To log in as the root user, complete one of the following procedures:

• If you are installing the software from an X Window System workstation or X terminal, then:

  1. Start a local terminal session, for example, an X terminal (xterm).

  2. If you are not installing the software on the local system, then enter the following command to enable the remote host to display X applications on the local X server:

     $ xhost fully_qualified_remote_host_name
     
     

  3. If you are not installing the software on the local system, then use the ssh, rlogin, or telnet command to connect to the system on which you want to install the software:

     $ telnet remote_host
     
     

  4. If you are not logged in as the root user, then enter the following command to switch user to root:

     $ su - root
     
     

• If you are installing the software from a PC or other system with X server software installed, then:

  Note:

  If required, refer to your X server documentation for more information about completing this procedure. Depending on the X server software that you are using, you may need to complete the tasks in a different order.

  1. Start the X server software.

  2. Configure the security settings of the X server software to permit remote hosts to display X applications on the local system.

  3. Connect to the remote system on which you want to install the software and start a terminal session on that system, for example, an X terminal (xterm).

  4. If you are not logged in as the root user on the remote system, then enter the following command to switch user to root:

     $ su - root
     
     

Required Operating System Group and User

Depending on whether this is the first time Oracle software is being installed on this system and on the products that you are installing, you may need to create the following operating system group and user:

• Oracle Inventory group (typically, oinstall)

  You must create the Oracle Inventory group the first time you install Oracle software on the system. The usual name chosen for this group is oinstall. This group owns the Oracle inventory, which is a catalog of all Oracle software installed on the system.

  Note:

  If Oracle software is already installed on the system, then the existing Oracle Inventory group must be the primary group of the operating system user that you use to install new Oracle software.

• Oracle software owner user (typically, oracle)

  You must create the Oracle software owner user the first time you install Oracle software on the system. This user owns all of the software installed during a given installation. This user must have the Oracle Inventory group as its primary group.

  Note:

  In Oracle documentation, the Oracle software owner user is referred to as the oracle user.

A single Oracle Inventory group is required for all installations of Oracle software on the system. After the first installation of Oracle software, you must use the same Oracle Inventory group for all subsequent Oracle software installations on that system. However, you can choose to create different Oracle software owner users for different installations.

The following sections describe how to create the Oracle Inventory group and the Oracle software owner user:

• Oracle Inventory Group

• Oracle Software Owner User

Oracle Inventory Group

If Oracle software is already installed on the system, then the existing Oracle Inventory group must be the primary group of the operating system user that you use to install new Oracle software. This section describes how to identify an existing Oracle Inventory group and, if required, to create it.

When you install Oracle software on the system for the first time, Oracle Universal Installer creates the oraInst.loc file. This file identifies the name of the Oracle Inventory group and the path of the Oracle Inventory directory. To determine if the Oracle Inventory group exists, enter the following command:

more /var/opt/oracle/oraInst.loc

If the output of this command shows the oinstall group name, then the group already exists.

If the oraInst.loc file exists, then the output from this command is similar to the following:

inventory_loc=/u01/app/oracle/oraInventory
inst_group=oinstall

The inst_group parameter shows the name of the Oracle Inventory group, oinstall.

If the oraInst.loc file does not exist, then enter the following command to create the oinstall group:

# /usr/sbin/groupadd oinstall

Oracle Software Owner User

You must create an Oracle software owner user if any of the following conditions is true:

• An Oracle software owner user does not exist; for example, if this is the first installation of Oracle software on the system.

• An Oracle software owner user exists, but you want to use a different operating system user.

  Note:

  In this document, the Oracle software owner user is referred to as oracle.

To determine if an Oracle software owner user named oracle exists, enter the following command:

# id oracle

If the oracle user exists, then the output from this command is similar to the following:

uid=440(oracle) gid=200(oinstall) groups=201(dba),202(oper)

If the user exists, then determine whether you want to use the existing user or create a user. If you want to use the existing user, then ensure that the user's primary group is the Oracle Inventory group.

If the Oracle software owner user does not exist or if you require a new Oracle software owner user, then create it as follows:

1. To create the oracle user, enter a command similar to the following:

   # /usr/sbin/useradd -g oinstall[ -G dba] oracle
   
   

   In this command:

   • The -g option specifies the primary group, which must be the Oracle Inventory group, for example oinstall.

   • The -G option specifies optional secondary groups.

2. Set the password of the oracle user as follows:

   # passwd oracle
   
   

If the oracle user exists, but its primary group is not oinstall, then enter a command similar to the following, specifying the primary group using the -g option and any required secondary groups using the -G option:

# /usr/sbin/usermod -g oinstall -G dba oracle

1.1.2 Checking the Software Requirements

The system must meet the following minimum software requirements, depending on the supported Operating system version: HP-UX 11i v2 (11.23).

The following patches must be installed:

• PHSS_29658: Aries cumulative patch

• PHSS_29660: linker + fdp cumulative patch

You must install any additional recommended patches for Java SDK 1.4.2.

See the following Web site for a list of patches required by Java SDK 1.4.2:

http://www.hp.com/products1/unix/java/patches/index.html

To ensure that the system meets these requirements:

1. To determine which version of HP-UX is installed, enter the following command:

   # uname -a
   HP-UX hostname B.11.23 U ia64 2359460360 unlimited-user license
   
   

   In this example, the version of HP-UX 11i is 11.23.

2. To determine whether a patch is installed, enter a command similar to the following:

   # /usr/sbin/swlist -l patch | grep PHSS_29658
   
   

   Alternatively, to list all installed patches, enter the following command:

   # /usr/sbin/swlist -l patch | more
   
   

   If a required patch is not installed, download it from the following URL and install it:

   http://itresourcecenter.hp.com
   
   

1.1.3 Checking the Hardware Requirements

Oracle SES requires a minimum of 2 gigabytes of disk space. This includes 1 gigabyte to install and approximately .5 gigabyte to create the initial Oracle SES index. Additional Oracle SES requirements are based on the amount of data that you need to search. Here are some configuration examples:

To index 100,000 documents:

• 4 gigabytes disk space

• 1 gigabyte RAM

To index 1,000,000 documents:

• 20 gigabytes disk space

• 6 gigabytes RAM

The system must meet the following minimum hardware requirements:

• At least 512 MB of physical RAM

• The following table describes the relationship between the available RAM and the required swap space:

  Available RAM	Swap Space Required
  Between 512 MB and 2048 MB	1.5 times the size of RAM
  Between 2049 MB and 8192 MB	Equal to the size of RAM
  More than 8192 MB	0.75 times the size of RAM

  
  

• 400 MB of disk space in the /tmp directory

• 3 GB of disk space for the Oracle software, depending on the installation type.

To ensure that the system meets these requirements, perform the following steps:

1. To determine the physical RAM size, enter the following command:

   # /usr/contrib/bin/machinfo | grep -i Memory
   
   

   If the size of the physical RAM installed in the system is less than the required size, then you must install more memory before continuing.

2. To determine the size of the configured swap space, enter the following command:

   # /usr/sbin/swapinfo -a
   
   

   If necessary, refer to the operating system documentation for information about how to configure additional swap space.

3. To determine the amount of free disk space available in the /tmp directory, enter the following command:

   # bdf /tmp
   
   

   If there is less than 400 MB of disk space available in the /tmp directory, then complete one of the following steps:

   • Delete unnecessary files from the /tmp directory.

   • Set the TMP and TMPDIR environment variables when setting the oracle user's environment (described later).

   • Extend the file system that contains the /tmp directory. If required, contact your system administrator for information about extending file systems.

4. To determine the amount of free disk space available on the system, enter the following command:

   # bdf
   
   

5. To determine whether the system architecture can run the software, enter the following command:

   # /bin/getconf KERNEL_BITS
   
   

   The following is the expected output of this command:

   64
   
   

   If you do not see the expected output, then you cannot install the software on this system.

For installation help, including pre-installation tips, see the Oracle SES tutorial:

http://st-curriculum.oracle.com/tutorial/SESAdminTutorial/index.htm

1.1.4 Configuring Kernel Parameters

Verify that the following kernel parameters are set either to the formula shown, or to values greater than or equal to the recommended value shown:

To view the current value or formula specified for these kernel parameters, and to change them if necessary:

1. Follow these steps:

   1. Enter the following command to start the kcweb application:

      # /usr/sbin/kcweb -F
      
      

   2. Check the value or formula specified for each of these parameters and, if necessary, modify that value or formula.

      If necessary, refer to the kcweb online Help for more information about completing this step.

      Note:

      If you modify the value of a parameter that is not dynamic, you must restart the system.

2. If necessary, when the system restarts, log in and switch user to root.

1.1.5 Installing on a Port Number Less Than 1024

Oracle SES must be installed by a non-root user. However, UNIX operating systems require that only root users can bind to ports less than 1024. Follow these steps to install Oracle SES on a port number less than 1024:

1. During installation, specify a port greater than or equal to 1024 (for example, 7777).

2. After the installation is complete, follow the instructions in the following section, "Changing the Oracle SES Middle Tier Port", to change to a port number less than 1024 (for example, 80).

1.1.6 Changing the Oracle SES Middle Tier Port

To change the Oracle SES middle tier port, follow these steps:

1. Shutdown the middle tier with the following command:

   $ORACLE_HOME/bin/searchctl stop
   
   

2. Edit the value for the port attribute in $ORACLE_HOME/oc4j/j2ee/OC4J_SEARCH/config/http-web-site.xml. (Make sure that the new port is not already in use.)

3. To change to a port less than 1024:

   1. Run chgrp -R root $ORACLE_HOME/jdk

   2. Log on as the root user and perform step 5.

4. To change from a port that was less than 1024 to a port that is greater than or equal to 1024:

   1. Log on as the root user.

   2. Run the following:

      chown -R <user> $ORACLE_HOME/search/opmn
      $ORACLE_HOME/oc4j/j2ee/OC4J_SEARCH/persistence
      
      

      where <user> is the user that installed Oracle SES

   3. Log off from root user and log on as the user that installed Oracle SES.

5. Start the middle tier with the following command:

   $ORACLE_HOME/bin/searchctl start
   

1.2.1 Mounting the DVD-ROM

On most hp-ux Itanium systems, the product disc mounts automatically when you insert it into the drive. If the disc does not mount automatically, then follow these steps to mount it:

1. Switch user to root:

   $ su - root
   
   

2. If necessary, enter the following command to unmount the currently mounted disc, then remove it from the drive:

   # /usr/sbin/umount /SD_DVDROM
   
   

   In this example, /SD_DVDROM is the mount point directory for the disc drive.

3. Insert the appropriate disc into the disc drive, then enter a command similar to the following to mount it:

   # /usr/sbin/mount -F cdfs -o rr /dev/dsk/cxtydz /SD_DVDROM
   
   

   In this example, /SD_DVDROM is the disc mount point directory and /dev/dsk/cxtydz is the device name for the disc device, for example /dev/dsk/c0t2d0.

4. Log out from the root user.

   exit
   
   

1.3.1 Selecting a Response File

Before performing a silent installation, you must provide information specific to your installation in a response file. The installer will fail if you attempt an installation using a response file that is not configured correctly. Response files are text files that you can create or edit in a text editor.

The Oracle SES DVD provides the following templates for the Oracle Universal Installer response files:

Response files are located in the /response directory on Disk 1 of the Oracle SES DVD. You must edit the response file according to your requirements for silent installation.

To use a response file, first copy it from the DVD to your system. For example:

1. Go to the /response directory

2. Copy the server.rsp file to your system hard drive:

   # cp server.rsp /private/ses/response/server.rsp
   

1.3.2 Editing the Response File

Use any text editor to edit the response file to include information specific for your system. You must specify values for variables in your response file. Each variable listed in the response file is associated with a comment, which identifies the variable type. For example:

string = "Sample Value"
Boolean = True or False
Number = 1000
StringList = {"StringValue 1", "String Value 2"}

The values that are given as <Value Required> must be specified for silent installation. Remove the comment from the variable values in the response file before starting the Oracle SES installation.

1.3.3 Specifying a Response File and Starting the Installation

Before you specify a response file, ensure that all the values in the response file are correct. To make Oracle Universal Installer use the response file at installation time, specify the location of the response file as a parameter when starting Oracle Universal Installer. To perform a silent installation, use the -silent parameter:

# ./runInstaller -silent -responseFile absolute_path_and_filename

The success or failure of silent installations is logged in the installActions.log file. Additionally, the silent installation creates the silentInstall.log file. The log files are created in the $ORACLE_HOME/oraInventory/logs directory.

The silentInstall<Date_Time>.log file contains the following line if the installation was successful:

The installation of Oracle Secure Enterprise Search was successful.

The corresponding installActions<Date_Time>.log file contains specific information regarding installation.

1.3.4 Security Tips for Silent Installations

The response file contains the installation password in clear text. To minimize security issues, follow these guidelines:

• Set the permissions on the response files so that they are readable only by the operating system user performing the silent installation.

• If possible, remove the response files from the system after the silent installation is completed.

1.3.5 Error Handling

Values for variables that are of the wrong context, format, or type are treated as if no value were specified. Variables that are outside any section are ignored.

If you attempt a silent installation with an incorrect or incomplete response file, or if Oracle Universal Installer encounters an error, such as insufficient disk space, the installation fails.

1.4.1 Certifications and Patches

The Oracle SES administration tool and default query application are certified on the following browsers:

• Firefox 1.0, 1.0.1, 1.0.6, 1.0.7, 1.5

• Internet Explorer 6.0

• Netscape 7.1, 7.2

• Mozilla 1.7.3

The requirements and certifications included in this installation guide were current at the time this guide was published. See the certification matrix on the OracleMetalink Web site for the most up-to-date information.