Previous     Contents     Index     Next     
iPlanet Directory Server Resource Kit 5.1 Tools Reference



Chapter 2   Installation Guide


The iPlanet Directory Server Resource Kit is available on CD-ROM or from the following iPlanet download site:

http://www.iPlanet.com/downloads/developer/

This chapter describes the procedure for installing the iPlanet DSRK software on the following platforms:

You should also read the following sections concerning all platforms:



Solaris Platforms

The iPlanet DSRK is supported on the Solaris 2.6 and Solaris 8 platforms. There is a separate installation package for each Solaris platform, with each containing native binaries for the designated version. However, the package structure and the installation procedure is identical for both.

The product requires 56 MB of disk space on the either Solaris platform and an extra 37 MB of temporary space to install from the CD-ROM. You will need twice as much temporary space if you download the zip file from the iPlanet website.

You should remove any previous versions of the Directory Server Resource Kit and the iPlanet LDAP SDKs from your machine before installing or upgrading to the iPlanet DSRK.


Installation Procedure

  1. On the CD-ROM, locate the zip file for your version of the Solaris platform:

       SunOS5.8/idsrk51-SunOS5.8.zip
       SunOS5.6/idsrk51-SunOS5.6.zip

    OR download the zip file with the corresponding name from the iPlanet website and store it in an empty directory.

  2. Extract the contents of the zip file with the following command:

       $ unzip idsrk51-SunOS5.x .zip -d tempDir

    Where tempDir is an empty directory needed only during the installation. You may omit the -d option when you have already downloaded the zip file to an empty directory.

  3. The extracted files will contain the setup application, the setup configuration files, and the software in compressed format. As root, run the setup application:

       # tempDir /setup

  4. The setup application will lead you through the installation of the software. When asked for input, you may press Return to accept the default, or type a new value. You may also type Control-B to go back to the previous screen or Control-C to quit without installing.

    When prompted to do so, you must type Yes or yes to accept the software license. The default is to not accept the license and exit the setup application.

    You will also be asked to choose a location for the software. The default directory is /opt/iPlanet. Some functionality of the iPlanet DSRK tools relies on this default directory. You may have to specify additional tool options or set your LD_LIBRARY_PATH if you install the software in another location.

    The software is bundled as a single component to be installed all at once. Press Return to install the single component when asked to do so.

  5. After the installation of the software is complete, you no longer need the contents of the temporary directory. Use the following command to remove it and all files it contains:

       $ rm -Rf tempDir /*

Once installed, the APIs and tools of the iPlanet Directory Server Resource Kit are ready to be used. See "Files and Directories" for a description of the product contents.


Removing the Software

The product includes an uninstall application to remove the iPlanet DSRK software from your machine. Use this application before installing an upgraded version of the product.

  1. If you customized any files in the software bundle and wish to keep them, you must first rename them or copy them to another location outside of the installation directory. The uninstall application will remove all product files by name, but it will not remove other files found under the installation directory. Any personal configuration files may thus be kept and used with an upgraded version of the software when it is installed in the same location.

  2. To remove the software, run the following command as root:

       # installDir /uninstall

  3. The uninstall application will ask you to specify the components and subcomponents to remove. The software is a single component and will be removed all at once. Press Return twice to select the single component by default and remove all iPlanet DSRK software.

    If there are no custom files to keep, the uninstall application will also remove the installation directory.

The uninstall application relies on the files in the installDir /setup directory that was created at installation. If these file are deleted or modified, the application will be unable to remove the software. In that case you may delete the software manually. Move any customized files you wish to keep to a different location, then type the following command as root:

# rm -Rf installDir /*

The iPlanet DSRK is not bundled as a Solaris package, meaning that it is not registered with the system-wide list of packages. Therefore, removing all files will remove the iPlanet DSRK from your system.



Windows NT


The iPlanet DSRK is supported on Windows NT 4.0 Workstation or Server for the Intel platform. Service pack 5 or later is recommended. The software should also work on the Windows 2000 platform.

The product requires 37 MB of disk space and an extra 30 MB of temporary space to install from the CD-ROM. You will need twice as much temporary space if you download the zip file from the iPlanet website.


Installation Procedure

  1. Log in to Windows NT as a user with Administrator privileges, if you have not done so already.

  2. On the CD-ROM, locate the zip file for the Windows NT platform:

       WINNT4.0\idsrk51-WINNT4.0.zip

    OR download the zip file with the same name from the iPlanet website and store it in an empty folder.

  3. Extract the contents of the zip file with any zip extraction utility. Extract all contents to an empty folder needed only during the installation.

    If you downloaded the zip file into an empty folder, you may extract its contents in the same folder.

  4. The extracted files will contain the setup.exe application, the setup configuration files, and the software in compressed format. Double-click the setup.exe icon to begin the installation.

  5. The setup application will lead you through the installation of the software. You may use the "Back" and "Next" buttons to modify any choices or the "Cancel" button to quit without installing.

    When prompted to do so, you must click "Yes" to accept the software license and continue the installation.

    You will also be asked to choose a location for the software. The default folder is C:\opt\iPlanet. Some functionality of the iPlanet DSRK tools relies on this default folder. You may have to specify additional tool options if you install the software in another location.

    The software is bundled as a single component to be installed all at once. This component is selected by default for installation. After you have reviewed all of your choices, click the "Install" button to copy the product files to your disk. The setup program automatically modifies the Windows Registry.

  6. After the setup application has finished, you no longer need the contents of the temporary folder where the zip file was extracted, and you may delete it.

  7. The tools of iPlanet DSRK are designed to be launched from the command interpreter, not from the Windows desktop. You should add the following library locations to the PATH environment variable of your command session:

       PATH=%PATH%;installDir \lib;installDir \lib\nss\lib

  8. The ilash tool relies on the Tcl interpreter, version 8.2 or later, and several other tools require the Perl interpreter, version 5.005_03 or later. If you wish to use these tools you must download and install these applications. Please refer to "Tcl Resources" and "Where to Find Additional Information" for links to these applications.

When your installation is complete, see "Files and Directories" for a description of the product contents.


Removing the Software

The product includes an uninst.exe application to remove the iPlanet DSRK software from your machine. Use this application before installing an upgraded version of the product. You must be a user with Administrator privileges to remove the software.

  1. If you customized any files in the software bundle and wish to keep them, you must first rename them or copy them to another location outside of the installation folder. The uninst.exe application will remove all product files by name, but it will not remove other files found under the installation folder. Any personal configuration files may thus be kept and used with an upgraded version of the software when it is installed in the same location.

  2. To remove the software, double-click the uninst.exe icon in the installation folder.

  3. The uninst.exe application will ask you to specify the components and subcomponents to remove. The software is a single component that is already selected by default. Click "Uninstall" to remove all iPlanet DSRK software.

    If there are no custom files to keep, the uninst.exe application will also remove the installation folder.

The uninst.exe application relies on the files in the installDir /setup folder that was created at installation. If these file are deleted or modified, the application will be unable to remove the software. In that case you may delete the installation folder manually, after moving any customized files you wish to keep to a different location.



Other Platforms


The iPlanet Directory Server Resource Kit is supported on the following platforms with the following disk space requirements:

  • AIX 4.33 or later. The product requires 54 MB of disk space and an extra 37 MB of temporary space during the installation procedure.

  • HP-UX B 11.0.The product requires 42 MB of disk space and an extra 33 MB of temporary space during the installation procedure.

  • OSF/1 v4.0D. The product requires 55 MB of disk space and an extra 38 MB of temporary space during the installation procedure.

  • Red Hat Linux 6.0 on the Intel architecture. The product requires 50 MB of disk space and an extra 36 MB of temporary space during the installation procedure.

The temporary space requirements are given for an installation from the CD-ROM. You will need twice as much temporary space if you download the zip file from the iPlanet website.

The following software installation and removal procedures may need to be tailored to the command environment available on your platform.


Installation Procedure

  1. On the CD-ROM, locate the zip file for your platform:

       AIX4.3/idsrk51-AIX4.3.zip
       HP-UXB.11.00/idsrk51-HP-UXB.11.00.zip
       OSF1V4.0D/idsrk51-OSF1V4.0D.zip
       Linux2.2_x86/idsrk51-Linux2.2_x86.zip

    OR download the zip file with the corresponding name from the iPlanet website and store it in an empty directory.

  2. Extract the contents of the zip file with the following command:

       $ unzip idsrk51-platform .zip -d tempDir

    Where tempDir is an empty directory needed only during the installation. You may omit the -d option when you have already downloaded the zip file to an empty directory.

  3. The extracted files will contain the setup application, the setup configuration files, and the software in compressed format. Run the setup application with super-user privileges:

       # tempDir /setup

  4. The setup application will lead you through the installation of the software. When asked for input, you may press Return to accept the default, or type a new value. You may also type Control-B to go back to the previous screen or Control-C to quit without installing.

    When prompted to do so, you must type Yes or yes to accept the software license. The default is to not accept the license and exit the setup application.

    You will also be asked to choose a location for the software. The default directory is /opt/iPlanet. Some functionality of the iPlanet DSRK tools relies on this default directory. You may have to specify additional tool options or set your LD_LIBRARY_PATH if you install the software in another location.

    The software is bundled as a single component to be installed all at once. Press Return to install the single component when asked to do so.

  5. After the installation of the software is complete, you no longer need the contents of the temporary directory. Use the following command to remove it and all files it contains:

       $ rm -Rf tempDir /*

Once installed, the APIs and tools of the iPlanet Directory Server Resource Kit are ready to be used. See "Files and Directories" for a description of the product contents.


Removing the Software

The product includes an uninstall application to remove the iPlanet DSRK software from your machine. Use this application before installing an upgraded version of the product.

  1. If you customized any files in the software bundle and wish to keep them, you must first rename them or copy them to another location outside of the installation directory. The uninstall application will remove all product files by name, but it will not remove other files found under the installation directory. Any personal configuration files may thus be kept and used with an upgraded version of the software when it is installed in the same location.

  2. To remove the software, run the following command with super-user privileges:

       # installDir /uninstall

  3. The uninstall application will ask you to specify the components and subcomponents to remove. The software is a single component and will be removed all at once. Press Return twice to select the single component by default and remove all iPlanet DSRK software.

    If there are no custom files to keep, the uninstall application will also remove the installation directory.

The uninstall application relies on the files in the installDir /setup directory that was created at installation. If these file are deleted or modified, the application will be unable to remove the software. In that case you may delete the software manually, after moving any customized files you wish to keep to a different location. Run the following command with super-user privileges:

# rm -Rf installDir /*

The iPlanet DSRK is installed only by copying files, meaning that it is not registered with any system-wide list of packages or installed software. Therefore, removing all files will remove the iPlanet DSRK from your system.



Files and Directories


This guide uses the term installDir to refer to the installation directory, either the default or custom location where you chose to install the software. This directory contains the product components in the following directories.


Table 2-1    Directories of the iPlanet DSRK Installation

Directory

Contents

bin/idsrk51  

Contains executable binary files for most tools in the toolkit.  

perl  

Contains Perl scripts for the remaining, Perl-based tools.  

lib  

Contains binary libraries needed for running the tools. These include the same binaries as contained in the iPlanet LDAP SDK for C.  

lib/lash
lib/tcl8.2  

Contains Tcl scripts used by the ilash tool (see Chapter 31 "ilash Overview").  

lib/ldapcsdk  

The base directory for the iPlanet LDAP SDK for C. Its subdirectories contain the include files and the binary libraries needed to develop and run applications using this C API.  

lib/ldapjdk  

The base directory for the iPlanet LDAP SDK for Java. It contains the jar files needed to develop and run applications using this Java API.  

lib/nss  

The base directory for the Netscape Security Services, containing subdirectories for the run-time libraries and tools binaries.  

jdgw  

Contains all the components needed to install and run the jdgw (JSP Directory Gateway) phone book sample application (see Chapter 29).  

etc  

Location of the system-wide configuration file for the ilash tool. The installation includes the file system.lashconfig-sample.  

examples  

Contains examples of ldclt usage in Korn shell scripts.  

data  

Location of the data files for the dbgen.pl tool.  

unsupported  

Contains sample Perl scripts and the PerLDAP tool, all provided "as-is" with no support and no endorsement.  

setup  

Contains log files from the setup process. These files are used by the uninstall program and should not be modified or deleted.  



Release Notes URL


This guide documents the tools of the iPlanet Directory Server Resource Kit, Version 5.1, released in April 2002. Release notes are published and kept up to date at the following URL:

http://docs.iPlanet.com/docs/manuals/dirsdk/51/relnotes.htm

Previous     Contents     Index     Next     
Copyright 2002 Sun Microsystems, Inc.. All rights reserved.

Last Updated April 15, 2002