[gatein-commits] gatein SVN: r2858 - portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US.

Author: luc.texier(a)jboss.com Date: 2010-04-28 03:50:44 -0400 (Wed, 28 Apr 2010) New Revision: 2858 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Author_Group.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Revision_History.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Test_Your_Installation.xml Log: JBEPP-274: luc's review pass #2 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Author_Group.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Author_Group.xml 2010-04-28 07:35:58 UTC (rev 2857) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Author_Group.xml 2010-04-28 07:50:44 UTC (rev 2858) @@ -16,11 +16,20 @@ <email&gt;smumford(a)redhat.com&lt;/email&gt; </editor> <editor> + <firstname>Luc</firstname> + <surname>Texier</surname> + <affiliation> + <shortaffil>Red Hat</shortaffil> + <orgdiv>JBoss Engineering</orgdiv> + </affiliation> + <email&gt;theute(a)redhat.com&lt;/email&gt; + </editor> + <editor> <firstname>Thomas</firstname> <surname>Heute</surname> <affiliation> <shortaffil>Red Hat</shortaffil> - <orgdiv>JBoss Services R&amp;D</orgdiv> + <orgdiv>JBoss Engineering</orgdiv> </affiliation> <email&gt;theute(a)redhat.com&lt;/email&gt; </editor> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml 2010-04-28 07:35:58 UTC (rev 2857) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml 2010-04-28 07:50:44 UTC (rev 2858) @@ -24,8 +24,8 @@ <section id="sect-Reference_Guide-Clustering_Configuration-Prerequisite"> <title>Prerequisites</title> - <para>As &PRODUCT; requires the clustering services to run, only the <literal>all</literal> - and <remark>production?</remark> configuration can be used. Additionally the following prerequisites + <para>The clustering services are available only in the <literal>all</literal> + and <remark>production</remark> server configurations. Additionally the following prerequisites should be met: </para> <itemizedlist> @@ -119,7 +119,7 @@ <section id="sect-Reference_Guide-Clustering_Running"> <title>Running with the cluster profile</title> - <para>To run the portal ready for clustering, you would need to start all nodes with the extra profile.</para> + <para>To run the portal in high-availability mode, you would need to start all nodes with an extra profile configuration as follows:</para> <formalpara><title>In Linux</title> <para> <literal>run.sh -c all -Dexo.profiles=cluster</literal> @@ -132,4 +132,4 @@ </para> </formalpara> </section> -</section> \ No newline at end of file +</section> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml 2010-04-28 07:35:58 UTC (rev 2857) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml 2010-04-28 07:50:44 UTC (rev 2858) @@ -31,16 +31,17 @@ database user has the appropriate permissions).</para> <note><para>&PRODUCT; assumes the default encoding for your database is - <literal>latin1</literal> . You will need to change this parameter in - order for your database to work correctly.</para></note> + <literal>latin1</literal>.</para></note> </section> <section id="sect-Reference_Guide-Database_Configuration-JCR_database_configuration"> - <title>Configuring the database for JCR</title> + <title>Configuring the database datasource for JCR</title> - <para>To configure the database used by JCR you will need to edit the + <para>To configure the database datasource used by JCR you will need to edit the datasource descriptor located at - $JBOSS_HOME/server/<remark>$CONFIG</remark>/deploy/gatein-ds.xml:<programlisting>&lt;no-tx-datasource&gt; + $JBOSS_HOME/server/<remark>$CONFIG</remark>/deploy/gatein-ds.xml: +<programlisting> + &lt;no-tx-datasource&gt; &lt;jndi-name&gt;gatein-jcr&lt;/jndi-name&gt; &lt;connection-url&gt; jdbc:hsqldb:${jboss.server.data.dir}${/}gatein${/}hypersonic${/}gatein-jcr-localDB @@ -53,11 +54,13 @@ &lt;max-pool-size&gt;20&lt;/max-pool-size&gt; &lt;idle-timeout-minutes&gt;0&lt;/idle-timeout-minutes&gt; &lt;prepared-statement-cache-size&gt;32&lt;/prepared-statement-cache-size&gt; -&lt;/no-tx-datasource&gt;</programlisting></para> + &lt;/no-tx-datasource&gt; +</programlisting> +</para> <para>Edit the values of driver-class, connection-url, user-name and password to match the specific values for your database (Please refer to your database - JDBC driver documentation).</para> + JDBC driver documentation for more information about these attributes).</para> <para>In the case of HSQL, the databases are created automatically. For any other database you will need to firstly create the database.</para> @@ -67,26 +70,21 @@ created.</para> <para>Add the JDBC driver to the classpath, by copying the relevant - <filename>&lt;connector-type&gt;-&lt;version&gt;-bin.jar</filename> to the - <filename>$JBOSS_HOME/server/$CONFIG/lib</filename> directory.</para> + JAR file to the <filename>$JBOSS_HOME/server/$CONFIG/lib</filename> directory.</para> </section> <section> - <title>Configuring the database for the default identity store</title> + <title>Configuring the database datasource for the default identity store</title> - <para><remark>Users are stored in the HSQL database by default. To change the database to - which users are stored, you will need to edit the file:</remark></para> + <para>To configure the database datasource used by IDM you will need to edit the + datasource descriptor located at $JBOSS_HOME/server/<remark>$CONFIG</remark>/deploy/gatein-ds.xml: - <para><programlisting>$JBOSS_HOME/server/<remark>$CONFIG</remark>/deploy/gatein-ds.xml</programlisting></para> - - <para>This file contains the same configuration details as JCR:</para> - - <para><programlisting> &lt;no-tx-datasource&gt; - &lt;jndi-name&gt;gatein-jcr&lt;/jndi-name&gt; + <programlisting> &lt;no-tx-datasource&gt; + &lt;jndi-name&gt;gatein-idm&lt;/jndi-name&gt; &lt;connection-url&gt; - jdbc:hsqldb:${jboss.server.data.dir}${/}gatein${/}hypersonic${/}gatein-jcr-localDB + jdbc:hsqldb:${jboss.server.data.dir}${/}gatein${/}hypersonic${/}gatein-idm-localDB &lt;/connection-url&gt; &lt;driver-class&gt;org.hsqldb.jdbcDriver&lt;/driver-class&gt; &lt;user-name&gt;sa&lt;/user-name&gt; @@ -96,11 +94,11 @@ &lt;max-pool-size&gt;20&lt;/max-pool-size&gt; &lt;idle-timeout-minutes&gt;0&lt;/idle-timeout-minutes&gt; &lt;prepared-statement-cache-size&gt;32&lt;/prepared-statement-cache-size&gt; - &lt;/no-tx-datasource&gt; -</programlisting></para> + &lt;/no-tx-datasource&gt; + </programlisting> + </para> - <para>More information about setting up datasources can be found in the - Enterprise Application Platform documentation.</para> + <para>More information about setting up datasources can be found in the Enterprise Application Platform documentation.</para> <warning> <title>Using Sybase</title> @@ -112,7 +110,7 @@ </section> <section> - <title>Example with MySQL</title> + <title>Example with MySQL Server 5.1</title> <indexterm> <primary>Configuration</primary> @@ -126,24 +124,24 @@ <primary>MySQL</primary> </indexterm> <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Installing_the_MySQL_RDBMS_JDBC_connector"> - <title>Installing the MySQL RDBMS JDBC connector</title> - <para>The RDBMS JDBC MySQL connector is required for EPP to use a MySQL database:</para> + <title>Installing the MySQL JDBC connector</title> + <para>The MySQL JDBC connector is required for EPP to use a MySQL database:</para> </formalpara> <orderedlist> <listitem> <para> - Navigate to the <ulink url="http://dev.mysql.com/downloads/connector/j/3.1.html">JDBC MySQL connector</ulink> section of dev.mysql.com. Download the <computeroutput>Compressed Tar Archive (.tar.gz)</computeroutput> file or the <computeroutput>Zip Archive (.zip)</computeroutput> file. + Navigate to http://www.mysql.com/downloads/connector/j/ and download a version listed in the Certified Configurations table available on the <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura...; website</ulink>. </para> </listitem> <listitem> <para> - Unzip the <filename>mysql-java-connector</filename> into the desired directory. It does not matter which directory is used. + Unzip the archive in a directory of your choice. </para> </listitem> <listitem> <para> - Change into the directory to which the <filename>mysql-java-connector</filename> was extracted. Copy the <filename>mysql-connector-java-<replaceable>version-number</replaceable>-bin.jar</filename> file into the <filename>$JBOSS_HOME/server/<replaceable>$CONFIG</replaceable>/lib/</filename> directory. + Copy the <filename>mysql-connector-java-5.<replaceable>version-number</replaceable>-bin.jar</filename> file into the <filename>$JBOSS_HOME/server/<replaceable>$CONFIG</replaceable>/lib/</filename> directory. </para> </listitem> </orderedlist> @@ -176,12 +174,12 @@ </para> <note><title>Note: Database names</title> <para> - The remainder of this guide, and the configuration examples that follow assume the database names to be gatein-jcr and gatein-idm. If you change the database names, please change the name in all of the gatein-dsl.xml files (for each server configuration used). + The remainder of this guide, and the configuration examples that follow assume the database names to be gatein-jcr and gatein-idm. If you change the database names, please update gatein-dsl.xml accordingly (for each server configuration used). </para> </note> <para> <screen> -mysql&gt; CREATE DATABASE gatein-idm; +mysql&gt; CREATE DATABASE gatein-jcr; </screen> </para> <para> @@ -193,7 +191,7 @@ </screen> </para> <para> - Do the same with gateinjcr. At this point, the <command>SHOW DATABASES;</command> command should display the <command>gatein</command> databases: + Do the same with gateinidm. At this point, the <command>SHOW DATABASES;</command> command should display the <command>gatein</command> databases: </para> <para> <screen> @@ -233,11 +231,13 @@ IDENTIFIED BY &#39;<replaceable>gateinpassword</replaceable>&#39; WITH GRANT OPTION; </screen> </para> +<!-- <note><title>Note: Changed password?</title> <para> If you changed the portal user&#39;s password, remember to also change the password in the MySQL Datasource descriptor. </para> </note> +--> </listitem> </orderedlist> @@ -330,7 +330,16 @@ <idle-timeout-minutes>0</idle-timeout-minutes> <prepared-statement-cache-size>32</prepared-statement-cache-size> </no-tx-datasource> -</datasources>]]> </programlisting> +</datasources>]]> +</programlisting> + <important> + <title>Important</title> + <para> + Some underlying JBoss Enterprise Application Platform services might still be using Hypersonic which is an in-VM database server loaded in the same memory space. To connect these services to another RDBMS or disable them please refer to the EAP documentation or simply contact JBoss Support for assistance. + </para> + </important> + + </section> </section> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml 2010-04-28 07:35:58 UTC (rev 2857) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml 2010-04-28 07:50:44 UTC (rev 2858) @@ -19,7 +19,7 @@ <title>Other Manuals</title> <para> If you are looking for detailed information about other JBoss middleware products such as JBoss Enterprise Applications Platform please refer to the manuals available online at <ulink url="http://www.redhat.com/docs/manuals/jboss"></ulink>;. - <!--TODO mention about the other guides attached--> + </para> </section> </chapter> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Revision_History.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Revision_History.xml 2010-04-28 07:35:58 UTC (rev 2857) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Revision_History.xml 2010-04-28 07:50:44 UTC (rev 2858) @@ -35,10 +35,25 @@ </author> <revdescription> <simplelist> - <member>Updates as described in JBEPP-288 for the verison 5.0 release.</member> + <member>Updates as described in JBEPP-288 for the version 5.0 release.</member> </simplelist> </revdescription> </revision> + + <revision> + <revnumber>3</revnumber> + <date>Tue Apr 28 2010</date> + <author> + <firstname>Luc</firstname> + <surname>Texier</surname> + <email&gt;ltexier(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>https://jira.jboss.org/jira/browse/JBEPP-274.</member> + </simplelist> + </revdescription> + </revision> </revhistory> </simpara> </appendix> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Test_Your_Installation.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Test_Your_Installation.xml 2010-04-28 07:35:58 UTC (rev 2857) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Test_Your_Installation.xml 2010-04-28 07:50:44 UTC (rev 2858) @@ -97,7 +97,7 @@ </figure> </para> <para> - You are now ready to use the JBoss Enterprise Portal Platform. Refer to the User Guide and Reference Guide for more information about the platform layout and example applications showcasing JBoss Portal in action. + You are now ready to use &PRODUCT; 5.0. Refer to the User Guide and Reference Guide for more information about the product's feature set and example applications showcasing &PRODUCT; in action. </para> </chapter>