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 new 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 your Solaris distribution and version.

The following packages must be installed:

SUNWarc
SUNWbtool
SUNWhea
SUNWlibm
SUNWlibms
SUNWsprot
SUNWsprox
SUNWtoo
SUNWi1of
SUNWi1cs
SUNWi15cs
SUNWxwfnt

The following patches must be installed:

• Patches for Solaris 8:

  All of the patches included in the J2SE Patch Cluster for Solaris 8:

  • 108528-23, SunOS 5.8: kernel update patch

  • 108652-66, X11 6.4.1: Xsun patch

  • 108773-18, SunOS 5.8: IIIM and X I/O Method patch

  • 108921-16, CDE 1.4: dtwm patch

  • 108940-53, Motif 1.2.7 and 2.1.1: Runtime lib. patch for Solaris 8

  • 108987-13, SunOS 5.8: Patch for patchadd and patchrm

  • 108989-02, /usr/kernel/sys/acctctl & /.../exacctsys patch

  • 108993-18, SunOS 5.8: LDAP2 client, libc, libthread ... lib. patch

  • 109147-24, SunOS 5.8: linker patch

  • 110386-03, SunOS 5.8: RBAC Feature Patch

  • 111023-02, SunOS 5.8: /kernel/fs/mntfs and ... sparcv9/mntfs

  • 111111-03, SunOS 5.8: /usr/bin/nawk patch

  • 111308-03, SunOS 5.8: /usr/lib/libmtmalloc.so.1 patch

  • 111310-01, SunOS 5.8: /usr/lib/libdhcpagent.so.1.patch

  • 112396-02, SunOS 5.8: /usr/bin/fgrep patch

  The following additional patches:

  • 111721-04, SunOS 5.8: Math Library (libm) patch

  • 112003-03, SunOS 5.8: Unable to load fontset in 64-bit Solaris 8 iso-1 or iso-15

  • 112138-01, SunOS 5.8: usr/bin/domainname patch

• Patches for Solaris 9:

  • 112233-11: SunOS 5.9: Kernel Patch

  • 111722-04: SunOS 5.9: Math Library (libm) patch

To ensure that the system meets these requirements:

1. To determine which version of Solaris is installed, enter the following command:

   # uname -r
   5.8
   
   

2. To determine whether the required packages are installed, enter a command similar to the following:

   # pkginfo -i SUNWarc SUNWbtool SUNWhea SUNWlibm SUNWlibms \
   SUNWsprot SUNWsprox SUNWtoo SUNWi1of SUNWi1cs SUNWi15cs SUNWxwfnt
   
   

3. To determine whether an operating system patch is installed, enter a command similar to the following:

   # /usr/sbin/patchadd -p | grep patch_number
   
   

   If an operating system patch is not installed, then download it from the following Web site and install it:

   http://sunsolve.sun.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:

• 512 MB of physical RAM

• 1 GB of swap space (or twice the size of RAM)

  On systems with 2 GB or more of RAM, the swap space can be between one and two times the size of RAM.

• 400 MB of disk space in the /tmp directory

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

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

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

   # /usr/sbin/prtconf | grep "Memory size"
   
   

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

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

   # /usr/sbin/swap -s
   
   

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

   # df -k /tmp
   
   

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

   # df -k
   
   

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

On Solaris 8 and 9, verify that the following kernel parameters are set to values greater than or equal to the recommended value shown:

On Solaris 10, verify that the kernel parameters shown in the following table are set to values greater than or equal to the recommended value shown. The table aslo contains the resource controls that replace the /etc/system file for a specific kernel parameter.

On Solaris 8 and Solaris 9, to view the current value specified for these kernel parameters, and to change them if necessary, follow these steps:

1. To view the current values of these parameters, enter the following commands:

   # grep noexec_user_stack /etc/system
   # /usr/sbin/sysdef | grep SEM
   # /usr/sbin/sysdef | grep SHM
   
   

2. If you must change any of the current values, follow these steps:

   1. Create a backup copy of the /etc/system file, by using a command similar to the following:

      # cp /etc/system /etc/system.orig
      
      

   2. Open the /etc/system file in any text editor, and if required, add lines similar to the following (edit the lines if the file already contains them):

      set noexec_user_stack=1
      set semsys:seminfo_semmni=100
      set semsys:seminfo_semmns=1024
      set semsys:seminfo_semmsl=256
      set semsys:seminfo_semvmx=32767
      set shmsys:shminfo_shmmax=4294967296
      set shmsys:shminfo_shmmin=1
      set shmsys:shminfo_shmmni=100
      set shmsys:shminfo_shmseg=10
      
      

   3. Enter a command similar to the following to reboot the system:

      # /usr/sbin/reboot
      
      

   4. When the system restarts, log in and switch user to root.

On Solaris 10, use the following procedure to view the current value specified for resource controls, and to change them if necessary:

1. To view the current values of the resource control, enter the following commands:

   # id -p // to verify the project id
   uid=0(root) gid=0(root) projid=1 (user.root)
   # prctl -n project.max-shm-memory -i project user.root
   # prctl -n project.max-sem-ids -i project user.root
   
   

2. If you must change any of the current values, then:

   1. To modify the value of max-shm-memory to 6 GB:

      # prctl -n project.max-shm-memory -v 6gb -r -i project user.root
      
      

   2. To modify the value of max-sem-ids to 256:

      # prctl -n project.max-sem-ids -v 256 -r -i project user.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 Installation Warning only on Solaris 10

During installation on Solaris 10, the following warning message is displayed:

SUNWsprox package not installed

This message can be ignored. Press Continue to resume the installation.

1.2.2 Mounting the DVD-ROM

On most Solaris systems, the disc mounts automatically when you insert it into the disc drive. If the disc does not mount automatically, follow these steps to mount it:

1. Switch user to root:

   $ su - root
   
   

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

   # eject
   
   

3. Insert the appropriate disc into the disc drive.

4. To verify that the disc mounted automatically, enter the following command:

   # ls /dvd/dvd0
   
   

5. If this command fails to display the contents of the disc, enter a command similar to the following to mount it:

   # /usr/sbin/mount -r -F hsfs /dev/dsk/cxtydzs2 /SD_DVDROM
   
   

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

6. If Oracle Universal Installer is displaying the Disk Location dialog box, enter the disc mount point directory path, for example:

   • Disc mounted automatically:

     /dvd/dvd0
     
     

   • Disc mounted manually:

     /SD_DVDROM
     
     

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

2.1.1 Backing Up the Oracle SES 10.1.6 Instance

There is no downgrade support from 10.1.8. Before upgrading, first shutdown Oracle SES, then back up the 10.1.6 ORACLE_HOME directory, the oradata directory, and the entire oraInventory directory to a different location. (The oraInventory directory is a central inventory of all Oracle homes. Its location is specified in /var/opt/oracle/oraInst.loc.)

For example:

$ORACLE_HOME/bin/searchctl stopall
cd ~
msu password
tar cvf ses.tar {$ORACLE_HOME} 
tar cvf ses.tar {oraInventory} 
tar cvf ses.tar {oradata}

If the upgrade should fail, then restore your 10.1.6 instance by cleaning up the ORACLE_HOME, oradata, and oraInventory directories and using the tar command to copy them back to the same location. For example:

tar xvf ses.tar {$ORACLE_HOME} 
tar xvf ses.tar {oraInventory} 
tar xvf ses.tar {oradata}

After your 10.1.6 environment is back, you can retry the 10.1.8 upgrade.

2.1.2 Upgrading on a Port Number Less than 1024

If the 10.1.6 installation is bound to a port number less than 1024, then first change the Oracle SES middle tier port to a port number greater than 1024. After the upgrade completes, you can change the Oracle SES middle tier port back to a port number less than 1024.

2.1.3 Moving QTA Jar Files

For any custom query-time authorization (QTA) jar files in the 10.1.6 Oracle home directory, manually move them into the new Oracle home directory or into an entirely new location. Also, for any sources that used these QTA jar files, update the location in the Jar File Name field on the Home - Sources - Authorization page. This protects you from inadvertently deleting these jar files if you remove the old Oracle home directory after the upgrade process.

2.4.1 Migrating Federated Sources

To migrate federated sources in the 10.1.6 installation, you must edit each federated source in the 10.1.8 installation. On the Home - Sources - Customize Federated Source page, enter the Web services URL for the source.

After editing the source, you can have public federated search on the remote Oracle SES instances. For secure federated search, see the section "Setting Up Secure Federated Search" in the Oracle Secure Enterprise Search Administrator's Guide. If the remote Oracle SES instances are using the 10.1.6 installation, then they also need to be upgraded to 10.1.8 for secure federated search to work.

2.4.2 Migrating Single Sign-On Configuration

If the 10.1.6 Oracle SES instance had been configured to use a single sign-on URL to access the Oracle SES search page and administration tool, then do the following to migrate the configuration to 10.1.8:

1. Edit the $ORACLE_HOME/oc4j/j2ee/OC4J_SEARCH/config/http-web-site.xml file. In the element web-site, change the attribute protocol from "http" to "ajp13":

   <web-site ... protocol="ajp13" ... >
   
   

2. Restart the Oracle SES middle tier using searchctl restart.

3. Configure mod_osso to protect the search with SSO. Add the following lines to $AS_HOME/Apache/Apache/conf/mod_osso.conf within the IfModule element:

   <Location /search/query/formlogin.uix>
     require valid-user
     AuthType Basic
   </Location>
   
   

4. Restart Oracle HTTP Server. On the OracleAS middle tier host, run the following command:

   $AS/opmn/bin/opmnctl restartproc process-type=HTTP_Server
    
   opmnctl: restarting opmn managed processes...
   

2.4.3 Changes in 10.1.8

• If 10.1.6 was connected to Oracle Internet Directory, then after upgrade, you may see "orclApplicationCommonName=oesEntity_ ... " in the user name on the Global Settings - Identity Management Setup page. This user was created implicitly by Oracle SES 10.1.6 when the instance connected to Oracle Internet Directory, and it was used internally for Oracle Internet Directory authentication and authorization. After upgrade, 10.1.8 continues to use the user for Oracle Internet Directory authentication and authorization.

• In 10.1.6, the jar files for custom crawler plug-ins were located in the $ORACLE_HOME/search/lib/agent directory. This directory does not exist in 10.1.8. These jar files from 10.1.6 were migrated to the $ORACLE_HOME/search/lib/plugins directory.