Author: mmcallis
Date: 2008-07-07 02:23:05 -0400 (Mon, 07 Jul 2008)
New Revision: 11309
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
Log:
making "Operating System Environment Settings" sections
consistent with 2.7 branch
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-07-06
20:55:31 UTC (rev 11308)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-07-07
06:23:05 UTC (rev 11309)
@@ -75,17 +75,67 @@
Files contained in this download are used in later sections. Download and
extract the JBoss Portal binary ZIP file before proceeding.
</para>
</sect3>
- <sect3>
- <title>JBoss EAP and JBoss AS Setup</title>
- <para>Before deploying JBoss Portal, make sure you have JBoss EAP or JBoss AS
installed. Customers who have access to the <ulink
url="https://support.redhat.com/portal/login.html">JBoss Customer Support
Portal (CSP)</ulink> are advised to download and install JBoss EAP 4.3. Customers
who do not have access to the JBoss CSP are advised to use <ulink
url="http://labs.jboss.com/jbossas/downloads/">JBoss AS</ulink>. For
JBoss AS installation instructions, please refer to the <ulink
url="http://labs.jboss.com/jbossas/docs/index.html">JBoss AS Installation
Guide</ulink>.
- </para>
- <warning>
- <title>Use the JBoss EAP and JBoss AS ZIP file</title>
- <para>
- Only use the JBoss EAP and JBoss AS ZIP file versions. <emphasis
role="bold">DO NOT ATTEMPT to deploy JBoss Portal on the installer version of
JBoss EAP or JBoss AS.</emphasis>
- </para>
- </warning>
+ <sect3>
+ <title>JBoss EAP and JBoss AS Setup</title>
+ <para>Before deploying JBoss Portal, make sure you have JBoss EAP or JBoss AS
installed. Customers who have access to the <ulink
url="https://support.redhat.com/portal/login.html">JBoss Customer Support
Portal (CSP)</ulink> are advised to download and install JBoss EAP 4.3. Customers
who do not have access to the JBoss CSP are advised to use <ulink
url="http://labs.jboss.com/jbossas/downloads/">JBoss AS</ulink>. For
JBoss AS installation instructions, please refer to the <ulink
url="http://labs.jboss.com/jbossas/docs/index.html">JBoss AS Installation
Guide</ulink>.
+ </para>
+ <warning>
+ <title>Use the JBoss EAP and JBoss AS ZIP file</title>
+ <para>
+ Only use the JBoss EAP and JBoss AS ZIP file versions. <emphasis
role="bold">DO NOT ATTEMPT to deploy JBoss Portal on the installer version of
JBoss EAP or JBoss AS.</emphasis>
+ </para>
+ </warning>
</sect3>
+ <sect3 id="install_source_env_0">
+ <title>Operating System Environment Settings</title>
+ <para>For JBoss EAP, JBoss AS, and build targets to work, you must configure a
<filename>JBOSS_HOME</filename> environment variable. This environment
variable must point to the root directory of the JBoss EAP or JBoss AS installation
directory, which is the directory where the JBoss EAP or JBoss AS files were extracted
to.
+ </para>
+ <para>On Windows, this is accomplished by going to
+ <emphasis>Start > Settings > Control Panel > System > Advanced >
Environment Variables</emphasis>. Under the
+ <emphasis>System Variables</emphasis>
+ section, click
+ <emphasis>New</emphasis>. Set the
<filename>JBOSS_HOME</filename>
+ environment variable to the location of your JBoss EAP or JBoss AS installation
directory:
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" valign="middle"
fileref="images/setup/win_envsetup.gif"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <para>
+ To configure the <filename>JBOSS_HOME</filename> environment variable on
Linux:
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Add the following line to the <filename>~/.bashrc</filename> file.
Note: this must be configured while logged in as the user who runs JBoss EAP or JBoss AS:
+ </para>
+ <para>
+<screen>
+export JBOSS_HOME=/path/to/jboss/installation/
+</screen>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Run the following command to enable the <filename>JBOSS_HOME</filename>
environment variable:
+ </para>
+ <para>
+<screen>
+source ~/.bashrc
+</screen>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <note>
+ <title>JBoss EAP <filename>JBOSS_HOME</filename> Environment
Variable</title>
+ <para>
+ If you are running JBoss EAP, configure the
<filename>JBOSS_HOME</filename> environment variable to point to the
<filename>/path/to/jboss-eap-<replaceable>version</replaceable>/jboss-as/</filename>
directory.
+ </para>
+ </note>
+ </sect3>
<sect3>
<title>Database Setup</title>
<para>
@@ -262,54 +312,54 @@
</warning>
</sect3>
<sect3 id="install_source_env">
- <title>Operating System Environment Settings</title>
- <para>For build targets to work, you must configure a
<filename>JBOSS_HOME</filename> environment variable. This environment
variable must point to the root directory of the JBoss EAP or JBoss AS installation
directory, which is the directory where the JBoss EAP or JBoss AS files were extracted
to.
- </para>
- <para>On Windows, this is accomplished by going to
- <emphasis>Start > Settings > Control Panel > System >
Advanced > Environment Variables</emphasis>. Under the
- <emphasis>System Variables</emphasis>
- section, click
- <emphasis>New</emphasis>. Set the
<filename>JBOSS_HOME</filename>
- environment variable to the location of your JBoss EAP or JBoss AS
installation directory:
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/win_envsetup.gif"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>
- To configure the <filename>JBOSS_HOME</filename> environment variable
on Linux:
- </para>
- <para>
- <orderedlist>
- <listitem>
- <para>
- Add the following line to the <filename>~/.bashrc</filename> file.
Note: this must be configured while logged in as the user who runs JBoss EAP or JBoss AS:
- </para>
- <para>
+ <title>Operating System Environment Settings</title>
+ <para>For JBoss EAP, JBoss AS, and build targets to work, you must configure a
<filename>JBOSS_HOME</filename> environment variable. This environment
variable must point to the root directory of the JBoss EAP or JBoss AS installation
directory, which is the directory where the JBoss EAP or JBoss AS files were extracted
to.
+ </para>
+ <para>On Windows, this is accomplished by going to
+ <emphasis>Start > Settings > Control Panel > System > Advanced >
Environment Variables</emphasis>. Under the
+ <emphasis>System Variables</emphasis>
+ section, click
+ <emphasis>New</emphasis>. Set the
<filename>JBOSS_HOME</filename>
+ environment variable to the location of your JBoss EAP or JBoss AS installation
directory:
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" valign="middle"
fileref="images/setup/win_envsetup.gif"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <para>
+ To configure the <filename>JBOSS_HOME</filename> environment variable on
Linux:
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Add the following line to the <filename>~/.bashrc</filename> file.
Note: this must be configured while logged in as the user who runs JBoss EAP or JBoss AS:
+ </para>
+ <para>
<screen>
export JBOSS_HOME=/path/to/jboss/installation/
</screen>
- </para>
- </listitem>
- <listitem>
- <para>
- Run the following command to enable the <filename>JBOSS_HOME</filename>
environment variable:
- </para>
- <para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Run the following command to enable the
<filename>JBOSS_HOME</filename> environment variable:
+ </para>
+ <para>
<screen>
source ~/.bashrc
</screen>
- </para>
- </listitem>
- </orderedlist>
- </para>
- <note>
- <title>JBoss EAP <filename>JBOSS_HOME</filename> Environment
Variable</title>
- <para>
- If you are running JBoss EAP, configure the
<filename>JBOSS_HOME</filename> environment variable to point to the
<filename>/path/to/jboss-eap-<replaceable>version</replaceable>/jboss-as/</filename>
directory.
- </para>
- </note>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <note>
+ <title>JBoss EAP <filename>JBOSS_HOME</filename> Environment
Variable</title>
+ <para>
+ If you are running JBoss EAP, configure the
<filename>JBOSS_HOME</filename> environment variable to point to the
<filename>/path/to/jboss-eap-<replaceable>version</replaceable>/jboss-as/</filename>
directory.
+ </para>
+ </note>
</sect3>
</sect2>
<sect2 id="building_deploying_from_source">