chap-install-gui.xml revision 429cb4af0dd170c44fe076f66fb43338d1820073
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
08248b5c5b494aff8d1922e8e0b5777796d7450dmark ! Copyright 2011-2013 ForgeRock AS
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
08248b5c5b494aff8d1922e8e0b5777796d7450dmark xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <title>Installing OpenDJ With the QuickSetup Wizard</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" />
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>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <para>If the WebStart installation does not work in your browser, copy
ec40cc0dc62425cea5d63fd9d984f8614479de25mark the WebStart URL, ending in <literal>QuickSetup.jnlp</literal>, from the
ec40cc0dc62425cea5d63fd9d984f8614479de25mark OpenDJ download page. Next, pass the link as an argument to the
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <command>javaws</command> command in a terminal window to start the
ec40cc0dc62425cea5d63fd9d984f8614479de25mark installer.</para>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark$ javaws <replaceable>URL-to-QuickSetup-Installer</replaceable></screen>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <para>The WebStart installer corresponds to what you start if you download
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark OpenDJ-<?eval ${docTargetVersion}?>.zip, unzip the file, and then run
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <command>opendj/setup</command> (UNIX), <command>opendj\setup.bat</command>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark (Windows), or <command>opendj/QuickSetup.app</command> (Mac OS X).</para>
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>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark <imagedata fileref="images/QuickSetup-gendata.png" format="PNG" />
08248b5c5b494aff8d1922e8e0b5777796d7450dmark </imageobject>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark <textobject>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark <para>You can generate test data as part of server setup in the Directory
08248b5c5b494aff8d1922e8e0b5777796d7450dmark Data screen.</para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark </textobject>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark </mediaobject>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <imageobject>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark <imagedata fileref="images/QuickSetup-jvmopts.png" format="PNG" />
08248b5c5b494aff8d1922e8e0b5777796d7450dmark </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>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <imageobject>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <imagedata fileref="images/QuickSetup-review.png" format="PNG" />
ec40cc0dc62425cea5d63fd9d984f8614479de25mark </imageobject>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <textobject>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <para>You can opt to start your server when setup completes.</para>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark </textobject>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark </mediaobject>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <imageobject>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <imagedata fileref="images/QuickSetup-finished.png" format="PNG" />
ec40cc0dc62425cea5d63fd9d984f8614479de25mark </imageobject>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <textobject>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark <para>Click the Launch Control Panel button to check your newly
ec40cc0dc62425cea5d63fd9d984f8614479de25mark installed server.</para>
ec40cc0dc62425cea5d63fd9d984f8614479de25mark </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>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <itemizedlist>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>To launch OpenDJ Control Panel again later, you can run one of the
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark following, depending on your host system.</para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>(Mac OS X) <command>/path/to/opendj/bin/ControlPanel.app</command></para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <para>(UNIX) <command>/path/to/opendj/bin/control-panel</command></para>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark </listitem>
51607ea01068c9047391e4c8b46bc9dbd0edb7fdmark <listitem>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark <para>(Windows) <command>C:\path\to\opendj\bat\control-panel.bat</command></para>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark </listitem>
08248b5c5b494aff8d1922e8e0b5777796d7450dmark </itemizedlist>