1.4. Overview of Setup

After the Directory Server packages are installed, there is a script, setup-ds-admin.pl, which you run to configure the new Directory Server and Administration Server instance. This script launches an interactive setup program. The setup program supplies default configuration values which you can accept them or substitute with alternatives. There are three kinds of setup modes, depending on what you select when you first launch the setup program:
  • Express — The fastest setup mode. This requires minimal interaction and uses default values for almost all settings. Because express installation does not offer the choice of selecting the Directory Server server port number or the directory suffix, among other settings, Red Hat recommends that you not use it for production deployments. Also, express setups can fail if default configuration values are not available because there is no way to offer an alternative.
  • Typical — The default and most common setup mode. This prompts you to supply more detailed information about the directory service, like suffix and configuration directory information, while still proceeding quickly through the setup process.
  • Custom — The most detailed setup mode. This provides more control over Administration Server settings and also allows data to be imported into the Directory Server at setup, so that entries are already populated in the databases when the setup is complete.
The information requested with the setup process is described in Comparison of Setup Types.
There is a fourth setup option, silent setup, which uses a configuration file and command-line options to supply the Directory Server settings automatically, so there is no user interaction required. It is also possible to pass setup arguments with the script, as described in Section 1.3, “About the setup-ds-admin.pl Script”. The possible .inf setup file parameters are listed and described in Appendix A, Parameters in .inf Files.

Note

It is possible to use y and n with the yes and no inputs described in Appendix A, Parameters in .inf Files.

Comparison of Setup Types

Continue with setup
  • Parameter input: yes or no
  • Option available in the following interactive modes: all
  • Silent setup file parameter: not available
Accept license agreement
  • Parameter input: yes or no
  • Option available in the following interactive modes: all
  • Silent setup file parameter: not available
Accept dstune output and continue with setup
  • Parameter input: yes or no
  • Option available in the following interactive modes: all
  • Silent setup file parameter: not available
Choose setup type
  • Parameter input: 1 (express), 2 (typical), and 3 (custom)
  • Option available in the following interactive modes: all
  • Silent setup file parameter: not available
Set the computer name
  • Parameter input: server.example.com
  • Option available in the following interactive modes: Typical and Custom
  • Silent setup file parameter: 
    [General]
FullMachineName=ldap.example.com
Set the user as which Directory Server will run
  • Parameter input: dirsrv
  • Option available in the following interactive modes: Typical and Custom
  • Silent setup file parameter: 
    [General]
SuiteSpotUserID=dirsrv
Set the group as which Directory Server will run
  • Parameter input: dirsrv
  • Option available in the following interactive modes: Typical and Custom
  • Silent setup file parameter: 
    [General]
SuiteSpotGroup=dirsrv
Register the new Directory Server with an existing Configuration Directory Server
  • Parameter input: yes or no
  • Option available in the following interactive modes: all
  • Silent setup file parameter: not available
Set the Configuration Directory Server URL[1]
  • Parameter input: ldap://server.example.com:389/o=NetscapeRoot
  • Option available in the following interactive modes: all
  • Silent setup file parameter: 
    [General]
ConfigDirectoryLdapURL=ldap://server.example.com:389/o=NetscapeRoot
Set the configuration Directory Server user ID [1]
  • Parameter input: admin
  • Option available in the following interactive modes: all
  • Silent setup file parameter: 
    [General]
ConfigDirectoryAdminID=admin
Set the configuration Directory Server user password [1]
  • Parameter input: password
  • Option available in the following interactive modes: all
  • Silent setup file parameter: 
    [General]
ConfigDirectoryAdminPwd=password
Set the Configuration Directory Server administration domain [1]
  • Parameter input: example.com
  • Option available in the following interactive modes: all
  • Silent setup file parameter: 
    [General]
AdminDomain=example.com
Set the path to the CA certificate (if using LDAPS) [1]
  • Parameter input: /tmp/CAcert.pem
  • Option available in the following interactive modes: all
  • Silent setup file parameter: 
    [General]
CACertificate=/tmp/CAcert.pem
Set the Configuration Directory Server Administrator user name [1]
  • Parameter input: admin
  • Option available in the following interactive modes: all[2]
  • Silent setup file parameter: 
    [General]
ConfigDirectoryAdminID=admin
Set the Configuration Directory Server Administrator password
  • Parameter input: password
  • Option available in the following interactive modes: all [2]
  • Silent setup file parameter: 
    [General]
ConfigDirectoryAdminPwd=password
Set the Directory Server port
  • Parameter input: 389
  • Option available in the following interactive modes: Typical and Custom
  • Silent setup file parameter: 
    [slapd]
ServerPort=389
Set the Directory Server identifier
  • Parameter input: instance_name
  • Option available in the following interactive modes: Typical and Custom
  • Silent setup file parameter: 
    [slapd]
ServerIdentifier=instance_name
Set the Directory Server suffix
  • Parameter input: dc=example,dc=com
  • Option available in the following interactive modes: Typical and Custom
  • Silent setup file parameter: 
    [slapd]
Suffix=dc=example,dc=com
Set the Directory Manager ID
  • Parameter input: cn=Directory Manager
  • Option available in the following interactive modes: all
  • Silent setup file parameter: 
    [slapd]
RootDN=cn=Directory Manager
Set the Directory Manager password
  • Parameter input: password
  • Option available in the following interactive modes: all
  • Silent setup file parameter: 
    [slapd]
RootDNPwd=password
Install sample entries
  • Parameter input: yes or no
  • Option available in the following interactive modes: Custom
  • Silent setup file parameter: 
    [slapd]
AddSampleEntries=yes
Populate the Directory Server with entries
  • Parameter input:
    • Supply the full path and file name to an LDIF file.
    • Type suggest, which imports common container entries, such as ou=People.
    • Type none, which does not import any data.
  • Option available in the following interactive modes: Custom
  • Silent setup file parameter:
    • Equivalent to suggest: 
      [slapd]
AddOrgEntries=Yes
InstallLdifFile=suggest
    • Equivalent to setting the path: 
      [slapd]
AddOrgEntries=Yes
InstallLdifFile=/tmp/data.ldif
Set the Administration Server port
  • Parameter input: 9830
  • Option available in the following interactive modes: Typical, Custom
  • Silent setup file parameter: 
    [admin]
Port=9830
Set the Administration Server IP address
  • Parameter input: blank (all interfaces)
  • Option available in the following interactive modes: Custom
  • Silent setup file parameter: 
    [admin]
ServerIpAddress=192.0.2.1
Set user as which the Administration Server runs
  • Parameter input: dirsrv
  • Option available in the following interactive modes: Custom
  • Silent setup file parameter: 
    [admin]
SysUser=dirsrv
Are you ready to configure your servers?
  • Parameter input: yes or no
  • Option available in the following interactive modes: all
  • Silent setup file parameter: not available

[1] This option is only available if you choose to register the Directory Server instance with a Configuration Directory Server.
[2] This option is only available if you choose not to register the Directory Server instance with a Configuration Directory Server. In that case, Directory Server being set up is created and configured as a Configuration Directory Server.