Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Installing the Directory Server

After you have installed and configured your administration server, you must install and configure a directory server instance. If you plan to use replication in your directory service, you must install a supplier server and one or more consumer servers. The order in which you install supplier and consumer servers depends on whether you are installing the product for the first time or upgrading from a previous version of the product. For information on the order in which you should install servers, see "Installation Process Overview".

To install and configure a directory server instance, you use the administration server's server selector to complete an HTML configuration form. See "Configuration Decisions" for a description of the configuration information you will be prompted for during installation. If you do not understand a setting, you can use the default value and later change it using the server manager forms.

The form collects data that is used to generate the configuration file called slapd.conf (the server uses this file to control how it works).

This chapter includes the following topics:

  • "Performing a New Installation"

  • "Upgrading Your Directory Service"

 

Performing a New Installation

When installing the Netscape Directory Server for the first time, you should:

  • Plan your directory service. By carefully planning your directory service before you begin installing the software, you can create a directory service that is easy to scale and manage as your organization grows. For guidelines on planning your directory service, refer to the Netscape Directory Server Deployment Guide.

  • Install a directory server instance. If you plan on using replication to provide fault-tolerance for your directory service, the initial server instance you install will be your supplier server. Any subsequent server instances you install will be consumer servers. For more information on replication, see the Netscape Directory Server Administrator's Guide. For instructions on installing a server instance, see "Installing a Directory Server Instance".

  • Create a directory tree. After you install your first directory server instance, you should create a minimal directory tree before you continue installing additional server instances or other components. For a discussion of the order in which you should install and deploy directory server services, see "New Installation Process". For information on how to create your initial directory entries, see "Creating a Directory Tree".

 

Installing a Directory Server Instance

Use the following procedure to install a new server instance:

  1. Connect to the administration server's server selector using one of the following methods:
  • NT or Unix: Use your web browser to connect to http://<server>:<port> where <server> is the DNS host name where you installed your administration server, and <port> is the port that your administration server is using for communications.

  • NT only: Go to the Netscape folder, and select Administer Netscape Servers.

Either way, when you connect to your administration server, you are prompted for the administration server login ID and password.

  • From the server selector, click "Create new Netscape Directory Server 3.1."
  • Type the server name. Users will use this name when they access your server. Include your machine and domain name. If your system administrator has set up a DNS alias for your server, enter the alias here. If not, use the machine's name combined with your domain name as the server's name. If you are installing a second server for a different domain, enter the domain here.
  • Enter the port number for your server. For guidelines on selecting port numbers, see "Choose Unique Port Numbers".
  • Enter the server identification that the administration server will use for your directory server. The server identification should contain no spaces or slashes.
  • This identification will also be used as the directory name in your server root to store the server configuration files.

  • Unix only: Enter the user name you want the server to run as. This field is optional; if you leave it blank, the directory server will run as the same user as the administration server.
  • If you want to have the installation script automatically create a simple directory for you, click the "Configure Directory for SuiteSpot" checkbox. For guidelines about when to use this option, see "Decide Whether to Use SuiteSpot 3.x Integration". If you click this checkbox, then you must also enter the following information:
    • UserID for SuiteSpot Management--This should be the user ID that you use to log in to your administration server.

    • Password--Enter (and then repeat) the password that you use when you log in to your 3.x administration server.

  • Enter the directory subtree, or DN suffix, to be used for this directory. This suffix represents the root point for your directory; the first entry in your directory must use this name. Queries for entries to the directory must match this suffix before ns-slapd will process the request.
  • For more information on suffixes and distinguished names and on how nonmatching suffixes are handled, refer to the Netscape Directory Server Deployment Guide.

  • Enter the distinguished name (DN) for the user who will have unrestricted access to the directory server database (this is known as the root DN). This DN is not the same name as the user name you set up for the administration server. The root DN is a full distinguished name, whereas the other is simply a user name. There is no correspondence between the two. For more information about creating a root DN, see "Define a Root DN".
  • If you specified a root DN in Step 9, enter a corresponding password. This password is required. The password must be at least eight characters in length.
  • Warning
    It is possible for the root password to be deleted from the server by directly editing the server's configuration file (slapd.conf). In this situation, the root DN can only obtain the same access to your directory as you allow for anonymous access. Always make sure that a root password is defined in slapd.conf when a root DN is configured for your database.

    For more information about slapd.conf, see the Netscape Directory Server Administrator's Guide.

    1. Click OK.
    2. If the configuration was successful, you will see a page showing your new server's name, the port it uses, and the location of your database. From this page, you can configure your server further, start your new server, register your server for technical support, install another server, or return to the server selector. Clicking the "Configure your server further" link will take you to the server manager, where you can configure your server. For more information about the server manager, refer to Managing Netscape Servers.

     

    Creating a Directory Tree

    After you have installed a directory server instance, you need to create a database to use with your server; a database is not created for you during server installation, unless you checked "Configure Directory for SuiteSpot" when you created your server instance.

    Although you do not need to create your entire directory tree now, you should at least set up the major branch points of your tree before you continue installing additional directory server instances (consumers) or the NT synchronization service.

    Note
    Currently your database must be in the <NSHOME>/slapd-<serverID>/db directory.
    There are several ways you can create a directory:

    • Create a database from LDIF--Use this method if you want to use the sample directory shipped with the directory server, if you are importing entries from another directory via LDIF, or if you have more than a few entries to add at once. For more information about LDIF, refer to Chapter 2 of the Netscape Directory Server Administrator's Guide.

    • Start your directory server with an empty database--This method requires you to populate your directory using an LDAP client such as the directory server gateway or the ldapmodify command-line utility. Use this method if you have just a few entries to add at a time. For information on setting up the directory server gateway, see Chapter 5, "Configuring the Gateway."

    • Use the Create SuiteSpot settings form--From the server manager, select Database Management|SuiteSpot Settings. Filling out this form creates a basic directory and sets minimum access control for the directory. You need to use the ldapadd command-line utility or the directory server gateway to populate the directory.

    As you are populating your directory, consider your access control needs and set access control accordingly. If you do not set any access control for your directory, you will be able to access your directory only as the root DN. You had the opportunity to configure the root DN in Step 9. For more information on access control, see the Netscape Directory Server Deployment Guide and the Netscape Directory Server Administrator's Guide.

     

    Upgrading Your Directory Service

    You can upgrade to Netscape Directory Server 3.1 from either the 3.0 or 1.x release. For information, see "Upgrading from Directory Server 3.0" or "Upgrading from Directory Server 1.x" as appropriate.

     

    Upgrading from Directory Server 3.0

    You can upgrade your 3.0 Directory Server to the 3.1 release provided:

    • You did not set the allidthreshold slapd.conf parameter.

    • You are not maintaining approximate indexes against non-ASCII data.

    If either of these two conditions are not true, then you must export your database to LDIF, install the 3.1 directory server, and reimport that LDIF to your 3.1 directory server. If the above statements are true, follow these installation instructions:

    1. Shut down the administration server and the directory server.
    2. Install your 3.1 directory server as described in "Performing a New Installation". Make sure you install your directory server to the same directory where your 3.0 directory server is installed. The upgrade process does not overwrite the 3.0 configuration or log files, or the certificate database for either the administration server or the directory server.
    3. Start your 3.1 administration server and then the directory server.
    4. If you are using the directory server gateway, reconfigure your web server to use the gateway in the new location. See Chapter 5, "Configuring the Gateway," for information on how to configure a web server with your gateway.

    You are done upgrading to Directory Server 3.1.

     

    Upgrading from Directory Server 1.x

    The Netscape Directory Server provides two methods for upgrading from the 1.x version of the directory server.

    • automatic upgrade--Upgrades all configuration and access control information from your 1.x server to your new 3.1 server with the exception of schema enhancements. In most cases you can and should use the automatic upgrade process. The automatic upgrade process:

      • Creates a new server instance.

      • Merges the 1.x and 3.1 directory server configuration files (slapd.conf).

      • Copies all remaining configuration files, including the standard schema.

      • Merges the 1.x and 3.1 directory server gateway configuration files (dsgw.conf).

      • Converts any old database backup files to work with the new directory server instance and copies them to the new installation directory. This includes converting the old access control statements to the new ACI syntax and updating the suffix if it has changed.

      • Converts any old LDIF files to work with the new directory server instance. This includes converting the old access control statements to the new ACI syntax and updating the suffix if it has changed.

      • Converts the access control syntax in the old directory database to the new format.

      • Backs up all configuration files to the conf_bk directory.

    • manual upgrade--You must manually make any configuration and access control, and schema enhancements that you made to your 1.x server to your 3.1 server. You only need to use the manual upgrade process if you plan to install your 3.1 directory server on a different physical machine from the one on which your 1.x server was installed.

    The following sections provide procedures for each upgrade method.

     

    Automatically Upgrading from 1.x to 3.1

    To upgrade your 1.x directory server automatically, do the following:

    1. Shut down your 1.x directory server.
    2. Install the 3.x administration server on the same machine as the 1.x server. Alternatively, you can install the 3.x administration server on a different machine as long as your 1.x database is accessible to the administration server over a mounted file system. If you choose to install the 3.x administration server on a machine other than the one where the 1.x server is installed, the two machines must be running the same operating system.
    3. Connect to the administration server's server selector using one of the following methods:
    • NT or Unix: Use your web browser to connect to http://<server>:<port> where <server> is the DNS host name where you installed your administration server, and <port> is the port that your administration server is using for communications.

    • NT only: Go to the Netscape folder, and select Administer Netscape Servers.

    Either way, when you connect to your administration server, you are prompted for the administration server login ID and password.

  • Click "Migrate from previous version".
  • In the Server Root to Import From field, enter the full path to the installation root directory for your 1.x directory server. For example, enter:
  • /netscape/server

  • Select the directory server entry from the Servers to Import From list. A new directory server instance is now created based on the directory data and configuration file contents in your 1.x directory server.
  • Go to the ON/OFF screen in your 3.1 server manager.
    • If you are upgrading a non-replicated directory service or a supplier server, click Apply and then click Apply Manual Changes.

    • If you are upgrading a consumer server, click Apply and then click Apply Changes.

  • Add any schema enhancements you used in your 1.x server. To extend the schema, select the Schema tab from the 3.1 server manager. Note also that many object classes and attributes were removed from the schema that existed in the 1.x release. Refer to the release notes for this product for a list of the object classes and attributes that have been removed. If you were using any of these object classes or attributes in 1.x, you must manually add them to your 3.1 server.
  • Examine your configuration and schema files carefully to verify that the new directory server is configured correctly.
  • If you migrated a supplier server, make sure you configure a new changelog and changelog suffix (cn=changelog recommended) before starting the new server. If you do not do this, replication will not work.
  • Start the new directory server instance.
  •  

    Manually Upgrading from 1.x to 3.1

    To upgrade your 1.x directory server manually, you must perform the tasks in the following sections:

    • "Saving the Configuration Files"

    • "Documenting the Directory Server Settings"

    • "Installing the New Server Instance"

    • "Updating the Configuration Files"

    • "Extending the Schema"

    • "Upgrading the Access Control Statements"

    • "Importing the LDIF File"

    • "Removing the 1.x Directory Server Instance"

    You may also optionally create SuiteSpot integration entries (see "Creating the SuiteSpot Integration Entries").

     

    Saving the Configuration Files
    As part of the manual upgrade process, you will delete your old directory server instance. However, before you do that, you must save your old database and configuration files. To save the old files, do the following:

    1. Export your 1.x database to LDIF. You do this by selecting Database Mgmt | Backup as an LDIF file from the directory server manager.
    2. Save the exported LDIF file in a location outside of your server root directory.
    3. Save the directory server configuration file, <NSHOME>/slapd-<serverID>/config/slapd.conf, copy it to the same location where you saved the LDIF file in Step 2.
    4. If you extended your schema in the 1.x release, copy the following files to the same location where you saved the LDIF file in Step 2.
    5. <NSHOME>/slapd-<serverID>/config/slapd.at.conf

      <NSHOME>/slapd-<serverID>/config/slapd.oc.conf

    6. If you modified your 1.x gateway configuration file, <NSHOME>/slapd-<serverID>/dsgw/config/dsgw.conf, copy it to the same location where you saved the LDIF file in Step 2.

     

    Documenting the Directory Server Settings
    In order to successfully migrate your 1.x directory server to the 3.1 version, you must record the following information about your existing directory server instance. You can use the empty column on the following table to record the information.

    Table 4.1 Directory Server Settings

    Item

    Description and example

    Value for your server

    Server name

    The name your server runs as. For example:

    phonebook.airius.com

    Server port

    The port you use for standard LDAP connections (not encrypted).

    Encryption enabled?

    Indicates whether you are using encryption (LDAPS) with your 1.x directory server.

    Encrypted port

    The port you use for LDAPS (encrypted) connections.

    Server identifier

    The name of the directory under which your directory server is installed. For example, if your server was installed with the server name of phonebook, then your server was probably installed at:

    <NSHOME>/slapd-phonebook

    Database subtree

    The directory suffix. You will have at least two suffixes set for your directory. One equates to your directory root point (for example, o=airius.com) and one will be related to your directory's machine data area (for example, dc=name, dc=domain, dc=domain). Record the suffix name that you store your primary directory contents under. If your directory serves more than one suffix, record all of your suffixes.

    Root DN

    The user who has unrestricted access to the directory. For example, directory manager.

    Root DN password

    The password that corresponds to the root DN user.

     

    Installing the New Server Instance
    Once you have saved your configuration files and old database, you are ready to install the new server instance. Use the procedure titled "Installing a Directory Server Instance" to install the server. Use the information you recorded in Table 4.1 when prompted for configuration information.

    Note
    The new installation form has an option that allows you to configure your directory server for integration with other SuiteSpot 3.x servers. Do not select this option. This option creates a directory database that will only be overwritten when you recreate your database from the LDIF file you created from your old database. You can manually configure your server for SuiteSpot integration. See the Netscape Directory Server Administrator's Guide for instructions.
     
    Updating the Configuration Files
    When you installed the new server instance, a new server configuration file, slapd.conf, was created. You must manually update the new file with any configuration changes you made to your 1.x server configuration. (You do this by comparing the old slapd.conf file you saved in Step 3 of the procedure titled "Saving the Configuration Files" with the new slapd.conf.) Update your new slapd.conf file with any parameter values that exist in the old version of the file but not in the new version. Some parameters that commonly need updating are the index and suffix parameters.

    In addition, if you made any changes to the gateway configuration file, dsgw.conf, in your 1.x installation, you should copy the old file that you saved (in Step 5 of the procedure titled "Saving the Configuration Files") to the following location in the new directory server installation:

    <NSHOME>/slapd-<serverID>/dsgw/config
    
     
    Extending the Schema
    If you extended the schema in your 1.x directory server installation, you must make the same extensions in your 3.1 schema configuration before you import your LDIF database. You must also extend the 3.1 schema configuration if you used any of the object classes or attributes that were in use in the 1.x product but that have been removed for the 3.1 release.

    For a list of the obsolete object classes and attributes, look in relnotes.htm included on the product CD or go to the following URL:

    http://home.netscape.com/eng/server/directory/3.1/relnotes.htm#delobj
    
    If you are unsure of what modifications you made to your schema, you can refer to the attribute configuration file (slapd.at.conf) and object class configuration file (slapd.oc.conf) that you saved in Step 4 of the procedure titled "Saving the Configuration Files". Any new attributes that were added are listed after the # attributes below added for Netscape Directory Server 1.x comment line in the slapd.at.conf file. Any new object classes that were added are listed after the # objectclasses below added for Netscape Directory Server 1.x comment line in the slapd.oc.conf file.

    You can extend the schema using the 3.1 directory server manager as follows:

    1. Make sure your 1.x directory server is shut down.
    2. Start your 3.1 directory server.
    3. Select the Schema tab from the directory server manager.
    • You can create custom attributes by selecting Edit or View Attributes.

    • You can create custom object classes by selecting Create Objectclass.

    You should not modify a standard object class or attribute. Instead, to extend the schema create new object classes and attributes. For more information on extending the schema, refer to the Netscape Directory Server Administrator's Guide.

  • Stop the directory server.
  •  

    Upgrading the Access Control Statements
    You can upgrade your 1.x access control statements to use the new 3.1 syntax using the aclupg utility.

    Before you can use the aclupg utility, you must update the PATH variable to include the location of the aclupg utility, which is <NSHOME>/bin/slapd/server. On Unix systems you should also set your LD_LIBRARY_PATH variable to include the following two locations:

    <NSHOME>/lib
    
    <NSHOME>/bin/slapd
    
    For information on how to set environment variables, see your operating system documentation.

    To run the aclupg utility, do the following:

    1. Save your 1.x database to LDIF.
    2. Enter the following command:
    3. aclupg -i <filename>

      where <filename> is the name of the LDIF file you want to convert. The updated LDIF file is saved as the aclupgrade.ldif file in the same directory as the file you converted.

     

    Importing the LDIF File
    After you have upgraded the ACL statements in the old LDIF file, you can import the old LDIF file into your new database as follows:

    1. Copy the LDIF file that you saved earlier (in Step 2 of the procedure titled "Saving the Configuration Files") to the following location in the new server instance installation:
    2. <NSHOME>/slapd-<serverID>/ldif

    3. From the directory server manager, go to Database Management|Import.
    4. Select the LDIF file from the list of possible files, or enter the full path to the LDIF file in the field provided.
    5. Click OK.
    6. The new directory database is created and placed in the database directory for you.

    7. Start the directory server.

     

    Removing the 1.x Directory Server Instance
    Do not remove the 1.x directory server until you have successfully migrated to 3.1. To remove the 1.x directory server instance, do the following:

    1. Stop the 1.x directory server.
    2. From the directory server manager, click "Remove a server from this machine."
    3. In the "Remove this server" pull-down list, select the directory server instance you want to remove.
    4. Under Verification, click Yes next to "Yes, I really do want to remove this server." Do not click Yes next to "Remove the administration binaries as well."
    5. Click OK to remove the directory server instance.

     

    Creating the SuiteSpot Integration Entries
    If you want your new directory server to manage user and group information for other SuiteSpot 3.x servers, you must make some directory modifications to allow the 3.x administration server to bind to the directory and perform directory management activities.

    See the section titled "Managing SuiteSpot 3.x Integration" in the Netscape Directory Server Administrator's Guide for a discussion of the entries that must be created for integration with SuiteSpot 3.x servers.

    If you decide that you want to create the SuiteSpot 3.x integration entries, see the section titled "Creating SuiteSpot 3.x Integration Entries" in the Netscape Directory Server Administrator's Guide for instructions.

     

    Upgrading a Replicated Site

    To upgrade a replicated 1.x directory service to 3.1, do the following:

    1. Upgrade your consumer servers using the process defined in "Automatically Upgrading from 1.x to 3.1" or "Manually Upgrading from 1.x to 3.1".
    2. Before you can replicate to an upgraded consumer server, you must configure the supplier DN password. Do this on the consumer server using the Consumer Server Replication Settings area of the Replication | Configure this Server form.

      Also, when you upgrade your consumer servers, you can start them and continue with normal operations because a 1.x supplier server can replicate to a 3.1 consumer server. However, a 3.1 supplier server cannot replicate to a 1.x consumer server.

    3. Once you have upgraded all of your consumer servers, upgrade your 1.x supplier server to 3.1 using the process defined in "Automatically Upgrading from 1.x to 3.1" or "Manually Upgrading from 1.x to 3.1".
    4. Before you can replicate to your consumer server(s), you must configure your supplier's change log. Do this on the supplier server using the Supplier Server Replication Settings area of the Replication | Configure this Server form.

    5. Reinitialize all your consumer servers. If you are replicating an entire database that contains more than 5,000 - 10,000 entries, you should consider using a manual consumer initialization process. That is, use the Replication | Manual Consumer Initialization form instead of the Initialize Consumer button in the Replication | Configure Replication Agreements form.
    6. For information on how to initialize consumer servers, see the Netscape Directory Server Administrator's Guide.


    Copyright 1997 Netscape Communications Corporation. All rights reserved.

    Typewritten Software • bear@typewritten.org • Edmonds, WA 98026