Author: thomas.heute(a)jboss.com
Date: 2008-07-15 11:49:02 -0400 (Tue, 15 Jul 2008)
New Revision: 11452
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supported.xml
Log:
Changed supported versions
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml 2008-07-15
14:12:50 UTC (rev 11451)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml 2008-07-15
15:49:02 UTC (rev 11452)
@@ -1,193 +1,391 @@
<?xml version="1.0" encoding="UTF-8"?>
<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. Refer to <xref
linkend="install_source_env"/> for details on how to configure JBoss Portal
for clustering.
+ <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...
+ JBoss 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. Refer to
+ <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>
+ 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:
+ <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:
</para>
<para>
- <orderedlist>
- <listitem>
- <para>
- <emphasis role="bold">Get the bundle:</emphasis> the
bundle is available from the <ulink
url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu...
Portal Downloads</ulink> page. Bundles use the <computeroutput>JBoss Portal +
JBoss AS</computeroutput> naming convention.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Extract the bundle:</emphasis>
extract the ZIP archive. It does not matter which directory is used. On Windows, the
recommended directory is
<filename>C:\jboss-<replaceable>version-number</replaceable></filename>.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Start the server:</emphasis> change
into the <filename>JBOSS_PORTAL_INSTALLATION_DIRECTORY/bin/</filename>
directory. On Windows, execute <command>run.bat</command>. On Linux, run the
<command>sh run.sh</command> command. To specify a configuration to use, for
example, the default configuration, append the <command> -c default</command>
option to the <command>run.bat</command> or <command>sh
run.sh</command> commands.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Log in to JBoss Portal:</emphasis>
using a Web browser, navigate to <ulink
url="http://localhost:8080/portal"></ulink> to open the JBoss Portal
homepage. Log in using one of the two default accounts: username
<emphasis>user</emphasis>, password <emphasis>user</emphasis>, or
username <emphasis>admin</emphasis>, password
<emphasis>admin</emphasis>:
- </para>
- </listitem>
- </orderedlist>
- </para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/common/frontpage.png" scalefit="1"/>
- </imageobject>
- </mediaobject>
- </para>
- <formalpara>
- <title>SQL Errors</title>
- <para>
- Tables are automatically created the first time JBoss Portal starts. When deployed
for the first time, JBoss Portal checks for the existence of the initial tables, which
have not been created yet. This causes errors such as the following, which can safely be
ignored:
- </para>
- </formalpara>
- <para>
- <programlisting><![CDATA[
+ <orderedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">Get the bundle:</emphasis>
+ the bundle is available from the
+ <ulink
+
url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu...
+ JBoss Portal Downloads
+ </ulink>
+ page. Bundles use the
+ <computeroutput>JBoss Portal + JBoss AS</computeroutput>
+ naming convention.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Extract the
bundle:</emphasis>
+ extract the ZIP archive. It does not matter which directory is used.
On
+ Windows, the recommended directory is
+ <filename>
+ C:\jboss-
+ <replaceable>version-number</replaceable>
+ </filename>
+ .
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Start the
server:</emphasis>
+ change into the
+
<filename>JBOSS_PORTAL_INSTALLATION_DIRECTORY/bin/</filename>
+ directory. On Windows, execute
+ <command>run.bat</command>
+ . On Linux, run the
+ <command>sh run.sh</command>
+ command. To specify a configuration to use, for example, the default
+ configuration, append the
+ <command>-c default</command>
+ option to the
+ <command>run.bat</command>
+ or
+ <command>sh run.sh</command>
+ commands.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Log in to JBoss
Portal:</emphasis>
+ using a Web browser, navigate to
+ <ulink
url="http://localhost:8080/portal"></ulink>
+ to open the JBoss Portal homepage. Log in using one of the two default
+ accounts: username
+ <emphasis>user</emphasis>
+ , password
+ <emphasis>user</emphasis>
+ , or username
+ <emphasis>admin</emphasis>
+ , password
+ <emphasis>admin</emphasis>
+ :
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" valign="middle"
+ fileref="images/common/frontpage.png" scalefit="1"
/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ <formalpara>
+ <title>SQL Errors</title>
+ <para>
+ Tables are automatically created the first time JBoss Portal starts. When
+ deployed for the first time, JBoss Portal checks for the existence of the
+ initial tables, which have not been created yet. This causes errors such as
+ the following, which can safely be ignored:
+ </para>
+ </formalpara>
+ <para>
+ <programlisting><![CDATA[
WARN [JDBCExceptionReporter] SQL Error: -22, SQLState: S0002
ERROR [JDBCExceptionReporter] Table not found in statement ...
WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_repositoryentry'
doesn't exist
WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_version_refs'
doesn't exist]]></programlisting>
- </para>
- </sect1>
+ </para>
+ </sect1>
<sect1 id="install_binary">
<title>Installing the Binary Download</title>
- <para>The binary package typically consists of the
- <filename>jboss-portal.sar/</filename> directory, documentation such
as the JBoss Portal User Guide and the JBoss Portal Reference Guide, and a set of
pre-configured Datasource descriptors that allow
- JBoss Portal to communicate with an external database. This installation method
is recommended for users who already have JBoss EAP or JBoss AS installed, or those who
need to install JBoss Portal in a clustered environment.</para>
+ <para>
+ The binary package typically consists of the
+ <filename>jboss-portal.sar/</filename>
+ directory, documentation such as the JBoss Portal User Guide and the JBoss
Portal
+ Reference Guide, and a set of pre-configured Datasource descriptors that allow
+ JBoss Portal to communicate with an external database. This installation method
+ is recommended for users who already have JBoss EAP or JBoss AS installed, or
+ those who need to install JBoss Portal in a clustered environment.
+ </para>
<sect2>
<title>Setting up your Environment</title>
<sect3 id="install_binarydownload">
<title>Getting the Binary</title>
<para>
- The binary download is available from the <ulink
url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu...
Portal Downloads</ulink> page. Look for the <computeroutput>JBoss Portal
Binary</computeroutput> package. Once the binary ZIP file has been downloaded and
extracted, the folder hierarchy will look similar to the following:
- </para>
- <para>
+ The binary download is available from the
+ <ulink
+
url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu...
+ JBoss Portal Downloads
+ </ulink>
+ page. Look for the
+ <computeroutput>JBoss Portal Binary</computeroutput>
+ package. Once the binary ZIP file has been downloaded and extracted, the
+ folder hierarchy will look similar to the following:
+ </para>
+ <para>
<mediaobject>
<imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/package.png"/>
+ <imagedata align="center" valign="middle"
+ fileref="images/setup/package.png" />
</imageobject>
</mediaobject>
- </para>
- <para>
- Files contained in this download are used in later sections. Download and
extract the JBoss Portal binary ZIP file before proceeding.
</para>
+ <para>
+ 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>
- <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>
-<programlisting>
-export JBOSS_HOME=/path/to/jboss/installation/
-</programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Run the following command to enable the <filename>JBOSS_HOME</filename>
environment variable:
- </para>
- <para>
-<programlisting>
-source ~/.bashrc
-</programlisting>
- </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>
+ <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>
+ <programlisting>
+ export JBOSS_HOME=/path/to/jboss/installation/
+ </programlisting>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Run the following command to enable the
+ <filename>JBOSS_HOME</filename>
+ environment variable:
+ </para>
+ <para>
+ <programlisting>source ~/.bashrc</programlisting>
+ </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>
- A database is required for JBoss Portal to run. JBoss EAP and JBoss AS include an
embedded Hypersonic SQL database that JBoss Portal can use; however, this is only
recommended for developer use. The following databases are recommended for production use,
and have had test suites run against them: <trademark
class="registered">MySQL</trademark> 4 and 5, <trademark
class="registered">Microsoft</trademark> <trademark
class="registered">SQL Server</trademark>, PostgreSQL 8, and
<trademark class="registered">Oracle</trademark> Database 9 and 10.
JBoss Portal can use any database that is supported by Hibernate.
- </para>
- <para>
- To configure a database to use with JBoss Portal:
- </para>
- <para>
+ <para>
+ A database is required for JBoss Portal to run. JBoss EAP and JBoss AS
+ include an embedded Hypersonic SQL database that JBoss Portal can use;
+ however, this is only recommended for developer use. The following
+ databases are recommended for production use, and have had test suites
run
+ against them:
+ <trademark class="registered">MySQL</trademark>
+ 4 and 5,
+ <trademark class="registered">Microsoft</trademark>
+ <trademark class="registered">SQL
Server</trademark>
+ , PostgreSQL 8, and
+ <trademark class="registered">Oracle</trademark>
+ Database 9 and 10. JBoss Portal can use any database that is supported by
+ Hibernate.
+ </para>
+ <para>To configure a database to use with JBoss Portal:</para>
+ <para>
<orderedlist>
<listitem>
<para>
- <emphasis role="bold">Create a new database:</emphasis>
this guide assumes that the new database is called
<emphasis>jbossportal</emphasis>.
+ <emphasis role="bold">Create a new
database:</emphasis>
+ this guide assumes that the new database is called
+ <emphasis>jbossportal</emphasis>
+ .
</para>
</listitem>
<listitem>
<para>
- <emphasis role="bold">Grant access rights for a user to the
<emphasis>jbossportal</emphasis> database:</emphasis> JBoss Portal needs
to create tables and modify table data. Grant access rights to a desired user to the
<emphasis>jbossportal</emphasis> database. Configure the same username and
password in the Datasource descriptor.
+ <emphasis role="bold">
+ Grant access rights for a user to the
+ <emphasis>jbossportal</emphasis>
+ database:
+ </emphasis>
+ JBoss Portal needs to create tables and modify table data. Grant
+ access rights to a desired user to the
+ <emphasis>jbossportal</emphasis>
+ database. Configure the same username and password in the
+ Datasource descriptor.
</para>
</listitem>
<listitem>
- <para>
- <emphasis role="bold">Deploy an RDBMS <trademark
class="trade">JDBC</trademark> connector:</emphasis> an 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, an 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>
+ <emphasis role="bold">
+ Deploy an RDBMS
+ <trademark
class="trade">JDBC</trademark>
+ connector:
+ </emphasis>
+ an 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, an 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>
- </para>
+ </para>
</sect3>
<sect3>
<title>Datasource Descriptors</title>
- <para>
- The JBoss Portal binary download that was extracted in <xref
linkend="install_binarydownload"/>, contains pre-configured Datasource
descriptors for the more popular databases. Datasource descriptors are provided for the
MySQL 4 and 5, PostgreSQL, Microsoft SQL Server, and Oracle databases, and can be found in
the <filename>setup</filename> subdirectory where the JBoss Portal binary was
extracted to:
- </para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/dsfiles.png"/>
- </imageobject>
- </mediaobject>
- <para>
- 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. The production configuration only exists on JBoss EAP, and
not JBoss AS. For example, if you are using the all configuration, copy the Datasource
descriptor into the <filename>$JBOSS_HOME/server/all/deploy/</filename>
directory.
- </para>
- <para>
- After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the
<computeroutput>user-name</computeroutput>,
<computeroutput>password</computeroutput>,
<computeroutput>connection-url</computeroutput>, and
<computeroutput>driver-class</computeroutput>, 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 a PostgreSQL database:
- </para>
-<programlisting role="XML">
-<![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+ <para>
+ The JBoss Portal binary download that was extracted in
+ <xref linkend="install_binarydownload" />
+ , contains pre-configured Datasource descriptors for the more popular
+ databases. Datasource descriptors are provided for the MySQL 4 and 5,
+ PostgreSQL, Microsoft SQL Server, and Oracle databases, and can be found
in
+ the
+ <filename>setup</filename>
+ subdirectory where the JBoss Portal binary was extracted to:
+ </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" valign="middle"
+ fileref="images/setup/dsfiles.png" />
+ </imageobject>
+ </mediaobject>
+ <para>
+ 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. The production
configuration
+ only exists on JBoss EAP, and not JBoss AS. For example, if you are using
+ the all configuration, copy the Datasource descriptor into the
+ <filename>$JBOSS_HOME/server/all/deploy/</filename>
+ directory.
+ </para>
+ <para>
+ After the Datasource descriptor has been copied into the
+ <filename>deploy</filename>
+ directory, make sure the
+ <computeroutput>user-name</computeroutput>
+ ,
+ <computeroutput>password</computeroutput>
+ ,
+ <computeroutput>connection-url</computeroutput>
+ , and
+ <computeroutput>driver-class</computeroutput>
+ , 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 a PostgreSQL database:
+ </para>
+ <programlisting role="XML">
+ <![CDATA[<?xml version="1.0"
encoding="UTF-8"?>
<datasources>
<local-tx-datasource>
<jndi-name>PortalDS</jndi-name>
@@ -197,43 +395,87 @@
<password>portalpassword</password>
</local-tx-datasource>
</datasources>]]></programlisting>
- <para>
- For further details about Datasource descriptors, please refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
JDBC Datasource Wiki page</ulink>.
- </para>
+ <para>
+ For further details about Datasource descriptors, please refer to the
+ <ulink
+
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
+ JBoss JDBC Datasource Wiki page
+ </ulink>
+ .
+ </para>
</sect3>
</sect2>
<sect2>
<title>Deploying JBoss Portal</title>
- <para>
- To start JBoss EAP or JBoss AS and deploy JBoss Portal:
- </para>
+ <para>To start JBoss EAP or JBoss AS and deploy JBoss
Portal:</para>
<para>
<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_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Start the server:</emphasis> change into
the <filename>$JBOSS_HOME/bin/</filename> directory. On Windows, execute
<command>run.bat</command>. On Linux, run the <command>sh
run.sh</command> command. To specify a configuration to use, for example, the
default configuration, append the <command> -c default</command> option to the
<command>run.bat</command> or <command>sh run.sh</command>
commands.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Log in to JBoss Portal:</emphasis> using
a Web browser, navigate to <ulink
url="http://localhost:8080/portal"></ulink> to open the JBoss Portal
homepage. Log in using one of the two default accounts: username
<emphasis>user</emphasis>, password <emphasis>user</emphasis>, or
username <emphasis>admin</emphasis>, password
<emphasis>admin</emphasis>.
- </para>
- </listitem>
- </orderedlist>
- </para>
- <formalpara>
- <title>SQL Errors</title>
- <para>
- Tables are automatically created the first time JBoss Portal starts. When deployed for
the first time, JBoss Portal checks for the existence of the initial tables, which have
not been created yet. This causes errors such as the following, which can safely be
ignored:
- </para>
- </formalpara>
- <para>
-<programlisting><![CDATA[
+ <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_HOME/bin/</filename>
+ directory. On Windows, execute
+ <command>run.bat</command>
+ . On Linux, run the
+ <command>sh run.sh</command>
+ command. To specify a configuration to use, for example, the
default
+ configuration, append the
+ <command>-c default</command>
+ option to the
+ <command>run.bat</command>
+ or
+ <command>sh run.sh</command>
+ commands.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Log in to JBoss
Portal:</emphasis>
+ using a Web browser, navigate to
+ <ulink
url="http://localhost:8080/portal"></ulink>
+ to open the JBoss Portal homepage. Log in using one of the two
+ default accounts: username
+ <emphasis>user</emphasis>
+ , password
+ <emphasis>user</emphasis>
+ , or username
+ <emphasis>admin</emphasis>
+ , password
+ <emphasis>admin</emphasis>
+ .
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <formalpara>
+ <title>SQL Errors</title>
+ <para>
+ Tables are automatically created the first time JBoss Portal starts. When
+ deployed for the first time, JBoss Portal checks for the existence of the
+ initial tables, which have not been created yet. This causes errors such
as
+ the following, which can safely be ignored:
+ </para>
+ </formalpara>
+ <para>
+ <programlisting><![CDATA[
WARN [JDBCExceptionReporter] SQL Error: -22, SQLState: S0002
ERROR [JDBCExceptionReporter] Table not found in statement ...
WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
@@ -241,400 +483,535 @@
WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_version_refs'
doesn't exist
]]></programlisting>
- </para>
+ </para>
</sect2>
</sect1>
<sect1 id="install_source">
<title>Installing from the Sources</title>
<sect2>
<title>Getting the Sources</title>
- <para>
- The JBoss Portal source files can be obtained from the
- <ulink
url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu...
Portal Downloads</ulink> page. The source files download uses a
<filename>JBoss Portal Source Code</filename> naming convention. As well, the
sources can be obtained from SVN. The latest sources for the
2.6.<replaceable>x</replaceable> versions are located at <ulink
url="http://anonsvn.jboss.org/repos/portal/branches/JBoss_Portal_Bra...
/>.
- </para>
- <para>
- Several modules have been extracted from the JBoss Portal SVN repository. These
modules have a different lifecycle and a different version scheme. The following is a list
of modules used in JBoss Portal 2.6.5, and the locations of their source code:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- JBoss Portal Common 1.1.1:
<
emphasis>http://anonsvn.jboss.org/repos/portal/modules/common/tags/JBP...
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss Portal Web 1.1.0:
<
emphasis>http://anonsvn.jboss.org/repos/portal/modules/web/tags/JBP_WE...
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss Portal Test 1.0.1:
<
emphasis>http://anonsvn.jboss.org/repos/portal/modules/test/tags/JBP_T...
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss Portal Portlet 1.0.3:
<
emphasis>http://anonsvn.jboss.org/repos/portal/modules/portlet/tags/JB...
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss Portal Identity 1.0.3:
<
emphasis>http://anonsvn.jboss.org/repos/portal/modules/identity/tags/J...
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- After checking out the source from SVN, or after extracting the <filename>JBoss
Portal Source Code</filename> ZIP file, a directory structure similar to the
following will be created:
- </para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/svncodir.png"/>
- </imageobject>
- </mediaobject>
- <para>
- If the source files were obtained from SVN, change into the
<filename>trunk/src/</filename> directory to see the directories from the
above image. As well, there is an empty <filename>thirdparty</filename>
directory. This directory contains files after building the JBoss Portal source code
(refer to <xref linkend="building_deploying_from_source" />). For more
information about the JBoss Portal SVN repository, and accessing different versions of the
JBoss Portal codebase, refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalSVNRepo">... Portal SVN
Repo</ulink> page on the JBoss Wiki.
- </para>
- </sect2>
+ <para>
+ The JBoss Portal source files can be obtained from the
+ <ulink
url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu...
+ JBoss Portal Downloads
+ </ulink>
+ page. The source files download uses a
+ <filename>JBoss Portal Source Code</filename>
+ naming convention. As well, the sources can be obtained from SVN. The latest
+ sources for the 2.7.
+ <replaceable>x</replaceable>
+ versions are located at
+ <ulink
+
url="http://anonsvn.jboss.org/repos/portal/branches/JBoss_Portal_Bra...
/>
+ .
+ </para>
+ <para>
+ Several modules have been extracted from the JBoss Portal SVN repository.
+ These modules have a different lifecycle and a different version scheme. The
+ following is a list of modules used in JBoss Portal 2.7.0, and the locations
+ of their source code:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ JBoss Portal Common 1.2.0:
+ <emphasis>
+
http://anonsvn.jboss.org/repos/portal/modules/common/tags/JBP_COMMON_1_2_0
+ </emphasis>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ JBoss Portal Web 1.2.0:
+ <emphasis>
+
http://anonsvn.jboss.org/repos/portal/modules/web/tags/JBP_WEB_1_2_0
+ </emphasis>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ JBoss Portal Test 1.0.2:
+ <emphasis>
+
http://anonsvn.jboss.org/repos/portal/modules/test/tags/JBP_TEST_1_0_2
+ </emphasis>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ JBoss Portal Portlet 2.0.1:
+ <emphasis>
+
http://anonsvn.jboss.org/repos/portal/modules/portlet/tags/JBP_PORTLET_2_0_1
+ </emphasis>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ JBoss Portal Identity 1.0.4:
+ <emphasis>
+
http://anonsvn.jboss.org/repos/portal/modules/identity/tags/JBP_IDENTITY_...
+ </emphasis>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ After checking out the source from SVN, or after extracting the
+ <filename>JBoss Portal Source Code</filename>
+ ZIP file, a directory structure similar to the following will be created:
+ </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" valign="middle"
+ fileref="images/setup/svncodir.png" />
+ </imageobject>
+ </mediaobject>
+ <para>
+ If the source files were obtained from SVN, change into the
+ <filename>trunk/src/</filename>
+ directory to see the directories from the above image. As well, there is an
+ empty
+ <filename>thirdparty</filename>
+ directory. This directory contains files after building the JBoss Portal
+ source code (refer to
+ <xref linkend="building_deploying_from_source" />
+ ). For more information about the JBoss Portal SVN repository, and accessing
+ different versions of the JBoss Portal codebase, refer to the
+ <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalSVNRepo">
+ JBoss Portal SVN Repo
+ </ulink>
+ page on the JBoss Wiki.
+ </para>
+ </sect2>
<sect2>
- <title>JBoss EAP and JBoss AS Setup</title>
+ <title>JBoss EAP and JBoss AS Setup</title>
<sect3>
<title>JBoss Application Server 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> We are currently working on aligning the
Application installer with JBoss Portal.
- </para>
- </warning>
+ <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>
+ We are currently working on aligning the Application installer with
+ JBoss Portal.
+ </para>
+ </warning>
</sect3>
<sect3 id="install_source_env">
<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
+ <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:
+ <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"/>
+ <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>
-<programlisting>
-export JBOSS_HOME=/path/to/jboss/installation/
-</programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Run the following command to enable the <filename>JBOSS_HOME</filename>
environment variable:
- </para>
- <para>
-<programlisting>
-source ~/.bashrc
-</programlisting>
- </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>
+ 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>
+ <programlisting>
+ export JBOSS_HOME=/path/to/jboss/installation/
+ </programlisting>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Run the following command to enable the
+ <filename>JBOSS_HOME</filename>
+ environment variable:
+ </para>
+ <para>
+ <programlisting>source ~/.bashrc</programlisting>
+ </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">
+ <sect2 id="building_deploying_from_source">
<title>Building and Deploying from the Sources</title>
- <para>
- During the first build, third-party libraries are 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. To
define a proxy server, add the following line to the
<filename>$JBOSS_HOME/bin/run.conf</filename> file:
- </para>
- <para>
-<programlisting><xi:include href="extras/runconf_javaops.xmlt"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g...
-<!--JAVA_OPTS=-Dhttp.proxyHost=<<replaceable>proxy-hostname
</replaceable>>-Dhttp.proxyPort=<<replaceable>proxy-port</replaceable>>
-->
- </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.
- </para>
- <para>To build and deploy JBoss Portal from the sources, change into the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename> directory, where
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY</filename> is the directory where the
JBoss Portal source code was downloaded to. Then, Windows users need to run the
<command>build.bat deploy</command> command, and Linux users need to run the
<command>sh 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:
- </para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/build_deploy.png" scalefit="1"/>
- </imageobject>
+ <para>
+ During the first build, third-party libraries are 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. To define a proxy server, add the following line to the
+ <filename>$JBOSS_HOME/bin/run.conf</filename>
+ file:
+ </para>
+ <para>
+ <programlisting>
+ <xi:include href="extras/runconf_javaops.xmlt"
parse="text"
+
xmlns:xi="http://www.w3.org/2001/XInclude">
+ </xi:include>
+ </programlisting>
+ <!--JAVA_OPTS=-Dhttp.proxyHost=<<replaceable>proxy-hostname
</replaceable>>-Dhttp.proxyPort=<<replaceable>proxy-port</replaceable>>
-->
+ </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.
+ </para>
+ <para>
+ To build and deploy JBoss Portal from the sources, change into the
+ <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename>
+ directory, where
+ <filename>JBOSS_PORTAL_SOURCE_DIRECTORY</filename>
+ is the directory where the JBoss Portal source code was downloaded to. Then,
+ Windows users need to run the
+ <command>build.bat deploy</command>
+ command, and Linux users need to run the
+ <command>sh 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:
+ </para>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" valign="middle"
+ fileref="images/setup/build_deploy.png"
scalefit="1" />
+ </imageobject>
</mediaobject>
- </para>
- <para>
- <note>
- <title>Portal Modules</title>
- <para>
- The previous steps install a bare version of JBoss Portal. In previous versions,
several additional modules were deployed as well, but this has since been modularized to
provide greater flexibility. To deploy additional modules, refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalModules">...
module list</ulink> for more information. To deploy all modules at once, change into
the <filename>build</filename> directory. If you are running Linux, run the
<command>sh build.sh deploy-all</command> command. On Windows, run the
<command>build.bat deploy-all</command> command.
- </para>
- </note>
- </para>
- <para>
- To build the clustered version on Linux operating systems:
- </para>
- <para>
- <orderedlist>
- <listitem>
- <para>
- Change into the
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename> directory, and run
the following command:
- </para>
- <para>
-<programlisting>
-sh build.sh main
-</programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Change into the <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/core/</filename>
directory, and run the following command:
- </para>
- <para>
-<programlisting>
-sh build.sh deploy-ha
-</programlisting>
- </para>
- <para>
- After the <command>sh 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>
- </para>
- <para>
- To build the clustered version on Windows, repeat the previous steps, replacing
<command>sh build.sh</command> with <command>build.bat</command>.
- </para>
- </sect2>
- <sect2>
- <title>Database Setup</title>
- <para>
- A database is required for JBoss Portal to run. JBoss EAP and JBoss AS include an
embedded Hypersonic SQL database that JBoss Portal can use; however, this is only
recommended for developer use. The following databases are recommended for production use,
and have had test suites run against them: MySQL 4 and 5, Microsoft SQL Server, PostgreSQL
8, and Oracle Database 9 and 10. JBoss Portal can use any database that is supported by
Hibernate.
- </para>
- <para>
- To configure a database to use with JBoss Portal:
- </para>
- <para>
- <orderedlist>
- <listitem>
- <para>
- <emphasis role="bold">Create a new database:</emphasis>
this guide assumes that the new database is called
<emphasis>jbossportal</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Grant access rights for a user to the
<emphasis>jbossportal</emphasis> database:</emphasis> JBoss Portal needs
to create tables and modify table data. Grant access rights to a desired user to the
<emphasis>jbossportal</emphasis> database. Configure the same username and
password in the Datasource descriptor.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Deploy an RDBMS JDBC
connector:</emphasis> an 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,
an 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>
- </para>
- </sect2>
- <sect2>
- <title>Datasource Configuration</title>
- <para>
- The JBoss Portal binary download that was extracted in <xref
linkend="install_binarydownload"/>, contains pre-configured Datasource
descriptors for the more popular databases. Datasource descriptors are provided for the
MySQL 4 and 5, PostgreSQL, Microsoft SQL Server, and Oracle databases, and can be found in
the <filename>setup</filename> subdirectory where the JBoss Portal binary was
extracted to:
- </para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/dsfiles.png"/>
- </imageobject>
- </mediaobject>
- <para>
- 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. The
production configuration only exists on JBoss EAP installations, and not JBoss AS.
- </para>
- <para>
- After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the
<computeroutput>user-name</computeroutput>,
<computeroutput>password</computeroutput>,
<computeroutput>connection-url</computeroutput>, and
<computeroutput>driver-class</computeroutput>, 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 a PostgreSQL database:
- </para>
- <programlisting role="XML"><![CDATA[
-<?xml version="1.0" encoding="UTF-8"?>
-<datasources>
- <local-tx-datasource>
- <jndi-name>PortalDS</jndi-name>
- <connection-url>jdbc:postgresql:jbossportal</connection-url>
- <driver-class>org.postgresql.Driver</driver-class>
- <user-name>portal</user-name>
- <password>portalpassword</password>
- </local-tx-datasource>
-</datasources>
- ]]></programlisting>
- <para>
- For further details about Datasource descriptors, please refer to the <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
JDBC Datasource Wiki page</ulink>.
- </para>
- </sect2>
-</sect1>
- <sect1>
- <title>Deploying JBoss Portal</title>
- <para>
- To start JBoss EAP or JBoss AS and deploy JBoss Portal:
- </para>
- <para>
- <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_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Start the server:</emphasis>
change into the <filename>$JBOSS_HOME/bin/</filename> directory. On Windows,
execute <command>run.bat</command>. On Linux, run the <command>sh
run.sh</command> command. To specify a configuration to use, for example, the
default configuration, append the <command> -c default</command> option to the
<command>run.bat</command> or <command>sh run.sh</command>
commands.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Log in to JBoss Portal:</emphasis>
using a Web browser, navigate to <ulink
url="http://localhost:8080/portal"></ulink> to open the JBoss Portal
homepage. Log in using one of the two default accounts: username
<emphasis>user</emphasis>, password <emphasis>user</emphasis>, or
username <emphasis>admin</emphasis>, password
<emphasis>admin</emphasis>.
- </para>
- </listitem>
- </orderedlist>
- </para>
- <formalpara>
- <title>SQL Errors</title>
- <para>
- Tables are automatically created the first time JBoss Portal starts. When
deployed for the first time, JBoss Portal checks for the existence of the initial tables,
which have not been created yet. This causes errors such as the following, which can
safely be ignored:
- </para>
- </formalpara>
- <para>
-<programlisting><![CDATA[
-WARN [JDBCExceptionReporter] SQL Error: -22, SQLState: S0002
-ERROR [JDBCExceptionReporter] Table not found in statement ...
-WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
-ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_repositoryentry'
doesn't exist
-WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
-ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_version_refs'
doesn't exist
-]]></programlisting>
- </para>
-</sect1>
-
- <!--<sect1 id="install_installer">
- <title>Installing using the JEMS Installer</title>
- <para>As of JBoss 4.0.4GA, users are able to install JBoss Portal using the
- <emphasis>portal</emphasis>
- configuration in the installer process. This method often makes it easier to
install AS + Portal, and allows
- for running JBoss Seam portlets by incorporating required libraries.
- <warning>This method will normally not supply you with the latest version
of JBoss Portal. An alternative, is
- to run through the entire install process, and then replace the portal binary
with the latest from the JBoss
- Portal download site.
- </warning>
- </para>
- <sect2>
- <title>Running the Installer</title>
+ </para>
<para>
+ <note>
+ <title>Portal Modules</title>
+ <para>
+ The previous steps install a bare version of JBoss Portal. In previous
+ versions, several additional modules were deployed as well, but this
has
+ since been modularized to provide greater flexibility. To deploy
+ additional modules, refer to the
+ <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalModules">
+ Portal's module list
+ </ulink>
+ for more information. To deploy all modules at once, change into the
+ <filename>build</filename>
+ directory. If you are running Linux, run the
+ <command>sh build.sh deploy-all</command>
+ command. On Windows, run the
+ <command>build.bat deploy-all</command>
+ command.
+ </para>
+ </note>
+ </para>
+ <para>To build the clustered version on Linux operating
systems:</para>
+ <para>
<orderedlist>
<listitem>
- <para>Download the installer package from the JEMS installer
page,
- <ulink
-
url="http://labs.jboss.com/portal/jemsinstaller/downloads">
- here
- </ulink>
- .
- <warning>DO NOT use the JBoss Application Server Installer, as
it will not contain the
- portal configuration! You must use this JEMS installer!
- </warning>
+ <para>
+ Change into the
+
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename>
+ directory, and run the following command:
</para>
- </listitem>
- <listitem>
- <para>After you have downloaded the installer jar, you can
execute it with
- <command>java -jar xxxx-installer.jar</command>
+ <para>
+ <programlisting>sh build.sh main</programlisting>
</para>
</listitem>
<listitem>
- <para>Select your language.
- <mediaobject>
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/setup/inst_lang.gif"/>
- </imageobject>
- </mediaobject>
+ <para>
+ Change into the
+
<filename>JBOSS_PORTAL_SOURCE_DIRECTORY/core/</filename>
+ directory, and run the following command:
</para>
- </listitem>
- <listitem>
- <para>Select an install path.
- <mediaobject>
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/setup/inst_path.gif"/>
- </imageobject>
- </mediaobject>
+ <para>
+ <programlisting>sh build.sh deploy-ha</programlisting>
</para>
- </listitem>
- <listitem>
- <para>Select the portal configuration.
- <mediaobject>
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/setup/inst_portal.gif"/>
- </imageobject>
- </mediaobject>
+ <para>
+ After the
+ <command>sh 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>
+ </para>
+ <para>
+ To build the clustered version on Windows, repeat the previous steps,
+ replacing
+ <command>sh build.sh</command>
+ with
+ <command>build.bat</command>
+ .
+ </para>
+ </sect2>
+ <sect2>
+ <title>Database Setup</title>
+ <para>
+ A database is required for JBoss Portal to run. JBoss EAP and JBoss AS
include
+ an embedded Hypersonic SQL database that JBoss Portal can use; however, this
+ is only recommended for developer use. The following databases are
recommended
+ for production use, and have had test suites run against them: MySQL 4 and
5,
+ Microsoft SQL Server, PostgreSQL 8, and Oracle Database 9 and 10. JBoss
Portal
+ can use any database that is supported by Hibernate.
+ </para>
+ <para>To configure a database to use with JBoss Portal:</para>
+ <para>
+ <orderedlist>
<listitem>
- <para>Select the packs to install (normally, you would leave this
alone).
- <mediaobject>
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/setup/inst_packs.gif"/>
- </imageobject>
- </mediaobject>
+ <para>
+ <emphasis role="bold">Create a new
database:</emphasis>
+ this guide assumes that the new database is called
+ <emphasis>jbossportal</emphasis>
+ .
</para>
</listitem>
<listitem>
- <para>This is not portal specific, but it is good practice to
secure your deployment here.
- <mediaobject>
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/setup/inst_secure.gif"/>
- </imageobject>
- </mediaobject>
+ <para>
+ <emphasis role="bold">
+ Grant access rights for a user to the
+ <emphasis>jbossportal</emphasis>
+ database:
+ </emphasis>
+ JBoss Portal needs to create tables and modify table data. Grant
+ access rights to a desired user to the
+ <emphasis>jbossportal</emphasis>
+ database. Configure the same username and password in the
Datasource
+ descriptor.
</para>
</listitem>
<listitem>
- <para>Fin.
- <mediaobject>
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/setup/inst_fin.gif"/>
- </imageobject>
- </mediaobject>
+ <para>
+ <emphasis role="bold">Deploy an RDBMS JDBC
connector:</emphasis>
+ an 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, an 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>
- <listitem>
- <para>Now, start JBoss AS, by executing
- <command>INSTALL_PATH/bin/run.bat</command>
- . The initial startup process will create all of the necessary
portal tables in the embedded
- Hypersonic database.
- <note>This will require JDK5+</note>
- </para>
- </listitem>
- <listitem>
- <para>Point your browser to
- <ulink
url="http://localhost:8080/portal">http://localhost:8080/portal</ulink>
- to view JBoss Portal.
-
- </para>
- </listitem>
</orderedlist>
</para>
</sect2>
+ <sect2>
+ <title>Datasource Configuration</title>
+ <para>
+ The JBoss Portal binary download that was extracted in
+ <xref linkend="install_binarydownload" />
+ , contains pre-configured Datasource descriptors for the more popular
+ databases. Datasource descriptors are provided for the MySQL 4 and 5,
+ PostgreSQL, Microsoft SQL Server, and Oracle databases, and can be found in
+ the
+ <filename>setup</filename>
+ subdirectory where the JBoss Portal binary was extracted to:
+ </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" valign="middle"
+ fileref="images/setup/dsfiles.png" />
+ </imageobject>
+ </mediaobject>
+ <para>
+ 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. The production configuration only exists on JBoss EAP
+ installations, and not JBoss AS.
+ </para>
+ <para>
+ After the Datasource descriptor has been copied into the
+ <filename>deploy</filename>
+ directory, make sure the
+ <computeroutput>user-name</computeroutput>
+ ,
+ <computeroutput>password</computeroutput>
+ ,
+ <computeroutput>connection-url</computeroutput>
+ , and
+ <computeroutput>driver-class</computeroutput>
+ , 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 a PostgreSQL database:
+ </para>
+ <programlisting role="XML"><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<datasources>
+ <local-tx-datasource>
+ <jndi-name>PortalDS</jndi-name>
+ <connection-url>jdbc:postgresql:jbossportal</connection-url>
+ <driver-class>org.postgresql.Driver</driver-class>
+ <user-name>portal</user-name>
+ <password>portalpassword</password>
+ </local-tx-datasource>
+</datasources>
+ ]]></programlisting>
+ <para>
+ For further details about Datasource descriptors, please refer to the
+ <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
+ JBoss JDBC Datasource Wiki page
+ </ulink>
+ .
+ </para>
+ </sect2>
+ </sect1>
+ <sect1>
+ <title>Deploying JBoss Portal</title>
+ <para>To start JBoss EAP or JBoss AS and deploy JBoss Portal:</para>
+ <para>
+ <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_HOME/server/
+ <replaceable>configuration</replaceable>
+ /deploy/
+ </filename>
+ directory.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Start the
server:</emphasis>
+ change into the
+ <filename>$JBOSS_HOME/bin/</filename>
+ directory. On Windows, execute
+ <command>run.bat</command>
+ . On Linux, run the
+ <command>sh run.sh</command>
+ command. To specify a configuration to use, for example, the default
+ configuration, append the
+ <command>-c default</command>
+ option to the
+ <command>run.bat</command>
+ or
+ <command>sh run.sh</command>
+ commands.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">Log in to JBoss
Portal:</emphasis>
+ using a Web browser, navigate to
+ <ulink
url="http://localhost:8080/portal"></ulink>
+ to open the JBoss Portal homepage. Log in using one of the two default
+ accounts: username
+ <emphasis>user</emphasis>
+ , password
+ <emphasis>user</emphasis>
+ , or username
+ <emphasis>admin</emphasis>
+ , password
+ <emphasis>admin</emphasis>
+ .
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <formalpara>
+ <title>SQL Errors</title>
+ <para>
+ Tables are automatically created the first time JBoss Portal starts. When
+ deployed for the first time, JBoss Portal checks for the existence of the
+ initial tables, which have not been created yet. This causes errors such as
+ the following, which can safely be ignored:
+ </para>
+ </formalpara>
+ <para>
+ <programlisting><![CDATA[
+WARN [JDBCExceptionReporter] SQL Error: -22, SQLState: S0002
+ERROR [JDBCExceptionReporter] Table not found in statement ...
+WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
+ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_repositoryentry'
doesn't exist
+WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02
+ERROR [JDBCExceptionReporter] Table 'jbossportal.jbp_cms_version_refs'
doesn't exist
+]]></programlisting>
+ </para>
+ </sect1>
- </sect1>-->
-
</chapter>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supported.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supported.xml 2008-07-15
14:12:50 UTC (rev 11451)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supported.xml 2008-07-15
15:49:02 UTC (rev 11452)
@@ -36,7 +36,7 @@
</sect1>
<sect1>
<title>JBoss Application Server</title>
- <para>JBoss Portal 2.6.5 is tested with JBoss Application Server (AS) 4.2.1,
JBoss AS 4.2.2, JBoss Enterprise Application Platform (EAP) 4.2 and JBoss EAP 4.3. It is
highly recommended that customers who have access to the <ulink
url="https://support.redhat.com/portal/login.html">JBoss Customer Support
Portal (CSP)</ulink> use JBoss EAP 4.3 (It is mandatory to get access to
professional support). Customers who do not have access to the JBoss CSP should use
<ulink
url="http://labs.jboss.com/jbossas/">JBoss AS</ulink>.
+ <para>JBoss Portal 2.7.0 is tested with JBoss Application Server (AS) JBoss
AS 4.2.2, JBoss Enterprise Application Platform (EAP) 4.2 and JBoss EAP 4.3. It is highly
recommended that customers who have access to the <ulink
url="https://support.redhat.com/portal/login.html">JBoss Customer Support
Portal (CSP)</ulink> use JBoss EAP 4.3. Customers who do not have access to the
JBoss CSP should use <ulink
url="http://labs.jboss.com/jbossas/">JBoss
AS</ulink>.
</para>
<warning>
<para>JBoss AS versions 4.0.<replaceable>x</replaceable> are
not supported.</para>