JBoss Portal SVN: r12416 - docs/enterprise/trunk/Reference_Guide/en-US.
by portal-commits＠lists.jboss.org
Author: prabhat.jha(a)jboss.com
Date: 2008-12-22 11:52:59 -0500 (Mon, 22 Dec 2008)
New Revision: 12416
Modified:
docs/enterprise/trunk/Reference_Guide/en-US/Configuration.xml
docs/enterprise/trunk/Reference_Guide/en-US/Installation.xml
docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml
Log:
some invalid references
Modified: docs/enterprise/trunk/Reference_Guide/en-US/Configuration.xml
===================================================================
--- docs/enterprise/trunk/Reference_Guide/en-US/Configuration.xml 2008-12-22 16:41:53 UTC (rev 12415)
+++ docs/enterprise/trunk/Reference_Guide/en-US/Configuration.xml 2008-12-22 16:52:59 UTC (rev 12416)
@@ -121,7 +121,7 @@
</listitem>
<listitem>
<para>
- Rebuild and redeploy JBoss Portal. Refer to <xref linkend="install_source"/> for build instructions.
+ <!-- Rebuild and redeploy JBoss Portal. Refer to <xref linkend="install_source"/> for build instructions.-->
</para>
</listitem>
</orderedlist>
Modified: docs/enterprise/trunk/Reference_Guide/en-US/Installation.xml
===================================================================
--- docs/enterprise/trunk/Reference_Guide/en-US/Installation.xml 2008-12-22 16:41:53 UTC (rev 12415)
+++ docs/enterprise/trunk/Reference_Guide/en-US/Installation.xml 2008-12-22 16:52:59 UTC (rev 12416)
@@ -5,8 +5,7 @@
<chapter id="installation">
<title>Installation</title>
<para>
- Please see the accompanying Installation Guide found on how to
- install Enterprise Portal Platform.
+ Please see the accompanying Installation Guide on how to install Enterprise Portal Platform.
</para>
</chapter>
Modified: docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml
===================================================================
--- docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml 2008-12-22 16:41:53 UTC (rev 12415)
+++ docs/enterprise/trunk/Reference_Guide/en-US/XML_Descriptors.xml 2008-12-22 16:52:59 UTC (rev 12416)
@@ -1382,17 +1382,17 @@
<orderedlist>
<listitem>
<para>
- Obtain the JBoss Portal source code: <xref linkend="install_source" />.
+ Obtain the JBoss Portal source code: <!--<xref linkend="install_source" />.-->
</para>
</listitem>
<listitem>
<para>
- Configure the <computeroutput>JBOSS_HOME</computeroutput> environment variable: <xref linkend="install_source_env"/>.
+ Configure the <computeroutput>JBOSS_HOME</computeroutput> environment variable:<!-- <xref linkend="install_source_env"/>. -->
</para>
</listitem>
<listitem>
<para>
- Change into the <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename> directory. To build the JBoss Portal source code on Linux, run the <command>sh build.sh deploy</command> command, or, if you are running Windows, run the <command>build.bat deploy</command> command. If this is the first build, third-party libraries are obtained from an online repository, so you must be connected to the Internet. After building, if the <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/thirdparty/</filename> directory does not exist, it is created, and populated with the files required for later steps. For further details, refer to <xref linkend="building_deploying_from_source" />.
+ Change into the <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename> directory. To build the JBoss Portal source code on Linux, run the <command>sh build.sh deploy</command> command, or, if you are running Windows, run the <command>build.bat deploy</command> command. If this is the first build, third-party libraries are obtained from an online repository, so you must be connected to the Internet. After building, if the <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/thirdparty/</filename> directory does not exist, it is created, and populated with the files required for later steps. <!-- For further details, refer to <xref linkend="building_deploying_from_source" />. -->
</para>
</listitem>
<listitem>
17 years, 7 months
JBoss Portal SVN: r12415 - docs/enterprise/trunk/Reference_Guide/en-US.
by portal-commits＠lists.jboss.org
Author: prabhat.jha(a)jboss.com
Date: 2008-12-22 11:41:53 -0500 (Mon, 22 Dec 2008)
New Revision: 12415
Modified:
docs/enterprise/trunk/Reference_Guide/en-US/Installation.xml
Log:
remove installation part from this guide. Refere to accompanying installation guide.
Modified: docs/enterprise/trunk/Reference_Guide/en-US/Installation.xml
===================================================================
--- docs/enterprise/trunk/Reference_Guide/en-US/Installation.xml 2008-12-19 20:10:46 UTC (rev 12414)
+++ docs/enterprise/trunk/Reference_Guide/en-US/Installation.xml 2008-12-22 16:41:53 UTC (rev 12415)
@@ -3,1022 +3,10 @@
"http://www.docbook.org/xml/4.5/docbookx.dtd">
<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">
- 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>
- <section 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>
- <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">
- 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>
- </section>
- <section 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>
- <section>
- <title>Setting up your Environment</title>
- <section 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">
- 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" />
- </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>
- </section>
- <section>
- <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>
- </section>
- <section 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>
- </section>
- <section>
- <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>
- <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
- <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>
- </section>
- <section>
- <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"?>
-<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>
- </section>
- </section>
- <section>
- <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>
- </section>
- </section>
- <section id="install_source">
- <title>Installing from the Sources</title>
- <section>
- <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">
- 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_Branch_2_7" />
- .
- </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.1:
- <emphasis>
- http://anonsvn.jboss.org/repos/portal/modules/common/tags/JBP_COMMON_1_2_1
- </emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss Portal Web 1.2.1:
- <emphasis>
- http://anonsvn.jboss.org/repos/portal/modules/web/tags/JBP_WEB_1_2_1
- </emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss Portal Test 1.0.3:
- <emphasis>
- http://anonsvn.jboss.org/repos/portal/modules/test/tags/JBP_TEST_1_0_3
- </emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss Portal Portlet 2.0.3:
- <emphasis>
- http://anonsvn.jboss.org/repos/portal/modules/portlet/tags/JBP_PORTLET_2_0_3
- </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>
- <listitem>
- <para>
- JBoss Portal CMS 1.2.0:
- <emphasis>
- http://anonsvn.jboss.org/repos/portal/modules/cms/tags/JBP_CMS_1_2_0
- </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>
- </section>
- <section>
- <title>JBoss EAP and JBoss AS Setup</title>
- <section>
- <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>
- </section>
- <section 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
- <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>
- </section>
- </section>
- <section 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>
+ <title>Installation</title>
+ <para>
+ Please see the accompanying Installation Guide found on how to
+ install Enterprise Portal Platform.
+ </para>
-<!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="extras/runconf_javaops.xmlt"/>-->
-<programlisting>JAVA_OPTS=-Dhttp.proxyHost=<proxy-hostname> -Dhttp.proxyPort=<proxy-port></programlisting>
-
- <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">
- 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>
- 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>
- </section>
- <section>
- <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>
- </section>
- <section>
- <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>
- </section>
- </section>
- <section>
- <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>
- </section>
-
</chapter>
17 years, 7 months