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

Author: smumford Date: 2010-05-18 05:25:04 -0400 (Tue, 18 May 2010) New Revision: 3110 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/EMailServiceConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Test_Your_Installation.xml Log: JBEPP-274: Minor changes as per QE feedback in JIRA (17/May/10) 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-05-18 05:06:24 UTC (rev 3109) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml 2010-05-18 09:25:04 UTC (rev 3110) @@ -39,21 +39,21 @@ <para>To configure the database datasource used by JCR you will need to edit the datasource descriptor located at - $JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml: + <filename>$JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml</filename>: <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 - &lt;/connection-url&gt; - &lt;driver-class&gt;org.hsqldb.jdbcDriver&lt;/driver-class&gt; - &lt;user-name&gt;sa&lt;/user-name&gt; - &lt;password&gt;&lt;/password&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 + &lt;/connection-url&gt; + &lt;driver-class&gt;org.hsqldb.jdbcDriver&lt;/driver-class&gt; + &lt;user-name&gt;sa&lt;/user-name&gt; + &lt;password&gt;&lt;/password&gt; - &lt;min-pool-size&gt;5&lt;/min-pool-size&gt; - &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;min-pool-size&gt;5&lt;/min-pool-size&gt; + &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> @@ -79,9 +79,10 @@ <title>Configuring the database datasource for the default identity store</title> <para>To configure the database datasource used by IDM you will need to edit the - datasource descriptor located at $JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml: + datasource descriptor located at <filename>$JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml</filename>: - <programlisting> &lt;no-tx-datasource&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-idm-localDB @@ -94,15 +95,15 @@ &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> + &lt;/no-tx-datasource&gt; +</programlisting> </para> <para>More information about setting up datasources can be found in the Enterprise Application Platform documentation.</para> <warning> <title>Using Sybase</title> - <para>Sybase requires a particular configuration of GateIn, to switch on that configuration, it is + <para>Sybase requires a particular configuration of &PRODUCT;, to switch on that configuration, it is mandatory to run the portal with the extra <literal>sybase</literal> profile. This would mean to run the application server with <literal>sh run.sh -Dexo.profiles=sybase</literal> in a single node and <literal>sh run.sh -Dexo.profiles=sybase,cluster</literal> for a cluster node.</para> @@ -162,7 +163,7 @@ </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 update gatein-dsl.xml accordingly (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-ds.xml accordingly (for each server configuration used). </para> </note> <para> @@ -179,7 +180,7 @@ </screen> </para> <para> - Do the same with gateinidm. At this point, the <command>SHOW DATABASES;</command> command should display the <command>gatein</command> databases: + Do the same with <emphasis role="bold">gateinidm</emphasis>. At this point, the <command>SHOW DATABASES;</command> command should display the <command>gatein</command> databases: </para> <para> <screen> @@ -238,7 +239,7 @@ <orderedlist> <listitem> <para> - Edit the file located at $JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml + Edit the file located at <filename>$JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml</filename>. </para> </listitem> <listitem> @@ -291,7 +292,7 @@ </listitem> </orderedlist> - <para><literal>gatein-ds.xml</literal> will then look like:</para> + <para><filename>gatein-ds.xml</filename> will then look like:</para> <programlisting><![CDATA[<datasources> <no-tx-datasource> <jndi-name>gatein-idm</jndi-name> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/EMailServiceConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/EMailServiceConfiguration.xml 2010-05-18 05:06:24 UTC (rev 3109) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/EMailServiceConfiguration.xml 2010-05-18 09:25:04 UTC (rev 3110) @@ -20,7 +20,7 @@ <title>Configuring the outgoing e-mail account</title> <para>The e-mail service can use any SMTP account configured in - $JBOSS_HOME/server/$CONFIG/conf/gatein/configuration.properties</para> + <filename>$JBOSS_HOME/server/$CONFIG/conf/gatein/configuration.properties</filename></para> <para>The relevant section looks like:</para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml 2010-05-18 05:06:24 UTC (rev 3109) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml 2010-05-18 09:25:04 UTC (rev 3110) @@ -56,7 +56,7 @@ <itemizedlist> <listitem> <para> - Disk Space: 1.5GB + Disk Space: 1.5 GB </para> <itemizedlist> <listitem> @@ -66,7 +66,7 @@ </listitem> <listitem> <para> - The remaining 500MB is allocated to the server installation (240MB), the required JDK (150MB) and some additional space for applications (110MB). + The remaining 500 MB is allocated to the server installation (240 MB), the required JDK (150 MB) and some additional space for applications (110 MB). </para> </listitem> </itemizedlist> @@ -90,7 +90,7 @@ <itemizedlist> <listitem> <para> - RAM installations of 2 GB or more will be required to run a server upon which small to medium applications are deployed. 4GB or more is preferable for larger applications or to run a GUI server interface. + RAM installations of 2 GB or more will be required to run a server upon which small to medium applications are deployed. 4 GB or more is preferable for larger applications or to run a GUI server interface. </para> </listitem> </itemizedlist> @@ -403,7 +403,7 @@ </listitem> <listitem> <para> - Applications that run with more than 1.5GB of RAM (including free space for garbage collection optimization) should utilize the 64-bit JVM. + Applications that run with more than 1.5 GB of RAM (including free space for garbage collection optimization) should utilize the 64-bit JVM. </para> </listitem> </itemizedlist> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml 2010-05-18 05:06:24 UTC (rev 3109) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml 2010-05-18 09:25:04 UTC (rev 3110) @@ -31,9 +31,9 @@ On Microsoft Windows </title> <para> - Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: C:\jboss-epp-5.0\jboss-as\. - In order to run the server from the command line add the <filename>bin</filename> directory to your path, for example: <literal>C:\jboss-epp-5.0\jboss-as\bin</literal>. - You may set these variables by going to the System Properties window then select the Advanced tab and finally click on the Environment Variables button + Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: <filename>C:\jboss-epp-5.0\jboss-as\</filename>. + In order to run the server from the command line add the <filename>bin</filename> directory to your path, for example: <filename>C:\jboss-epp-5.0\jboss-as\bin</filename>. + You may set these variables by going to the System Properties window then select the Advanced tab and finally click on the Environment Variables button. </para> </formalpara> </section> @@ -51,7 +51,7 @@ <para><remark>End Note to Reviewer</remark></para> --> <para> - If the server is running out of memory, you may adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/bin/run.conf</filename> on Linux or <filename>JBOSS_DIST/jboss-as/bin/run.conf.bat</filename> on Windows. The default values don't take in account the memory requirements of your applications: + If the server is running out of memory, you may adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/bin/run.conf</filename> on Linux or <filename>JBOSS_DIST/jboss-as/bin/run.conf.bat</filename> on Windows. The default values don't take into account the memory requirements of your applications: <programlisting> -Xms1303m -Xmx1303m -XX:MaxPermSize=256m .... </programlisting> 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-05-18 05:06:24 UTC (rev 3109) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Test_Your_Installation.xml 2010-05-18 09:25:04 UTC (rev 3110) @@ -8,7 +8,7 @@ <title>Test your Installation</title> <para> - After you have installed the JBoss Enterprise Portal Platform, it is wise to perform a simple startup test to validate that there are no major problems with your Java VM/operating system combination. Make sure you have set the <literal>JBOSS_HOME</literal> environment variables as explained in <ulink url="Post_Installation_Configuration"/>. + After you have installed the JBoss Enterprise Portal Platform, it is wise to perform a simple startup test to validate that there are no major problems with your Java VM/operating system combination. Make sure you have set the <literal>JBOSS_HOME</literal> environment variables as explained in <xref linkend="Post_Installation_Configuration"/>. </para> <para> To test your installation: