Sun Java System Directory Server Enterprise Edition 6.3 Installation Guide

Installing Directory Server Enterprise Edition Using Zip Distribution

During the installation process, if dsee_deploy finds that Directory Server Enterprise Edition is already installed on your computer, it upgrades the previous installation automatically. Backup the Directory Server Enterprise Edition installation directory, if any, before upgrading to Directory Server Enterprise Edition 6.3, as later you will not be able to restore any previous Directory Server Enterprise Edition installation.

The zip version of Directory Server Enterprise Edition 6.3 removes any previous partial installation of Directory Server Enterprise Edition.

You can install the zip distribution as non-root user.

ProcedureTo Install Directory Server Enterprise Edition 6.3 From Zip Distribution

Before You Begin

On SuSE Linux:

On HP-UX:

Patch Table for Zip Distribution

Refer to the following table for information about the appropriate zip patch for your system. If newer patch revisions become available, use the newer ones instead of those shown in the table.

Operating System 

Patch number 

Solaris SPARC 

126748-04

Solaris 9 x86 

126749-04

Solaris 10 x86 and AMD x64 

126750-04

Red Hat Linux 

126751-04

SuSE Linux 

126751-04

HP-UX 

126752-04

Windows 

126753-04

All the multilingual files are included in the above mentioned patches.

Complete the worksheet given below before you start your installation.

Requisite Information 

Hints 

Your Answers 

Fully qualified hostname of the system where you install  

Example:  

 
  • Directory Server

  • Directory Proxy Server

  • ds.example.com

  • dps.example.com

 

(Optional) Common agent container port number to access from Directory Service Control Center 

Default: 11162

 

File system paths where you create instances for: 

Example:  

 
  • Directory Server

  • Directory Proxy Server

  • /local/ds/

  • /local/dps/

Create instances only on local file systems, never on network–mounted file systems such as NFS. 

Each path is henceforth referred to as an instance-path.

 

LDAP port number 

Default: 389 when installing as root; 1389 for non-root

 

LDAP or SSL port number 

Default: 636 when installing as root; 1636 for non-root

 

Directory Manager DN 

Default: cn=Directory Manager

 

Directory Proxy Manager DN 

Default: cn=Proxy Manager

 

Directory Manager password 

Must be at least eight characters long 

 

Directory Proxy Manager password 

Must be at least eight characters long 

 

Base suffix DN 

Example: dc=example,dc=com

 

(UNIX systems) Server user (uid)

Example: noaccess

 

(UNIX systems) Server group (gid)

Example: noaccess

 

(Optional) Connection information for each server to access through the proxy 

Example: ds1.example.com:1389, ds2.example.com:1636

 

By default, the user and group IDs for zip installations are those of the user performing the installation.

  1. Obtain the zip distribution for this installation.

  2. Install the prerequisite patches or service packs for your platform.

    See Operating System Requirements in Sun Java System Directory Server Enterprise Edition 6.3 Release Notes.

  3. Change to the zip distribution directory that contains the dsee_deploy command.

  4. Install the software with the dsee_deploy(1M) command.


    $ ./dsee_deploy install -i install-path options
    

    On Windows, browse to the zip distribution folder that contains the dsee_deploy command and run the following command:


    dsee_deploy install -i install-path options
    

    For example, the following command installs the component in the /local directory, assuming that you have write access to the directory.


    $ ./dsee_deploy install -i /local
    

    You can also use the --no-inter option to install in non-interactive mode, accepting the license without confirmation. Non-interactive mode is particularly useful for silent installation.

    This step installs a Common Agent Container, cacao, with the local Directory Service Control Center agent as well, allowing you to use DSCC to create server instances. The previous command works properly only if you have not yet installed a Common Agent Container using the default port, 11162.

    If you installed DSCC previously on the same system, a Common Agent Container using the default port is already installed. Specify a different port using the -p option.


    $ ./dsee_deploy install -i /local -p 11169
    

    During the installation process, a WAR file is saved on your system. The WAR file contains the DSCC web application which when deployed with the application server enables you to access and manage the server instances through web console. The functionality is similar to DSCC in native packages. For more information about WAR file, see Installing Directory Service Control Center From Zip Distribution.

    During the installation process, the multilingual packages are also installed.

  5. (Optional) Load sample data in your directory.

    Examples that use command-line tools depend on sample data residing under the dc=example,dc=com suffix of your directory.

    You can set up part of the data that is required by creating a dc=example,dc=com suffix. You can then populate the suffix with entries from the ds6/ldif/Example.ldif file.

    1. Create a new Directory Server instance and start the instance.


      $ dsadm create -p port -P SSL-port instance-path
      $ dsadm start instance-path
      
    2. Read the Example.ldif file to find bind passwords needed in the examples.

    3. Create suffix and load the Example.ldif content into the directory by using the following commands:


      $ dsconf create-suffix -h localhost -p 1389 dc=example,dc=com
      $ dsconf import -h localhost -p 1389 install-path/ds6/ldif/Example.ldif \
      dc=example,dc=com

      For more information, see To Create a Directory Server Instance From the Command Line.

    4. Generate test data for examples by using the makeldif(1) command and the following template:

      define suffix=dc=example,dc=com
      define maildomain=example.com
      
      branch: ou=test,[suffix]
      subordinateTemplate: person:100
      
      template: person
      rdnAttr: uid
      objectclass: top
      objectclass: person
      objectclass: organizationalPerson
      objectclass: inetOrgPerson
      givenName: <first>
      sn: <last>
      cn: {givenName} {sn}
      initials: {givenName:1}{sn:1}
      employeeNumber: <sequential>
      uid: test{employeeNumber}
      mail: {uid}@[maildomain]
      userPassword: auth{employeeNumber}{employeeNumber}
      telephoneNumber: <random>
      description: This is the description for {cn}.
    5. Copy the template content to template.ldif and use commands such as the following to generate the data in test.ldif and to load the content into the directory.


      $ cd install-path/dsrk6/bin/example_files/
      $ ../makeldif -t test.template -o test.ldif
      Processing complete.
      101 total entries written.
      $ ../ldapmodify -a -c -D uid=hmiller,dc=example,dc=com -w - -f test.ldif
      Enter bind password:
      …

      If you read Example.ldif, you see that the password for hmiller is hillock.

Next Steps

After installing the software, see Environment Variables.

Installing Directory Service Control Center From Zip Distribution

The Directory Server Enterprise Edition zip distribution includes a WAR file (dscc.war) that contains the Directory Service Control Center (DSCC) web application. The WAR file is deployed with the application server to enable you to do the following tasks:

The WAR file supports the following application servers:

The following two procedures contain information about deploying the WAR file with Sun Java System Application Server and Tomcat respectively.

ProcedureTo Deploy the WAR File with Sun Java System Application Server

After you install Directory Server Enterprise Edition, the WAR file, dscc.war, is at the following location:


install-path/var/dscc6/
  1. Initialize the DSCC registry.


    $ install-path/dscc6/bin/dsccsetup ads-create
    Choose password for Directory Service Manager:
    Confirm password for Directory Service Manager:
    Creating DSCC registry...
    DSCC Registry has been created successfully
  2. Create an application server instance.


    $ mkdir /local/domainroot
    $ setenv AS_DOMAINS_ROOT /local/domainroot
    $ cd app-server-install-path/bin
    $ asadmin create-domain --domaindir ${AS_DOMAINS_ROOT} --adminport 3737 \
    --adminuser boss dscc
  3. Edit the server.policy file.

    1. Open the server.policy file.


      $ vi ${AS_DOMAINS_ROOT}/dscc/config/server.policy
    2. Add the following statements to the end of the file:


      // Permissions for Directory Service Control Center
      grant codeBase "file:${com.sun.aas.instanceRoot}/applications/j2ee-modules/dscc/-" 
      {
      	permission java.security.AllPermission;
      };

    This configures the application server to grant all of the Java permissions to the DSCC application.

  4. Deploy the WAR file in your application server instance.


    $ asadmin start-domain --domaindir ${AS_DOMAINS_ROOT} --user username dscc 
    $ cp install-path/var/dscc6/dscc.war ${AS_DOMAINS_ROOT}/dscc/autodeploy

    For more information about creating and configuring application server instances and deploying the WAR file, refer to the Sun Java System Application Server Online Help.

  5. Open DSCC.

    Use http://hostname:8080/dscc or https://hostname:8181/dscc based on the configuration of your application server.

    The Directory Service Manager Login page displays.

    See Getting Started With Directory Service Control Center.

ProcedureTo Deploy WAR File with Tomcat

After you install Directory Server Enterprise Edition, the WAR file, dscc.war, is at install-path/var/dscc6/.

The dscc.war is installed in the same way as any other web application, except the following settings:

The following example shows how to install DSCC in Tomcat on a Solaris 10 system.

  1. Initialize the DSCC registry.


    $ install-path/dscc6/bin/dsccsetup ads-create
    Choose password for Directory Service Manager:
    Confirm password for Directory Service Manager:
    Creating DSCC registry...
    DSCC Registry has been created successfully
  2. Identify your Tomcat installation and instance.


    $ setenv CATALINA_HOME tomcat-install-path
    $ setenv CATALINA_BASE tomcat-instance-path
    $ setenv JAVA_HOME jdk-home-dir
    

    For installing Tomcat and creating instances, refer to the Tomcat documentation.

  3. Deploy the WAR file.

    Create the dscc directory as shown below:


    $ mkdir ${CATALINA_BASE}/webapps/dscc

    Copy the dscc.war file into newly created dscc folder and unzip the dscc.war file.


    $ unzip -d ${CATALINA_BASE}/webapps/dscc install-path/var/dscc6/dscc.war

    Add the emphasized text in the ${CATALINA_BASE}/conf/web.xml file as shown below:


     ...
        <servlet>
            <servlet-name>jsp</servlet-name>
            <servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
            <init-param>
                <param-name>fork</param-name>
                <param-value>false</param-value>
            </init-param>
            <init-param>
                <param-name>xpoweredBy</param-name>
                <param-value>false</param-value>
            </init-param>
    	...
            <init-param>
                <param-name>enablePooling</param-name>
                <param-value>false</param-value>
            </init-param>
            <load-on-startup>3</load-on-startup>
        </servlet>
        ....

    Verify the permissions of startup.sh (tomcat5.exe on Windows) and run the following command:


    $ ${CATALINA_HOME}/bin/startup.sh
  4. Use http://hostname:8080/dscc to connect to DSCC.

    The Directory Service Manager Login page displays.

    See Getting Started With Directory Service Control Center.

ProcedureTo Upgrade Directory Server Enterprise Edition From Zip Distribution

Before You Begin

There is no different procedure to upgrade the Directory Server Enterprise Edition installation rather the dsee_deploy command automatically updates the installation if it finds any previous installation. But in case of SuSE Linux 9 and HP-UX, before upgrading the Directory Server Enterprise Edition installation, you must upgrade the operating system to SuSE Linux 9 SP4 and HP-UX 11.23 respectively. Refer to the following procedure to successfully upgrade your Directory Server Enterprise Edition installation to 6.3.

  1. Stop cacao, Directory Server and Directory Proxy Server running instances that are created using the installation going to be patched. Also stop application server for WAR file and the DSCC registry.

  2. In case of SuSE Linux 9 and HP-UX, upgrade your operating system.

    • Upgrade SuSE Linux 9 SP3 to SuSE Linux 9 SP4 to upgrade Directory Server Enterprise Edition 6.2 installation to 6.3.

      On SuSE 64-bit, .pam-32bit-9-yyyymmddhhmm.rpm is a prerequisite for cacao to start. You must install it if not already present on your system.

    • Upgrade HP-UX 11.11 to HP-UX 11.23 to upgrade Directory Server Enterprise Edition 6.0 or 6.1 installation to 6.3.

    Please refer to the corresponding documentation on how to upgrade the operating system, how to preserve the partition where Directory Server Enterprise Edition is installed, where to get the latest patch bundles.

  3. Upgrade Directory Server Enterprise Edition to 6.3.

    • Use the dsee_deploy command from Directory Server Enterprise Edition 6.3 zip distribution, with the same install-path, and cacao port that you had for your previous installation. The dsee_deploy command will restart cacao and DSCC registry.

      For step by step information, refer to To Install Directory Server Enterprise Edition 6.3 From Zip Distribution.

    • Deploy the latest dscc.war file in the application server using the following commands:

      For step by step information, refer to Step 4 on Sun Java System Application Server and Step 3 on Tomcat application server.

    • Restart Directory Server and Directory Proxy Server instances, and application server for WAR file.

  4. Start daemons only when both operating system is upgraded and Directory Server Enterprise Edition is installed.

See Also

For upgrading Directory Server Enterprise Edition to 6.3 on rest of the supported operating systems, the procedure is similar to the installation procedure. Refer To Install Directory Server Enterprise Edition 6.3 From Zip Distribution for step by step information.