Author: mmcallis
Date: 2008-02-03 23:12:45 -0500 (Sun, 03 Feb 2008)
New Revision: 9725
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
Log:
updating
2.3.4. Database Setup
2.3.5. Datasource Configuration
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-02-04
01:27:57 UTC (rev 9724)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-02-04
04:12:45 UTC (rev 9725)
@@ -377,67 +377,50 @@
</para>
</sect2>
<sect2>
- <title>Setting up the database</title>
- <sect3>
- <title>Database Setup</title>
- <para>You will need a database for JBoss Portal to function, you can
use any database
- supported by Hibernate.
- <orderedlist>
- <listitem>
- <para>
- <emphasis role="bold">Create a new
Database:</emphasis>
- For example purposes we call this new database
- <emphasis>jbossportal</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Grant access rights for a
user to your database:</emphasis>
- You must make sure the user has access to this new DB, as JBoss
Portal will need to create the
- tables and modify data within them.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Deploy your JDBC
connector:</emphasis>
- You must make available a JDBC connector for JBoss Portal to
communicate with your database. The
- connector lib should be placed in
- <filename>JBOSS_HOME/server/default/lib/*</filename>
- </para>
- </listitem>
- </orderedlist>
- </para>
- </sect3>
- <sect3>
- <title>DataSource Configuration</title>
- <para>
- You will need a valid datasource descriptor, for JBoss Portal to
communicate with your database. Having
- obtained the sources and having set your JBOSS_HOME environment variable
(
- <xref linkend="install_source_env"/>
- ), you can now have the JBoss Portal build system generate preconfigured
datasources for you.
- </para>
- <para>
- Navigate to
- <filename>JBOSS_PORTAL_HOME_DIRECTORY/core</filename>
- and type:
- <programlisting>build datasource</programlisting>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/build_ds.png"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>
- Once complete, the datasource build should produce the following directory
and file structure:
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/setup/build_ds_dir.png"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>At this point, you should configure the one that suits you best
with your Database and JDBC
- driver.
- <programlisting><![CDATA[
+ <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, MySQL 5, Microsoft SQL Server,
PostgreSQL 8, Oracle 9, and Oracle 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 will be 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 a RDBMS JDBC
connector:</emphasis> a RDBMS JDBC connector is required for JBoss Portal to
communicate with a database. Copy the connector into the
<filename>JBOSS_INSTALL_DIRECTORY/server/default/lib/</filename> directory.
For example, a RDBMS JDBC connector for MySQL can be download from <ulink
url="http://www.mysql.com/products/connector/j/"></ulink>. For the
correct RDMBS JDBC connector, please refer to the database documentation.
+ </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, MySQL 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_INSTALLATION_DIRECTORY/server/<replaceable>configuration</replaceable>/deploy/</filename>
directory, where <replaceable>configuration</replaceable> is either all,
default, minimal, or production. For example, if you are using the production
configuration, copy the Datasource descriptor into the
<filename>JBOSS_INSTALLATION_DIRECTORY/server/production/deploy/</filename>
directory.
+ </para>
+ <para>
+ After the Datasource descriptor has been copied into the
<filename>deploy</filename> directory, make sure the username, password,
connection-url, and driver-class are correct for your chosen database. Datasource
descriptor files can be deployed to test before being used in production. The following is
an example Datasource descriptor for the PostgreSQL database:
+ </para>
+ <programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<datasources>
<local-tx-datasource>
@@ -448,18 +431,11 @@
<password>portalpassword</password>
</local-tx-datasource>
</datasources>
- ]]></programlisting>
- Please verify that the username, password, url, and driver-class are
correct for
- your flavor of DB.
- </para>
- <para>
- Now
- <emphasis role="bold">copy</emphasis>
- your datasource descriptor to
- <filename>JBOSS_HOME/server/default/deploy</filename>
- </para>
- </sect3>
- </sect2>
+ ]]></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>
<sect2>
<title>Starting and running JBoss Portal</title>
<para>