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

Author: benlc Date: 2010-04-16 03:41:09 -0400 (Fri, 16 Apr 2010) New Revision: 2674 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/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/Installation.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 portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Uninstall_JBoss.xml Log: 'committing minor changes and review request comments' 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-16 07:16:34 UTC (rev 2673) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml 2010-04-16 07:41:09 UTC (rev 2674) @@ -16,31 +16,87 @@ <section id="sect-Reference_Guide-Clustering_Configuration-Overview"> <title>Overview</title> - <para>EPP has been developed to support high availability and high horizontal and vertical scalability. - The setup instructions has been kept to the minimal, but a good understanding of clustering services in - EAP and JBoss Cache would be reuired for optimal settings. + <para>&PRODUCT; has been developed to support high availability and high horizontal and vertical scalability. + The setup instructions have been kept to a minimum, however, a good understanding of clustering services in + &JBEAP; and JBoss Cache would be required in order to configure the optimal settings. </para> </section> <section id="sect-Reference_Guide-Clustering_Configuration-Prerequisite"> - <title>Prerequisite</title> - <para>As EPP requires the clustering services to run, only the <literal>all</literal> - and <literal>configuration</literal> can be used.</para> - <para>A rapid shared filesystem is also required such as a Storage Area Network (SAN).</para> - <para>Databases should be shared among the various nodes of the cluster and configured to point to the same instances.</para> + <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 + should be met: + </para> + <itemizedlist> + <listitem> + <para> + a rapid shared filesystem is required such as a Storage Area Network (SAN) and; + </para> + </listitem> + <listitem> + <para> + databases should be shared among the various nodes of the cluster and configured to point to the same instances. + </para> + </listitem> + </itemizedlist> </section> <section id="sect-Reference_Guide-Clustering_Properties"> <title>configuration.properties</title> - <para>Edit $EPP_HOME/jboss-as/server/$CONFIG/conf/gatein/configuration.properties to edit:</para> + <para>Edit the following entries in the <filename>$JBOSS_HOME/jboss-as/server/$CONFIG/conf/gatein/configuration.properties</filename> file:</para> <itemizedlist> - <listitem><para><literal>gatein.jcr.storage.data.dir</literal> to specify the location of the shared filesystem</para></listitem> - <listitem><para><literal>gatein.jcr.index.data.dir</literal> to specify the location on a shared filesystem to store data</para></listitem> - <listitem><para><literal>gatein.jcr.changefilterclass</literal> must be changed to org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter</para></listitem> - <listitem><para><literal>gatein.jcr.config.type</literal> must be changed to cluster</para></listitem> + <listitem> + <para> + <literal>gatein.jcr.storage.data.dir;</literal> + <itemizedlist> + <listitem> + <para> + to specify the location of the shared filesystem. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <literal>gatein.jcr.index.data.dir;</literal> + <itemizedlist> + <listitem> + <para> + to specify the location on a shared filesystem to store data. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <literal>gatein.jcr.changefilterclass;</literal> + <itemizedlist> + <listitem> + <para> + this must be changed to org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <literal>gatein.jcr.config.type;</literal> + <itemizedlist> + <listitem> + <para> + this must be changed to cluster. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> </itemizedlist> <para> - The default property file would look like: + The default property file would look like the following: <programlisting># Data gatein.data.dir=/mnt/shared/mylocation @@ -63,7 +119,17 @@ <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 like: - <literal>run.sh -c all -Dexo.profiles=cluster</literal> (Or run.bat -c all -Dexo.profiles=cluster on Windows)</para> + <para>To run the portal ready for clustering, you would need to start all nodes with the extra profile.</para> + <formalpara><title>In Linux</title> + <para> + <literal>run.sh -c all -Dexo.profiles=cluster</literal> + </para> + </formalpara> + + <formalpara><title>In Windows</title> + <para> + <literal>run.bat -c all -Dexo.profiles=cluster</literal> + </para> + </formalpara> </section> </section> \ No newline at end of file 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-16 07:16:34 UTC (rev 2673) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml 2010-04-16 07:41:09 UTC (rev 2674) @@ -18,23 +18,23 @@ <para> A relational database management system (RDBMS) Java Database Connectivity (JDBC) connector is required for &PRODUCT; to communicate with a database. - &PRODUCT; comes bundled with Hypersonic SQL (HSQL) database so that users can get up and running quickly without having to initially set up + &PRODUCT; comes bundled with the Hypersonic SQL (HSQL) database so that users can get up and running quickly without having to initially set up a database. However, HSQL should not be used in a production environment. </para> <para>&PRODUCT; has two different database dependencies. One is the - identity service configuration, which depends on the Hibernate. The other - database dependency is Java content repository (JCR) service, which - depends on the native JDBC API and it can integrate with any existing - datasource implementation.</para> + identity service configuration, which depends on Hibernate. The other + database dependency is the Java content repository (JCR) service, which + depends on the native JDBC API. JCR has the capability to integrate with + any existing datasource implementation.</para> <para>When you start the portal for the first time, it will automatically create the proper schema (assuming that the 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 for - your database in order to work properly.</para></note> + <literal>latin1</literal> . You will need to change this parameter in + order for your database to work correctly.</para></note> </section> <section id="sect-Reference_Guide-Database_Configuration-JCR_database_configuration"> @@ -42,9 +42,11 @@ <para>To configure the database used by JCR you will need to edit the datasource descriptor located at - $JBOSS_HOME/server/default/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&lt;/connection-url&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; @@ -55,19 +57,20 @@ &lt;prepared-statement-cache-size&gt;32&lt;/prepared-statement-cache-size&gt; &lt;/no-tx-datasource&gt;</programlisting></para> - <para>And edit the values of driver-class, connection-url, usern-ame and - password with the values for your database (Please refer to your database + <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> - <para>In the case of HSQL the databases are created automatically, for any - other database you will need to create a database.</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> + <para>Make sure the user has rights to create tables on the database and - to update them as during the first startup they will be automatically + to update them as, during the first startup, they will be automatically created.</para> - <para>Also add the JDBC driver into the classpath, for instance in - $JBOSS_HOME/server/default/lib</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> </section> @@ -75,16 +78,18 @@ <section> <title>Configuring the database for the default identity store</title> - <para>By default users are stored in database. To change the database to - store users, you will need to edit the file:</para> + <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><programlisting>$JBOSS_HOME/server/default/deploy/gatein-ds.xml</programlisting></para> + <para><programlisting>$JBOSS_HOME/server/<remark>$CONFIG</remark>/deploy/gatein-ds.xml</programlisting></para> - <para>You will find the same kind of configuration as For JCR:</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; - &lt;connection-url&gt;jdbc:hsqldb:${jboss.server.data.dir}${/}gatein${/}hypersonic${/}gatein-jcr-localDB&lt;/connection-url&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; @@ -161,8 +166,13 @@ </listitem> <listitem> <para> - Use the <command>CREATE DATABASE</command> command to create a new gateinjcr database. Note: the rest of this guide, and configuration examples following here after, assume the database names to be gatein-jcr and gatein-idm. If you change the database names, please change the name in all gatein-dsl.xml: + Use the <command>CREATE DATABASE</command> command to create a new gateinjcr database. </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). + </para> + </note> <para> <screen> mysql&gt; CREATE DATABASE gatein-idm; @@ -217,7 +227,7 @@ IDENTIFIED BY &#39;<replaceable>gateinpassword</replaceable>&#39; WITH GRANT OPTION; </screen> </para> - <note><title>Note: Changed Password?</title> + <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> @@ -247,9 +257,14 @@ <itemizedlist> <listitem> <para> - In this example the database name is <literal>gateinjcr</literal>. (And <literal>gateinidm</literal> for the other datasource) + In this example the database name is <literal>gateinjcr</literal> for the first datasource listed in <filename>gatein-ds.xml</filename>. </para> </listitem> + <listitem> + <para> + The database name for the second datasource is <literal>gateinidm</literal>. See the example <filename>gatein-ds.xml</filename> file provided. + </para> + </listitem> </itemizedlist> </para> </listitem> @@ -267,11 +282,11 @@ </listitem> <listitem> <para> - <computeroutput>&lt;password&gt;<replaceable>gateinpassword</replaceable>&lt;/password&gt;</computeroutput>; + <computeroutput>&lt;password&gt;<replaceable>PASSWORD</replaceable>&lt;/password&gt;</computeroutput>; <itemizedlist> <listitem> <para> - This example uses the <literal>portalpassword</literal> password. Enter this or the password chosen at <xref linkend="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"></xref>. + This example uses the <literal>gateinpassword</literal> password. Enter this or the password chosen at <xref linkend="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"></xref>. </para> </listitem> </itemizedlist> 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-04-16 07:16:34 UTC (rev 2673) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/EMailServiceConfiguration.xml 2010-04-16 07:41:09 UTC (rev 2674) @@ -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/default/conf/gatein/configuration.properties</para> + $JBOSS_HOME/server/<remark>$CONFIG</remark>/conf/gatein/configuration.properties</para> <para>The relevant section looks like:</para> @@ -34,11 +34,11 @@ gatein.email.smtp.socketFactory.port=465 gatein.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory</programlisting> - <para>It is preconfigured for GMail, so that any GMail account can easily be used (simply use the full GMail address - as username, and fill-in the password.</para> + <para>The email service is preconfigured for GMail, so that any GMail account can be used with minimal configuration. Simply enter the full GMail address + as the username and fill in the corresponding password.</para> <para>In corporate environments you will want to use your corporate SMTP gateway. When using it over SSL, - like in default configuration, you may need to configure a certificate truststore, containing your SMTP server's + such as in the default configuration, you may need to configure a certificate truststore containing your SMTP server's public certificate. Depending on the key sizes, you may then also need to install Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files for your Java Runtime Environment.</para> </section> 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-04-16 07:16:34 UTC (rev 2673) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml 2010-04-16 07:41:09 UTC (rev 2674) @@ -15,16 +15,18 @@ <section id="Pre_Requisites-EAP"> <title>Enterprise Application Platform</title> <para>The Enterprise Portal Platform 5.0 is built upon the Enterprise Application Platform 5.0. - For more details about the underlying platform such as difference between the 4.3 and 5.0 versions, please refer to + For more details about the underlying platform such as the difference between the 4.3 and 5.0 versions, please refer to the EAP installation guide available at: <ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Application_P... </para> </section> <section id="Pre_Requisites-Hardware_and_Operating_System_Requirements"> <title>System Requirements</title> + <para><remark>Add hardware requirements as per this section of this doc?</remark></para> + <para><ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Application_P... <para>For the latest information on supported Operating System / JVM combinations and supported Database platforms, please refer to <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura...;. </para> <para> - The following is a list of certified operating systems and JVM version combination: + The following is a list of certified operating systems and JVM version combinations: </para> <indexterm> <primary>System Requirements</primary> @@ -37,7 +39,8 @@ <tgroup cols="2"> <colspec colnum="1" colname="OS" colwidth="1*"></colspec> <colspec colnum="2" colname="JVM" colwidth="1*"></colspec> - <tbody> + + <thead> <row> <entry> <emphasis>Operating System</emphasis> @@ -46,6 +49,8 @@ <emphasis>JVM Version</emphasis> </entry> </row> + </thead> + <tbody> <row> <entry> RHEL 5 x86 @@ -141,7 +146,7 @@ <tgroup cols="2"> <colspec colnum="1" colname="DB" colwidth="1*"></colspec> <colspec colnum="2" colname="DB_driver" colwidth="1*"></colspec> - <tbody> + <thead> <row> <entry> <emphasis>Database</emphasis> @@ -150,6 +155,8 @@ <emphasis>Database driver</emphasis> </entry> </row> + </thead> + <tbody> <row> <entry> MySQL 5.1 @@ -248,12 +255,14 @@ <tgroup cols="1"> <colspec colnum="1" colname="LDAP" colwidth="1*"></colspec> - <tbody> + <thead> <row> <entry> <emphasis>Directory Server</emphasis> </entry> </row> + </thead> + <tbody> <row> <entry> OpenDS 1.2 @@ -469,7 +478,7 @@ </programlisting> <para> - Make sure the Sun version [<literal>jre-1.6.0-sun</literal> in this case] is selected (marked with a &#39;+&#39; in the output), or select it by entering its number as prompted. + Make sure the Sun version - <literal>jre-1.6.0-sun</literal> in this case - is selected (marked with a &#39;+&#39; in the output), or select it by entering its number as prompted. </para> </listitem> <listitem> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml 2010-04-16 07:16:34 UTC (rev 2673) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml 2010-04-16 07:41:09 UTC (rev 2674) @@ -20,7 +20,7 @@ <para> To install from a zip file, simply unzip the downloaded file to a directory of your choice. You can unzip the platform on any operating system that supports the zip format. Six types of server configurations will be included in your installation - minimal, default, production, all, standard and web. - The Getting Started Guide of &JBEAP; explain in detail the different server configuration file sets. + The Getting Started Guide of &JBEAP; explains in detail the different server configuration file sets. <itemizedlist> <listitem> @@ -42,7 +42,7 @@ <section id="server-config-differences"> <title>Choosing a server configuration</title> <para> - The important differences as far as Portal is concerned are: + The important differences between the Portal and &JBEAP; server configurations are: <itemizedlist> <listitem> @@ -52,7 +52,7 @@ </listitem> <listitem> <para> - the <literal>default</literal> server configuration includes non-clustered Portal components. This archive (gatein.ear) is located in the <literal>deploy</literal> folder. <remark>This is the server configuration that is started when no other configuration is specified</remark> + the <literal>default</literal> server configuration includes non-clustered Portal components. <!-- This archive (gatein.ear) is located in the <literal>deploy</literal> folder. --><remark>This is the server configuration that is started when no other configuration is specified</remark> </para> </listitem> <listitem> @@ -62,11 +62,17 @@ </listitem> <listitem> <para> - the <literal>production</literal> server configuration includes Portal component and clustering services. It is preconfigured with default settings which would be more accurate for a production environment. + the <literal>production</literal> server configuration includes Portal components and clustering services. It is preconfigured with default settings which would be more accurate for a production environment. </para> </listitem> </itemizedlist> </para> + <para><remark>Added the note below to account for all gatein.ear archives.</remark></para> + <note><title>Note: gatein.ear archive</title> + <para> + The getein.ear archive, which contains the Portal components, is located in the deploy folder of the <literal>default</literal>, <literal>all</literal> and <literal>production</literal> server configurations. + </para> + </note> </section> </chapter> 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-04-16 07:16:34 UTC (rev 2673) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml 2010-04-16 07:41:09 UTC (rev 2674) @@ -28,19 +28,45 @@ On Microsoft Windows </title> <para> - Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: C:\Program Files\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: C:\Program Files\jboss-epp-5.0\jboss-as\bin. To do this, open the Control Panel from the Start Menu, switch to Classic View if necessary, open the System Control Panel applet, select the Advanced Tab, and click on the Environment Variables button. + Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: C:\Program Files\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:\Program Files\jboss-epp-5.0\jboss-as\bin</literal>. To do this: + <orderedlist> + <listitem> + <para> + Open the Control Panel from the Start Menu, switching to Classic View if necessary. + </para> + </listitem> + <listitem> + <para> + Open the System Control Panel applet. + </para> + </listitem> + <listitem> + <para> + Select the Advanced Tab + </para> + </listitem> + <listitem> + <para> + Click on the Environment Variables button. + </para> + </listitem> + </orderedlist> </para> </formalpara> </section> <section id="Adjust_Memory_Settings"> <title>Adjust memory settings</title> + <para> + The server will start in the <literal><remark>default</remark></literal> configuration when started without specifying a configuration (such as by passing <command>-c &lt;configuration&gt;</command> to the run script). <remark>It is recommended that large applications be run using the <literal>production</literal> configuration.</remark> + </para> + <para><remark>Note to Reviewer</remark></para> + <para> + When I run the server without specifying a configuration parameter I get <screen>16:20:52,778 INFO [ServerImpl] Server Name: default</screen> + </para> + <para><remark>End Note to Reviewer</remark></para> <para> - The default configuration for the server to start with, if no other configuration is specified, is the production configuration. - </para> - <para> - To avoid memory issues, 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>. Those are the default values - and are usually sufficient: + In the event of memory issues, 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>. The default values listed in the sample below are usually sufficient: <programlisting> -Xms1303m -Xmx1303m -XX:MaxPermSize=256m .... </programlisting> @@ -58,7 +84,7 @@ </para> <important><title>Default admin user configuration</title> <para> - It is recommended that the admin=admin username and password configuration, which is commented out by default, not be used for a production server. The admin user is included as an example of the user/password definition format only. + It is recommended that the admin=admin username and password configuration, which is commented out by default, not be used for a production server. The admin user is included as an example of the username/password definition format only. </para> </important> @@ -96,12 +122,10 @@ <formalpara> <title>Set SuckerPassword for JBoss Messaging:</title> <para> - JBoss Messaging makes internal connections between nodes in order to redistribute messages between clustered destinations. These connections are made with the user name of a special reserved user whose password is specified by this parameter <literal>SuckerPassword</literal> in the Server Peer configuration file: - <programlisting> - <remark>$JBOSS_HOME/server/$CONFIG/deploy/messaging/messaging-jboss-beans.xml</remark> - </programlisting> + JBoss Messaging makes internal connections between nodes in order to redistribute messages between clustered destinations. These connections are made with the user name of a special reserved user whose password is specified by the <literal>suckerPassword</literal> attribute in the Server Peer configuration file: + <programlisting>$JBOSS_HOME/server/$CONFIG/deploy/messaging/messaging-jboss-beans.xml</programlisting> Where <literal>$JBOSS_HOME</literal> is the install directory and <literal>$CONFIG</literal> is the server configuration being used. - To avoid a security risk, you MUST specify the value of the attribute <literal>SuckerPassword</literal>, failing which the default value will be used. Any one who knows the default password will be able to gain access to any destinations on the server. The following fragment should be uncommented and modified: + To avoid a security risk, you MUST specify the value of the <literal>SuckerPassword</literal> attribute, failing which the default value will be used. Any one who knows the default password will be able to gain access to any destinations on the server. The following fragment should be uncommented and modified: <programlisting>&lt;bean name="SecurityStore" class="org.jboss.jms.server.jbosssx.JBossASSecurityMetadataStore"&gt; &lt;!­­ default security configuration ­­­&gt; @@ -116,13 +140,27 @@ </programlisting> </para> </formalpara> + <para><remark>Note to Reviewer</remark></para> + <para> + <filename>/server/$CONFIG/deploy/messaging/messaging-service.xml</filename> + </para> + <screen>&lt;!-- The password used by the message sucker connections to create connections. + THIS SHOULD ALWAYS BE CHANGED AT INSTALL TIME TO SECURE SYSTEM + &lt;attribute name="SuckerPassword"&gt;&lt;/attribute&gt;</screen> + <para> + Question 1: Should this file also have the SuckerPassword set? + </para> + <para> + Question 2: Should I document this? + </para> + <para><remark>End Note to Reviewer</remark></para> </section> <section id="Disabling_Authentication"> <title>Disabling Authentication</title> <para> - By default, authentication is disabled, if enabled here are the explanations to turn them off again. - All specified paths in the sections below are relative to <literal>$JBOSS_HOME</literal>. + Authentication is disabled by default. Once enabled, it is possible to disable authentication for specific services by following the instructions in this section. + All paths specified in the sub-sections below are relative to <literal>$JBOSS_HOME</literal>. </para> <formalpara> <title>Disabling Authentication for JXM Console:</title> 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-16 07:16:34 UTC (rev 2673) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Test_Your_Installation.xml 2010-04-16 07:41:09 UTC (rev 2674) @@ -68,9 +68,9 @@ ... 16:59:44,345 INFO [JMXKernel] Legacy JMX core initialized </programlisting> - <note> + <note><title>Note: Production server log file</title> <para> - Note that there is no "Server Started" message shown at the console when the server is started using the <literal>production</literal> profile. This message may be observed in the <filename>server.log</filename> file located in the <filename>server/production/log</filename> subdirectory. + There is no "Server Started" message shown at the console when the server is started using the <literal>production</literal> profile. This message may be observed in the <filename>server.log</filename> file located in the <filename>server/production/log</filename> subdirectory. </para> </note> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Uninstall_JBoss.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Uninstall_JBoss.xml 2010-04-16 07:16:34 UTC (rev 2673) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Uninstall_JBoss.xml 2010-04-16 07:41:09 UTC (rev 2674) @@ -5,9 +5,9 @@ ]> <chapter id="Uninstall_JBoss"> - <title>Uninstall EPP</title> + <title>Uninstall &PRODUCT;</title> <para> - As JBoss Enterprise Portal Platform was installed from a zipfile, you may uninstall it by simply deleting the &PRODUCT; installed directory. + As JBoss Enterprise Portal Platform was installed from a zip file, you may uninstall it by simply deleting the &PRODUCT; directory installed on your system. </para> </chapter>