Skip to main content
Last updated February 16, 2012 13:32, by ctissot

OpenDS User Documentation

Installing OpenDS With QuickSetup

QuickSetup is a Java-based graphical tool designed to enable rapid installation, and configuration of an OpenDS directory server, including loading it with data and getting it running. QuickSetup asks some basic questions about the server configuration and then gives you the choice of leaving your database empty, loading the server with data from your own LDIF or loading the server with automatically generated sample data. QuickSetup also enables you to configure security and replication, and will optionally start the server when the configuration is complete.

QuickSetup can be run remotely via Java Web Start or locally from the build that you have downloaded and unzipped. If you run QuickSetup as a Java Web Start application, it automatically downloads and unzips the build, and handles server configuration. If you run QuickSetup locally, it allows you to configure the build that you have unbundled.

Before you launch QuickSetup, review the OpenDS System Requirements.

Launch QuickSetup Now

Running OpenDS QuickSetup via Java Web Start

Java Web Start is a component of the Java Runtime Environment (JRE) that allows you to download and run Java applications from the web. Java Web Start is installed with the JRE and is automatically started when you launch an application using the Java Web Start technology. The application is downloaded and cached locally on your system before it is started. Whenever you launch that application in the future, Java Web Start checks with the remote server to make sure that you have the latest version. See this FAQ item on Java Web Start on the web site for more information.

You can launch the Java Web Start version of QuickSetup from the QuickSetup link on the OpenDS site. If you have run QuickSetup in the past, you can double-click the OpenDSQuickSetup.jnlp file that was downloaded when you ran it. When you launch QuickSetup, Java Web Start checks to make sure that you have the latest version of the QuickSetup bits and downloads them if necessary. It then launches the QuickSetup Welcome panel.

  • Select "Install New Server Instance" and click Next.

  • Enter a valid port for LDAP operations. If you run QuickSetup as the root user, port 389 is used as the default LDAP port. If you run QuickSetup as a non-root user, port 1389 is used as the default port.
  • LDAP secure access is disabled by default. If you require secure access, click the Configure button on this panel.

  • Enter a valid port for secure LDAP operations. If you run QuickSetup as the root user, port 636 is used as the default secure port. If you run QuickSetup as a non-root user, port 1636 is used as the default secure port.
  • Enable StartTLS, if required. For more information about StartTLS, see The StartTLS Extended Operation Handler.
  • If you have an existing certificate, enter the certificate details. If you are installing OpenDS for evaluation purposes, you can use the self-signed certificate that is generated by the server.
  • When you have configured secure access, click OK to return to the Server Settings panel.
  • Enter any additional configuration settings on this panel and click Next.

Note: QuickSetup might display a security warning about the test certificate not being verifiable with a certificate authority. You can trust the OpenDS Test Certificate.

  • If this server will be part of a replicated topology, enter the replication details here. Configuring replication settings during the QuickSetup installation is the easiest way to set up replication. If you want to set up replication after installation, see How To Set Up Replication With dsreplication.
  • When you configure the replication settings on this panel, a replication server is installed with the directory server. OpenDS uses port 8989 as the default replication port.
  • When you have finished entering the topology options, click Next.

  • This panel enables you to specify data import options.
  • For evaluation purposes you can import a specified number of sample entries generated by OpenDS.

  • This panel enables you to review your configuration settings and make any necessary adjustments.
  • By default, QuickSetup starts the server when the configuration has completed. Disable the checkbox at the bottom of this panel if you don't want to start the server.
  • When you have verified your configuration settings, click Finish to complete the configuration.

  • The Progress panel indicates what is happening during the installation, and enables you to assess the progress.

  • When the installation is complete, a status message is displayed indicating success or failure.
  • To view the status of the server, click the Launch Control Panel button. For more information, see control-panel.

Running OpenDS QuickSetup Locally

You can also run QuickSetup after you have downloaded and unzipped a build. To do this, run the setup (or setup.bat) command at the top level of your OpenDS installation directory. The configuration screens are similar to those shown previously, with the exception that you are not asked to provide an installation directory on the Server Settings panel.

To run a functionally-equivalent command-line version of the QuickSetup tool, execute the setup --cli or setup.bat --cli command. For more information, see setup.


If you have any questions, comments or problems with OpenDS QuickSetup, send an e-mail to the mailing list.

Please Confirm