CR-7365 OPENDJ-2132 Mention OPENDJ_JAVA_HOME

Mark Craig

23.32.2015 d642a3083cac659cfa05f8854e4d5daa6656db1c

CR-7365 OPENDJ-2132 Mention OPENDJ_JAVA_HOME

This patch mentions the need to use OPENDJ_JAVA_HOME
(or OPENDJ_JAVA_BIN) to set the Java environment correctly
for GUI installation.

This also means that OpenDJ is dropping support for Java WebStart.

 opendj-sdk/opendj-server-legacy/src/main/docbkx/install-guide/chap-install-cli.xml

@@ -191,8 +191,7 @@
   
   <para>The <command>setup</command> command without the
   <literal>--cli</literal> option runs the Quick Start
   GUI installer with your local version of software, as does
   Java WebStart with a remote version of the software.</para>
   GUI installer with your local version of software.</para>

   <screen>
$ <userinput>/path/to/opendj/setup --cli</userinput>

 opendj-sdk/opendj-server-legacy/src/main/docbkx/install-guide/chap-install-gui.xml

@@ -42,49 +42,43 @@
 <section xml:id="install-gui-quick-setup">
  <title>Installing OpenDJ With the QuickSetup Wizard</title>

 <para>QuickSetup uses Java WebStart to let you perform an installation of
 OpenDJ directory server starting with a click in your web browser, which can
 be a great way to try OpenDJ directory server for the first time, or to do a
 quick test installation.</para>

 <note>
  <para>
   If your environment picks up an old installation of Java,
   installation can fail.
   You might see an application error due to an old Java version.
   The OpenDJ QuickSetup wizard provides a graphical user interface
   for installing OpenDJ directory server.
  </para>
 </note>

 <para>If the WebStart installation does not work in your browser, copy
 the WebStart URL, ending in <literal>QuickSetup.jnlp</literal>, from the
 OpenDJ download page. Next, pass the link as an argument to the
 <command>javaws</command> command in a terminal window to start the
 installer.</para>
  <para>
   To begin installation, download OpenDJ-${docTargetVersion}.zip,
   unzip the file,
   and then run the
   <link
    xlink:show="new"
    xlink:href="reference#setup-1"
    xlink:role="http://docbook.org/xlink/role/olink"
    ><command>setup</command></link> command,
   <command>opendj/setup</command> (UNIX),
   <command>opendj\setup.bat</command> (Windows),
   or <command>opendj/QuickSetup.app</command> (Mac OS X).
  </para>

 <screen>
$ <userinput>export PATH=/path/to/java/bin:$PATH</userinput>
$ <userinput>javaws <replaceable>URL-to-QuickSetup-Installer</replaceable></userinput>
 </screen>
  <note>
   <para>
    If your environment picks up an old installation of Java,
    installation can fail.
    You might see an application error due to an old Java version.
   </para>

 <para>
  The WebStart installer corresponds to what you start
  if you download OpenDJ-${docTargetVersion}.zip,
  unzip the file,
  and then run the
  <link
   xlink:show="new"
   xlink:href="reference#setup-1"
   xlink:role="http://docbook.org/xlink/role/olink"
  ><command>setup</command></link> command,
  <command>opendj/setup</command> (UNIX),
  <command>opendj\setup.bat</command> (Windows),
  or <command>opendj/QuickSetup.app</command> (Mac OS X).
 </para>

 <para>
  Java WebStart launches the the QuickSetup wizard,
  and soon the Welcome screen appears.
 </para>
   <para>
    If your default Java environment is not appropriate,
    set <literal>OPENDJ_JAVA_HOME</literal>
    to the path to the correct Java environment,
    or set <literal>OPENDJ_JAVA_BIN</literal>
    to the absolute path of the <command>java</command> command.
    The latter environment variable is useful for example
    if you have both 32-bit and 64-bit versions of the Java environment installed,
    and want to make sure you use the 64-bit version.
   </para>
  </note>

  <itemizedlist>
   <para>

 opendj-sdk/opendj-server-legacy/src/main/docbkx/install-guide/preface.xml

@@ -38,17 +38,20 @@

 <para>If you want only to try OpenDJ server software, and you
 do not plan to store any real or important data that you want to keep,
 then you need not read this entire guide. Instead, try <link
 xlink:href="install-guide#chap-install-gui"
 xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Installing OpenDJ
 With the QuickSetup Wizard</citetitle></link>.</para>
 then you need not read this entire guide. Instead try
  <link
   xlink:show="new"
   xlink:href="install-guide#chap-install-gui"
   xlink:role="http://docbook.org/xlink/role/olink"
  ><citetitle>Installing OpenDJ With a Graphical Installer</citetitle></link>.
 </para>

 <section>
  <title>Who Should Read this Guide</title>

  <para>This guide is written for anyone installing OpenDJ who plans to
  maintain directory services for client applications. Basic OpenDJ
  installation, especially using Java WebStart, can be simple and
  installation can be simple and
  straightforward, particularly if you are already acquainted with directory
  services. Upgrading a running directory service without a single point of
  failure that can cause downtime requires at least a little thought

 opendj-sdk/opendj-server-legacy/src/main/docbkx/shared/sec-cli-overview.xml

@@ -52,7 +52,7 @@
   <tbody>
    <row>
     <entry>Apple Mac OS X, Linux distributions, Oracle Solaris</entry>
     <entry>WebStart, .zip</entry>
     <entry>.zip</entry>
     <entry><filename>/path/to/opendj/bin</filename></entry>
    </row>
    <row>
@@ -62,7 +62,7 @@
    </row>
    <row>
     <entry>Microsoft Windows</entry>
     <entry>WebStart, .zip</entry>
     <entry>.zip</entry>
     <entry><filename>C:\path\to\opendj\bat</filename></entry>
    </row>
    <row>