Author: mmcallis
Date: 2008-02-04 02:32:17 -0500 (Mon, 04 Feb 2008)
New Revision: 9728
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
Log:
adding para on jboss_home, changing all
jboss_install_directories to $JBOSS_HOME
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-02-04
06:49:33 UTC (rev 9727)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-02-04
07:32:17 UTC (rev 9728)
@@ -2,8 +2,11 @@
<chapter id="installation">
<title>Installation</title>
<para>Depending on your needs, there are several different methods to install
JBoss Portal. Pre-configured clustered versions (<computeroutput>JBoss Portal Binary
(Clustered)</computeroutput>) are available from the
- <ulink
url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu...
Portal Downloads</ulink> page. Clustered versions of JBoss Portal must be deployed
in the <filename>JBOSS_INSTALLATION_DIRECTORY/server/all/deploy/</filename>
directory. All JBoss AS instances must reference the same datasource. See <xref
linkend="clustering"/> for details on how to configure JBoss Portal for
clustering.
+ <ulink
url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu...
Portal Downloads</ulink> page. Clustered versions of JBoss Portal must be deployed
in the <filename>JBOSS_INSTALLATION_DIRECTORY/server/all/deploy/</filename>
directory. All JBoss AS instances must reference the same datasource. See <xref
linkend="install_source_env"/> for details on how to configure JBoss Portal
for clustering.
</para>
+ <para>
+ An environment variable, <computeroutput>JBOSS_HOME</computeroutput>, is
configured in <xref linkend="install_source_env"/>. References to
<computeroutput>$JBOSS_HOME</computeroutput> assume this to be your
<replaceable>JBOSS_INSTALLATION_DIRECTORY</replaceable>.
+ </para>
<sect1 id="install_bundle">
<title>The JBoss Portal and JBoss AS Bundle</title>
<para>This is the easiest and fastest way to get JBoss Portal installed and
running. The JBoss Portal and JBoss AS bundle contains JBoss AS, JBoss Portal, and the
embedded Hypersonic SQL database. To install the JBoss Portal and JBoss AS bundle:
@@ -105,7 +108,7 @@
</listitem>
<listitem>
<para>
- <emphasis role="bold">Deploy a RDBMS JDBC
connector:</emphasis> a RDBMS JDBC connector is required for JBoss Portal to
communicate with a database. Copy the connector into the
<filename>JBOSS_INSTALL_DIRECTORY/server/default/lib/</filename> directory.
For example, a RDBMS JDBC connector for MySQL can be download from <ulink
url="http://www.mysql.com/products/connector/j/"></ulink>. For the
correct RDMBS JDBC connector, please refer to the database documentation.
+ <emphasis role="bold">Deploy a RDBMS JDBC
connector:</emphasis> a RDBMS JDBC connector is required for JBoss Portal to
communicate with a database. Copy the connector into the
<filename>$JBOSS_HOME/server/default/lib/</filename> directory. For example, a
RDBMS JDBC connector for MySQL can be download from <ulink
url="http://www.mysql.com/products/connector/j/"></ulink>. For the
correct RDMBS JDBC connector, please refer to the database documentation.
</para>
</listitem>
</orderedlist>
@@ -122,7 +125,7 @@
</imageobject>
</mediaobject>
<para>
- Copy the Datasource descriptor that matches your database into the
<filename>JBOSS_INSTALLATION_DIRECTORY/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory, where <replaceable>configuration</replaceable> is either all,
default, minimal, or production. For example, if you are using the production
configuration, copy the Datasource descriptor into the
<filename>JBOSS_INSTALLATION_DIRECTORY/server/production/deploy/</filename>
directory.
+ Copy the Datasource descriptor that matches your database into the
<filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory, where <replaceable>configuration</replaceable> is either all,
default, minimal, or production. For example, if you are using the production
configuration, copy the Datasource descriptor into the
<filename>$JBOSS_HOME/server/production/deploy/</filename> directory.
</para>
<para>
After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the username, password,
connection-url, and driver-class are correct for your chosen database. Datasource
descriptor files can be deployed to test before being used in production. The following is
an example Datasource descriptor for the PostgreSQL database:
@@ -153,12 +156,12 @@
<orderedlist>
<listitem>
<para>
- <emphasis role="bold">Datasource descriptor:</emphasis> if you
have not done so already, change into the <filename>setup</filename>
subdirectory where the JBoss Portal binary was extracted to. Copy the correct Datasource
descriptor file (<filename>*-ds.xml</filename>) you modified in the previous
steps into the
<filename>JBOSS_INSTALLATION_DIRECTORY/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory.
+ <emphasis role="bold">Datasource descriptor:</emphasis> if you
have not done so already, change into the <filename>setup</filename>
subdirectory where the JBoss Portal binary was extracted to. Copy the correct Datasource
descriptor file (<filename>*-ds.xml</filename>) you modified in the previous
steps into the
<filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory.
</para>
</listitem>
<listitem>
<para>
- <emphasis role="bold">Start the server:</emphasis> change into
the <filename>JBOSS_INSTALLATION_DIRECTORY/bin/</filename> directory. On
Microsoft Windows, execute <command>run.bat</command>. On Linux, run the
<command>./run.sh</command> command.
+ <emphasis role="bold">Start the server:</emphasis> change into
the <filename>$JBOSS_HOME/bin/</filename> directory. On Microsoft Windows,
execute <command>run.bat</command>. On Linux, run the
<command>./run.sh</command> command.
</para>
</listitem>
<listitem>
@@ -327,7 +330,7 @@
<title>Building and Deploying from the Sources</title>
<para>
During the first build, third-party libraries will be obtained from an online
- repository, so you must be connected to the Internet, and if you are behind a proxy
server, you need to define your proxy server address and proxy server port number. If you
are running Linux, add the following line to the
<filename>JBOSS_INSTALLATION_DIRECTORY/bin/run.sh</filename> file:
+ repository, so you must be connected to the Internet, and if you are behind a proxy
server, you need to define your proxy server address and proxy server port number. If you
are running Linux, add the following line to the
<filename>$JBOSS_HOME/bin/run.sh</filename> file:
</para>
<para>
<screen>
@@ -335,7 +338,7 @@
</screen>
</para>
<para>
- Replace <replaceable>proxy-hostname</replaceable> with the proxy
server's hostname, and <replaceable>proxy-port</replaceable> with the
correct proxy server port number. If you are running Microsoft Windows, add the following
line to the <filename>JBOSS_INSTALLATION_DIRECTORY/bin/run.bat</filename>
file:
+ Replace <replaceable>proxy-hostname</replaceable> with the proxy
server's hostname, and <replaceable>proxy-port</replaceable> with the
correct proxy server port number. If you are running Microsoft Windows, add the following
line to the <filename>$JBOSS_HOME/bin/run.bat</filename> file:
</para>
<para>
<screen>
@@ -348,7 +351,7 @@
<para>To build and deploy JBoss Portal from the sources, change into the
<filename>JBOSS_PORTAL_HOME_DIRECTORY/build/</filename> directory. Then,
Microsoft Windows users need to run the <command>build.bat deploy</command>
command, and Linux users need to run the <command>./build.sh deploy</command>
command.
</para>
<para>
- At the end of the build process, the <filename>jboss-portal.sar</filename>
file is copied into the <filename>JBOSS_HOME/server/default/deploy/</filename>
directory:
+ At the end of the build process, the <filename>jboss-portal.sar</filename>
file is copied into the
<filename>$JBOSS_HOME/server/default/deploy/</filename> directory:
</para>
<para>
<mediaobject>
@@ -390,7 +393,7 @@
</screen>
</para>
<para>
- After the <command>./build.sh deploy-ha</command> command completes, the
<filename>jboss-portal-ha.sar</filename> file is copied into the
<filename>JBOSS_HOME/server/all/deploy/</filename> directory.
+ After the <command>./build.sh deploy-ha</command> command completes, the
<filename>jboss-portal-ha.sar</filename> file is copied into the
<filename>$JBOSS_HOME/server/all/deploy/</filename> directory.
</para>
</listitem>
</orderedlist>
@@ -421,7 +424,7 @@
</listitem>
<listitem>
<para>
- <emphasis role="bold">Deploy a RDBMS JDBC
connector:</emphasis> a RDBMS JDBC connector is required for JBoss Portal to
communicate with a database. Copy the connector into the
<filename>JBOSS_INSTALL_DIRECTORY/server/default/lib/</filename> directory.
For example, a RDBMS JDBC connector for MySQL can be download from <ulink
url="http://www.mysql.com/products/connector/j/"></ulink>. For the
correct RDMBS JDBC connector, please refer to the database documentation.
+ <emphasis role="bold">Deploy a RDBMS JDBC
connector:</emphasis> a RDBMS JDBC connector is required for JBoss Portal to
communicate with a database. Copy the connector into the
<filename>$JBOSS_HOME/server/default/lib/</filename> directory. For example, a
RDBMS JDBC connector for MySQL can be download from <ulink
url="http://www.mysql.com/products/connector/j/"></ulink>. For the
correct RDMBS JDBC connector, please refer to the database documentation.
</para>
</listitem>
</orderedlist>
@@ -438,7 +441,7 @@
</imageobject>
</mediaobject>
<para>
- Copy the Datasource descriptor that matches your database into the
<filename>JBOSS_INSTALLATION_DIRECTORY/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory, where <replaceable>configuration</replaceable> is either all,
default, minimal, or production. For example, if you are using the production
configuration, copy the Datasource descriptor into the
<filename>JBOSS_INSTALLATION_DIRECTORY/server/production/deploy/</filename>
directory.
+ Copy the Datasource descriptor that matches your database into the
<filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory, where <replaceable>configuration</replaceable> is either all,
default, minimal, or production. For example, if you are using the production
configuration, copy the Datasource descriptor into the
<filename>$JBOSS_HOME/server/production/deploy/</filename> directory.
</para>
<para>
After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the username, password,
connection-url, and driver-class are correct for your chosen database. Datasource
descriptor files can be deployed to test before being used in production. The following is
an example Datasource descriptor for the PostgreSQL database:
@@ -469,12 +472,12 @@
<orderedlist>
<listitem>
<para>
- <emphasis role="bold">Datasource descriptor:</emphasis>
if you have not done so already, change into the <filename>setup</filename>
subdirectory where the JBoss Portal binary was extracted to. Copy the correct Datasource
descriptor file (<filename>*-ds.xml</filename>) you modified in the previous
steps into the
<filename>JBOSS_INSTALLATION_DIRECTORY/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory.
+ <emphasis role="bold">Datasource descriptor:</emphasis>
if you have not done so already, change into the <filename>setup</filename>
subdirectory where the JBoss Portal binary was extracted to. Copy the correct Datasource
descriptor file (<filename>*-ds.xml</filename>) you modified in the previous
steps into the
<filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory.
</para>
</listitem>
<listitem>
<para>
- <emphasis role="bold">Start the server:</emphasis>
change into the <filename>JBOSS_INSTALLATION_DIRECTORY/bin/</filename>
directory. On Microsoft Windows, execute <command>run.bat</command>. On Linux,
run the <command>./run.sh</command> command.
+ <emphasis role="bold">Start the server:</emphasis>
change into the <filename>$JBOSS_HOME/bin/</filename> directory. On Microsoft
Windows, execute <command>run.bat</command>. On Linux, run the
<command>./run.sh</command> command.
</para>
</listitem>
<listitem>