Author: smumford Date: 2011-11-14 17:10:59 -0500 (Mon, 14 Nov 2011) New Revision: 8057 Modified: epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xml epp/docs/branches/5.2/Installation_Guide/en-US/Post_Installation.xml Log: JBEPP-1360: Actioned feedback from mvanco Modified: epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml 2011-11-14 19:39:35 UTC (rev 8056) +++ epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml 2011-11-14 22:10:59 UTC (rev 8057) @@ -110,9 +110,14 @@ gatein.jcr.data.dir=${gatein.data.dir}/jcr gatein.jcr.storage.data.dir=${gatein.jcr.data.dir}/values +gatein.jcr.cache.config=war:/conf/jcr/jbosscache/${gatein.jcr.config.type}/config.xml +gatein.jcr.lock.cache.config=war:/conf/jcr/jbosscache/${gatein.jcr.config.type}/lock-config.xml gatein.jcr.index.data.dir=${gatein.jcr.data.dir}/lucene gatein.jcr.index.changefilterclass=org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter - +gatein.jcr.index.cache.config=war:/conf/jcr/jbosscache/cluster/indexer-config.xml +gatein.jcr.jgroups.config=classpath:/jgroups/gatein-${gatein.default.jgroups.stack:udp}.xml +gatein.jcr.workspace.default=collaboration +gatein.jcr.workspace.system=system [...]</programlisting> </para> </section> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xml 2011-11-14 19:39:35 UTC (rev 8056) +++ epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xml 2011-11-14 22:10:59 UTC (rev 8057) @@ -16,9 +16,9 @@ <section id="sect-Reference_Guide-Database_Configuration-Overview"> <title>Overview</title> - <para> - A Java Database Connectivity (JDBC) connector/driver is required for JBoss Enterprise Portal Platform to communicate with a relational database management system (RDBMS). JBoss Enterprise Portal Platform comes bundled with the Hypersonic SQL (HSQL) database in order for users to get up and running quickly without having to initially set up a database and the server. However, HSQL should not be used in a production environment and Red Hat does not offer ANY support for it. Therefore we recommend to setup a RDBMS and JBoss Enterprise Portal Platform connect to it as follows: - </para> + <para> + A Java Database Connectivity (JDBC) connector/driver is required for JBoss Enterprise Portal Platform to communicate with a relational database management system (RDBMS). JBoss Enterprise Portal Platform comes bundled with the Hypersonic SQL (HSQL) database in order for users to get up and running quickly without having to initially set up a database and the server. However, HSQL should not be used in a production environment and Red Hat does not offer ANY support for it. Therefore we recommend to setup a RDBMS and JBoss Enterprise Portal Platform connect to it as follows: + </para> <para>JBoss Enterprise Portal Platform has two different database dependencies. One is the identity service configuration, which depends on Hibernate. The other @@ -41,7 +41,7 @@ datasource descriptor located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein-ds.xml</filename>: <programlisting language="XML" role="XML"> -&lt;no-tx-datasource&gt; +&lt;local-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 @@ -54,7 +54,7 @@ &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; +&lt;/local-tx-datasource&gt; </programlisting> </para> @@ -82,7 +82,7 @@ datasource descriptor located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein-ds.xml</filename>: <programlisting language="XML" role="XML"> -&lt;no-tx-datasource&gt; +&lt;local-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 @@ -95,7 +95,7 @@ &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; +&lt;/local-tx-datasource&gt; </programlisting> </para> @@ -139,53 +139,53 @@ <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Installing_the_MySQL_RDBMS_JDBC_connector"> <title>Installing the MySQL JDBC connector</title> <para>The MySQL JDBC connector is required for EPP to use a <application>MySQL</application> database:</para> - </formalpara> - <para> - The <literal>mysql-java-connector</literal> package is available through <ulink type="http" url="https://www.redhat.com/wapps/sso/rhn/login.html?redirect=http%3... Hat Network</ulink>. This is the recommended installation method. - </para> - <para> - For users who are not able to access the Red Hat Network, <application>MySQL</application> is available directly from <ulink type="http" url="http://www.mysql.com/downloads/connector/j/">http://www...;. You should download a version listed in the Certified Configurations table available on the <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura... Enterprise Portal Platform</ulink> JBoss website. - </para> - - <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"> - <title>Creating a MySQL Database</title> - <para> - If you have just installed MySQL, make sure the MySQL server is running, and then run the following command to set the root user password: - </para> - </formalpara> - <para> + </formalpara> + <para> + The <literal>mysql-java-connector</literal> package is available through <ulink type="http" url="https://www.redhat.com/wapps/sso/rhn/login.html?redirect=http%3... Hat Network</ulink>. This is the recommended installation method. + </para> + <para> + For users who are not able to access the Red Hat Network, <application>MySQL</application> is available directly from <ulink type="http" url="http://www.mysql.com/downloads/connector/j/">http://www...;. You should download a version listed in the Certified Configurations table available on the <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura... Enterprise Portal Platform</ulink> JBoss website. + </para> + + <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"> + <title>Creating a MySQL Database</title> + <para> + If you have just installed MySQL, make sure the MySQL server is running, and then run the following command to set the root user password: + </para> + </formalpara> + <para> <screen> mysqladmin -u root password '<replaceable>new-root-user-password</replaceable>' </screen> - </para> - <orderedlist> - <listitem> - <para> - Run the following command to log in to MySQL. Enter the root user password when prompted: - </para> - <para> + </para> + <orderedlist> + <listitem> + <para> + Run the following command to log in to MySQL. Enter the root user password when prompted: + </para> + <para> <screen> mysql -u root -p </screen> - </para> - </listitem> - <listitem> - <para> - 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 gateinjcr and gateinidm. If you change the database names, please update gatein-ds.xml accordingly (for each server configuration used). - </para> - </note> - <para> + </para> + </listitem> + <listitem> + <para> + 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 gateinjcr and gateinidm. If you change the database names, please update gatein-ds.xml accordingly (for each server configuration used). + </para> + </note> + <para> <screen> mysql&gt; CREATE DATABASE gateinjcr; </screen> - </para> - <para> - The output should be similar to the following: - </para> + </para> + <para> + The output should be similar to the following: + </para> <screen> Query OK, 1 row affected (0.00 sec) </screen> @@ -194,10 +194,10 @@ </para> <screen>mysql&gt; CREATE DATABASE gateinidm; </screen> - <para> - At this point, the <command>SHOW DATABASES;</command> command should display the <command>gatein</command> databases: - </para> - <para> + <para> + At this point, the <command>SHOW DATABASES;</command> command should display the <command>gatein</command> databases: + </para> + <para> <screen> mysql&gt; SHOW DATABASES; +--------------------+ @@ -210,22 +210,22 @@ +--------------------+ 4 rows in set (0.00 sec) </screen> - </para> - <para> - It is safe to ignore the other databases. - </para> - </listitem> - <listitem> - <para> - Add a new user and give that user access to the gatein databases. The following example adds a new user named <computeroutput>gateinuser</computeroutput>, with the password <computeroutput>gateinpassword</computeroutput>. It is recommended that you choose a different password to the one supplied here by changing <replaceable>gateinpassword</replaceable> to some other password: - </para> - <screen>CREATE USER 'gateinuser'@'localhost' IDENTIFIED BY 'gateinpassword';</screen> - </listitem> - <listitem> - <para> - Grant the necessary privileges to the user: - </para> - <para> + </para> + <para> + It is safe to ignore the other databases. + </para> + </listitem> + <listitem> + <para> + Add a new user and give that user access to the gatein databases. The following example adds a new user named <computeroutput>gateinuser</computeroutput>, with the password <computeroutput>gateinpassword</computeroutput>. It is recommended that you choose a different password to the one supplied here by changing <replaceable>gateinpassword</replaceable> to some other password: + </para> + <screen>CREATE USER 'gateinuser'@'localhost' IDENTIFIED BY 'gateinpassword';</screen> + </listitem> + <listitem> + <para> + Grant the necessary privileges to the user: + </para> + <para> <screen> mysql&gt; GRANT ALL PRIVILEGES ON gateinjcr.* TO '<replaceable>gateinuser</replaceable>'@'localhost' IDENTIFIED BY '<replaceable>gateinpassword</replaceable>' WITH GRANT OPTION; @@ -234,82 +234,82 @@ mysql&gt; GRANT ALL PRIVILEGES ON gateinidm.* TO '<replaceable>gateinuser</replaceable>'@'localhost' IDENTIFIED BY '<replaceable>gateinpassword</replaceable>' WITH GRANT OPTION; </screen> - </para> + </para> <!-- - <note><title>Note: Changed password?</title> - <para> - If you changed the portal user's password, remember to also change the password in the MySQL Datasource descriptor. - </para> - </note> + <note><title>Note: Changed password?</title> + <para> + If you changed the portal user's password, remember to also change the password in the MySQL Datasource descriptor. + </para> + </note> --> - </listitem> - </orderedlist> - - <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-MySQL_Datasource_Descriptor"> - <title>MySQL Datasource Descriptor</title> - <para> - We now need to change the portal database descriptor - </para> - </formalpara> - <orderedlist> - <listitem> - <para> - Edit the file located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein-ds.xml</filename>. - </para> - </listitem> - <listitem> - <para> - Update the following lines in the Datasource descriptor to reflect the correct database, username and password respectively: - <itemizedlist> - <listitem> - <para> - <computeroutput>&lt;connection-url&gt;jdbc:mysql://mysql-hostname:3306/<replaceable>DATABASE</replaceable>&lt;/connection-url&gt;</computeroutput>; - <itemizedlist> - <listitem> - <para> - 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> - <listitem> - <para> - <computeroutput>&lt;user-name&gt;<replaceable>USER-NAME</replaceable>&lt;/user-name&gt;</computeroutput>; - <itemizedlist> - <listitem> - <para> - The user-name for this example is <literal>gateinuser</literal>. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <computeroutput>&lt;password&gt;<replaceable>PASSWORD</replaceable>&lt;/password&gt;</computeroutput>; - <itemizedlist> - <listitem> - <para> - 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> - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </orderedlist> - + </listitem> + </orderedlist> + + <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-MySQL_Datasource_Descriptor"> + <title>MySQL Datasource Descriptor</title> + <para> + We now need to change the portal database descriptor + </para> + </formalpara> + <orderedlist> + <listitem> + <para> + Edit the file located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein-ds.xml</filename>. + </para> + </listitem> + <listitem> + <para> + Update the following lines in the Datasource descriptor to reflect the correct database, username and password respectively: + <itemizedlist> + <listitem> + <para> + <computeroutput>&lt;connection-url&gt;jdbc:mysql://mysql-hostname:3306/<replaceable>DATABASE</replaceable>&lt;/connection-url&gt;</computeroutput>; + <itemizedlist> + <listitem> + <para> + 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> + <listitem> + <para> + <computeroutput>&lt;user-name&gt;<replaceable>USER-NAME</replaceable>&lt;/user-name&gt;</computeroutput>; + <itemizedlist> + <listitem> + <para> + The user-name for this example is <literal>gateinuser</literal>. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <computeroutput>&lt;password&gt;<replaceable>PASSWORD</replaceable>&lt;/password&gt;</computeroutput>; + <itemizedlist> + <listitem> + <para> + 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> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </orderedlist> + <para><filename>gatein-ds.xml</filename> will then look like:</para> <programlisting language="XML" role="XML"><![CDATA[<datasources> - <no-tx-datasource> + <local-tx-datasource> <jndi-name>gatein-idm</jndi-name> <connection-url>jdbc:mysql://mysql-hostname:3306/gateinidm</connection-url> <driver-class>com.mysql.jdbc.Driver</driver-class> @@ -320,9 +320,9 @@ <max-pool-size>20</max-pool-size> <idle-timeout-minutes>0</idle-timeout-minutes> <prepared-statement-cache-size>32</prepared-statement-cache-size> - </no-tx-datasource> + </local-tx-datasource> - <no-tx-datasource> + <local-tx-datasource> <jndi-name>gatein-jcr</jndi-name> <connection-url>jdbc:mysql://mysql-hostname:3306/gateinjcr</connection-url> <driver-class>com.mysql.jdbc.Driver</driver-class> @@ -333,16 +333,16 @@ <max-pool-size>20</max-pool-size> <idle-timeout-minutes>0</idle-timeout-minutes> <prepared-statement-cache-size>32</prepared-statement-cache-size> - </no-tx-datasource> + </local-tx-datasource> </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> + <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> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Post_Installation.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Post_Installation.xml 2011-11-14 19:39:35 UTC (rev 8056) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Post_Installation.xml 2011-11-14 22:10:59 UTC (rev 8057) @@ -204,7 +204,7 @@ <formalpara> <title>Disabling Authentication for HTTP Invoker:</title> <para> - To disable authentication for the http invoker, <literal>JNDIFactory</literal>, <literal>EJBInvokerServlet</literal>, and <literal>JMXInvokerServlet</literal> need to be removed from the security realm in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml/deploy/httpha-invoker.sar/invoker.war/WEB-INF/web.xml</filename> file: + To disable authentication for the http invoker, <literal>JNDIFactory</literal>, <literal>EJBInvokerServlet</literal>, and <literal>JMXInvokerServlet</literal> need to be removed from the security realm in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/httpha-invoker.sar/invoker.war/WEB-INF/web.xml</filename> file: <programlisting language="XML" role="XML"> &lt;security-constraint&gt; &lt;web-resource-collection&gt; @@ -226,7 +226,7 @@ <formalpara> <title>Disabling Authentication for JMX Invoker:</title> <para> - To disable authentication for the JMX invoker, edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml/deploy/httpha-invoker.sar/invoker.war/WEB-INF/web.xml/deploy/jmx-invoker-service.xml</filename> file to comment out the security interceptor passthrough: + To disable authentication for the JMX invoker, edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/jmx-invoker-service.xml</filename> file to comment out the security interceptor passthrough: </para> </formalpara> <para>