51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! CCPL HEADER START
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! This work is licensed under the Creative Commons
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! To view a copy of this license, visit
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! or send a letter to Creative Commons, 444 Castro Street,
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Suite 900, Mountain View, California, 94041, USA.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! You can also obtain a copy of the license at
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! See the License for the specific language governing permissions
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! and limitations under the License.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! If applicable, add the following below this CCPL HEADER, with the fields
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! enclosed by brackets "[]" replaced with your own identifying information:
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! Portions Copyright [yyyy] [name of copyright owner]
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark ! CCPL HEADER END
2d35fc1446858c96814d2604be387ee1da57930fmark ! Copyright 2011-2015 ForgeRock AS.
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
2d35fc1446858c96814d2604be387ee1da57930fmark <title>Installing OpenDJ With a Graphical Installer</title>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm><primary>Downloading OpenDJ</primary></indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <indexterm><primary>Quick install</primary></indexterm>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If you want only to try OpenDJ server software, and you do not plan to
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark store any real or important data that you want to keep, then read only this
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark chapter, or just try out installation without reading any further.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <xinclude:include href="/shared/itemizedlist-download.xml" />
2d35fc1446858c96814d2604be387ee1da57930fmark <title>Installing OpenDJ With the QuickSetup Wizard</title>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>QuickSetup uses Java WebStart to let you perform an installation of
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark OpenDJ directory server starting with a click in your web browser, which can
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark be a great way to try OpenDJ directory server for the first time, or to do a
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark quick test installation.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>OpenDJ directory server relies on Java 6 or later, so if your browser
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark picks up an old installation of Java 5 for example, installation can
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark fail. You might see an application error message such as this:</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/missing-java6.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Message showing the browser is unable to launch the application</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>If the WebStart installation does not work in your browser, copy
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark the WebStart URL, ending in <literal>QuickSetup.jnlp</literal>, from the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark OpenDJ download page. Next, pass the link as an argument to the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <command>javaws</command> command in a terminal window to start the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark installer.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>export PATH=/path/to/java/bin:$PATH</userinput>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark$ <userinput>javaws <replaceable>URL-to-QuickSetup-Installer</replaceable></userinput>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark The WebStart installer corresponds to what you start
ec40cc0dc62425cea5d63fd9d984f8614479de25mark if you download OpenDJ-${docTargetVersion}.zip,
ec40cc0dc62425cea5d63fd9d984f8614479de25mark unzip the file,
ec40cc0dc62425cea5d63fd9d984f8614479de25mark and then run the
ec40cc0dc62425cea5d63fd9d984f8614479de25mark or <command>opendj/QuickSetup.app</command> (Mac OS X).
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Java WebStart launches the the QuickSetup wizard, and soon the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Welcome screen appears.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/QuickSetup-welcome.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>The Welcome screen summarizes the setup process.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/QuickSetup-license.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Accept the license to install OpenDJ directory server if QuickSetup
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark presents a license text.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/QuickSetup-svrconf.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>In the Server Settings screen that the default ports
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark are 389 or 1389 for LDAP, 4444 for administrative access.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/QuickSetup-replopts.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>You can replicate data for high availability through the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Topology Options screen.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/QuickSetup-gendata.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>You can generate test data as part of server setup in the Directory
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark Data screen.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/QuickSetup-jvmopts.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>For a real installation, you can adjust JVM parameters for
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark your server, for example to allow OpenDJ to use more memory.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/QuickSetup-review.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>You can opt to start your server when setup completes.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/QuickSetup-finished.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>Click the Launch Control Panel button to check your newly
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark installed server.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imagedata fileref="images/OpenDJ-Control-Panel.png" format="PNG" />
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </imageobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>OpenDJ Control Panel offers basic administration capabilities.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </textobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </mediaobject>
2d35fc1446858c96814d2604be387ee1da57930fmark </section>
2d35fc1446858c96814d2604be387ee1da57930fmark <title>Installing OpenDJ From the Windows Installer Package</title>
2d35fc1446858c96814d2604be387ee1da57930fmark You can start installing OpenDJ directory server on Windows systems
2d35fc1446858c96814d2604be387ee1da57930fmark from the Windows installer package,
2d35fc1446858c96814d2604be387ee1da57930fmark <indexterm><primary>Windows installer (.msi) package</primary></indexterm>
2d35fc1446858c96814d2604be387ee1da57930fmark <title>To Install OpenDJ From the Windows Installer Package</title>
2d35fc1446858c96814d2604be387ee1da57930fmark Installing OpenDJ directory server by using the Windows installer package
2d35fc1446858c96814d2604be387ee1da57930fmark is a two-stage process.
2d35fc1446858c96814d2604be387ee1da57930fmark First, you install the files by using the Windows installer package wizard.
2d35fc1446858c96814d2604be387ee1da57930fmark Second, you configure OpenDJ by using the <command>setup</command> command.
2d35fc1446858c96814d2604be387ee1da57930fmark Install OpenDJ files in one of the following ways.
2d35fc1446858c96814d2604be387ee1da57930fmark <stepalternatives>
2d35fc1446858c96814d2604be387ee1da57930fmark <substeps>
2d35fc1446858c96814d2604be387ee1da57930fmark Double-click the Windows installer package,
2d35fc1446858c96814d2604be387ee1da57930fmark to start the install wizard.
2d35fc1446858c96814d2604be387ee1da57930fmark In the Destination Folder screen, set the folder
2d35fc1446858c96814d2604be387ee1da57930fmark where the wizard installs OpenDJ directory server files.
2d35fc1446858c96814d2604be387ee1da57930fmark The default location is under Program Files on the system drive.
2d35fc1446858c96814d2604be387ee1da57930fmark For example if the system drive is C:, the default location is
2d35fc1446858c96814d2604be387ee1da57930fmark as the native executable is a 32-bit application,
2d35fc1446858c96814d2604be387ee1da57930fmark though you can run OpenDJ directory server
2d35fc1446858c96814d2604be387ee1da57930fmark with a 64-bit Java environment.
2d35fc1446858c96814d2604be387ee1da57930fmark </substeps>
2d35fc1446858c96814d2604be387ee1da57930fmark Use the Microsoft <command>msiexec.exe</command> command
2d35fc1446858c96814d2604be387ee1da57930fmark to install the files.
2d35fc1446858c96814d2604be387ee1da57930fmark The following example installs OpenDJ directory server files under
2d35fc1446858c96814d2604be387ee1da57930fmark writing an installation log file, <filename>install.log</filename>,
2d35fc1446858c96814d2604be387ee1da57930fmark in the current folder.
2d35fc1446858c96814d2604be387ee1da57930fmarkC:\><userinput>msiexec /i OpenDJ-${docTargetVersion}.msi /l* install.log /q OPENDJ=C:\OpenDJ-${docTargetVersion}</userinput>
2d35fc1446858c96814d2604be387ee1da57930fmark </stepalternatives>
2d35fc1446858c96814d2604be387ee1da57930fmark Start the installation.
2d35fc1446858c96814d2604be387ee1da57930fmark When installation is finished, OpenDJ directory server files
2d35fc1446858c96814d2604be387ee1da57930fmark are found in the location you specified as Destination Folder.
2d35fc1446858c96814d2604be387ee1da57930fmark You must still run the <command>setup</command> command
2d35fc1446858c96814d2604be387ee1da57930fmark before you can use OpenDJ directory server.
2d35fc1446858c96814d2604be387ee1da57930fmark Browse to the Destination Folder,
2d35fc1446858c96814d2604be387ee1da57930fmark to start the OpenDJ QuickSetup wizard
2d35fc1446858c96814d2604be387ee1da57930fmark and following the instructions on screen
2d35fc1446858c96814d2604be387ee1da57930fmark as described in <xref linkend="install-gui-quick-setup" />.
2d35fc1446858c96814d2604be387ee1da57930fmark </procedure>
2d35fc1446858c96814d2604be387ee1da57930fmark </section>
2d35fc1446858c96814d2604be387ee1da57930fmark You might close OpenDJ Control Panel,
2d35fc1446858c96814d2604be387ee1da57930fmark or decide to start it later after closing the QuickSetup wizard.
2d35fc1446858c96814d2604be387ee1da57930fmark <itemizedlist>
2d35fc1446858c96814d2604be387ee1da57930fmark To launch OpenDJ Control Panel again later, run the
2d35fc1446858c96814d2604be387ee1da57930fmark Depending on your host system, this command is one of the following.
2d35fc1446858c96814d2604be387ee1da57930fmark <listitem>
2d35fc1446858c96814d2604be387ee1da57930fmark <para>(Mac OS X) <command>/path/to/opendj/bin/ControlPanel.app</command></para>
2d35fc1446858c96814d2604be387ee1da57930fmark </listitem>
2d35fc1446858c96814d2604be387ee1da57930fmark <listitem>
2d35fc1446858c96814d2604be387ee1da57930fmark <para>(UNIX) <command>/path/to/opendj/bin/control-panel</command></para>
2d35fc1446858c96814d2604be387ee1da57930fmark </listitem>
2d35fc1446858c96814d2604be387ee1da57930fmark <listitem>
2d35fc1446858c96814d2604be387ee1da57930fmark <para>(Windows) <command>C:\path\to\opendj\bat\control-panel.bat</command></para>
2d35fc1446858c96814d2604be387ee1da57930fmark </listitem>
2d35fc1446858c96814d2604be387ee1da57930fmark </itemizedlist>
2d35fc1446858c96814d2604be387ee1da57930fmark </section>