Author: thomas.heute(a)jboss.com Date: 2010-04-15 08:15:31 -0400 (Thu, 15 Apr 2010) New Revision: 2655 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/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/Introduction.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/Uninstall_JBoss.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/pom.xml Log: Updating Installation guide 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-15 12:14:27 UTC (rev 2654) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/ClusteringConfiguration.xml 2010-04-15 12:15:31 UTC (rev 2655) @@ -5,6 +5,14 @@ ]> <section id="sect-Reference_Guide-Clustering_Configuration"> <title>Clustering Configuration</title> + <indexterm> + <primary>Configuration</primary> + <secondary>Clustering</secondary> + </indexterm> + <indexterm> + <primary>Clustering</primary> + <secondary>Configuration</secondary> + </indexterm> <section id="sect-Reference_Guide-Clustering_Configuration-Overview"> <title>Overview</title> 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-15 12:14:27 UTC (rev 2654) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/DatabaseConfiguration.xml 2010-04-15 12:15:31 UTC (rev 2655) @@ -5,7 +5,14 @@ ]> <section id="sect-Reference_Guide-Database_Configuration"> <title>Database Configuration</title> - + <indexterm> + <primary>Configuration</primary> + <secondary>Database</secondary> + </indexterm> + <indexterm> + <primary>Database</primary> + <secondary>Configuration</secondary> + </indexterm> <section id="sect-Reference_Guide-Database_Configuration-Overview"> <title>Overview</title> @@ -94,13 +101,23 @@ </section> <section> - <title>Example with MySQL</title> - <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> - </formalpara> + <title>Example with MySQL</title> + + <indexterm> + <primary>Configuration</primary> + <secondary>MySQL</secondary> + </indexterm> + <indexterm> + <primary>Database</primary> + <secondary>MySQL</secondary> + </indexterm> + <indexterm> + <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> + </formalpara> <orderedlist> <listitem> 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-15 12:14:27 UTC (rev 2654) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Getting_Started.xml 2010-04-15 12:15:31 UTC (rev 2655) @@ -9,25 +9,27 @@ <section id="Getting_Started-Pre_Requisites"> <title>Pre-Requisites</title> <para> - You must have adequate disk space<!--TODO how much --> to install JDK and &PRODUCT; while also allowing enough space for your applications. Before installing &PRODUCT; you must have a working installation of Java. Since JBoss is 100% pure Java you can have it working on any Operating System / Platform that supports Java. However, there are a few Operating System-specific issues that you should be aware of. Refer to <ulink url="http://www.jboss.org/community/docs/DOC-10687"></uli... for more information. + You must have adequate disk space to install a JDK and &PRODUCT; (550MB) while also allowing enough space for your applications. Before installing &PRODUCT; you must have a working installation of Java. Since JBoss is 100% pure Java you can have it working on any Operating System / Platform that supports Java. + However, only some combinations are certified (tested prior to shipping) or supported (on which you can open support tickets), the certified combinations are listed below. </para> <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 - the EAP installation guide available at: <ulink url="http://www.redhat.com/docs/en-US/JBoss_Enterprise_Application_P... - + 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>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: </para> - + <indexterm> + <primary>System Requirements</primary> + <secondary>OS/JVM</secondary> + </indexterm> <table> <title> Supported Operating System / JVM Combinations. @@ -123,7 +125,14 @@ <para> The following is a list of supported databases and database drivers: </para> - + <indexterm> + <primary>System Requirements</primary> + <secondary>Database</secondary> + </indexterm> + <indexterm> + <primary>Database</primary> + <secondary>System Requirements</secondary> + </indexterm> <table> <title> Supported and Certified Database / Database driver Combinations. @@ -224,7 +233,10 @@ </tbody> </tgroup> </table> - + <indexterm> + <primary>System Requirements</primary> + <secondary>Directory server</secondary> + </indexterm> <para> The following is a list of supported directory servers: </para> @@ -314,10 +326,8 @@ <para> Java SDKs are provided by the Red Hat Enterprise Linux 5 Base and Supplementary channels for your Linux variant and architecture. The available JDKs corresponding to each channel and architecture are listed below: </para> - <para> - - </para> - <variablelist><title></title> + <variablelist> + <title>RHEL 5 Java SDKs</title> <varlistentry> <term> Channel: rhel-&lt;arch&gt;-server-5 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-15 12:14:27 UTC (rev 2654) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Installation.xml 2010-04-15 12:15:31 UTC (rev 2655) @@ -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; as well as http://www.jboss.org/community/docs/DOC-12942 explain in detail the different server configuration file sets. + The Getting Started Guide of &JBEAP; explain in detail the different server configuration file sets. <itemizedlist> <listitem> 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-15 12:14:27 UTC (rev 2654) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Introduction.xml 2010-04-15 12:15:31 UTC (rev 2655) @@ -15,28 +15,7 @@ Because it is Java-based, &PRODUCT; is cross-platform and easy to install and use on any operating system that supports Java. The readily available source code is a powerful learning tool to debug the server and understand it. It also gives you the flexibility to create customized versions for your personal or business use. </para> <para> - Installing &PRODUCT; is simple and easy. You can have it installed and running in no time. This guide will teach you to install and uninstall JBoss.<!--: <itemizedlist> - <listitem> - <para> - How to install &PRODUCT; - </para> - </listitem> - <listitem> - <para> - How to Start and Stop your JBoss AS instance - </para> - </listitem> - <listitem> - <para> - The Directory structure - </para> - </listitem> - <listitem> - <para> - The key services and configuration files - </para> - </listitem> - </itemizedlist>--> + Installing &PRODUCT; is simple and easy. You can have it installed and running in no time. This guide will teach you to install and uninstall it. </para> <section id="Introduction-Other_Manuals"> <title>Other Manuals</title> @@ -45,6 +24,5 @@ <!--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/Post_Installation.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml 2010-04-15 12:14:27 UTC (rev 2654) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Post_Installation.xml 2010-04-15 12:15:31 UTC (rev 2655) @@ -9,7 +9,6 @@ <title> Set JBOSS_HOME Environment Variable </title> - <para><remark>Minor edit changed 4.3 to 5.0 in path to installation directory.</remark></para> <formalpara> <title> On a Linux Platform @@ -37,15 +36,15 @@ <section id="Adjust_Memory_Settings"> <title>Adjust memory settings</title> <para> - The default configuration for the server to start with, if no other configuration is specified, is the production configuration. It is recommended to run the example Seam applications that are included with the documentation using the production configuration. + 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> with these recommended values: + 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: <programlisting> -Xms1303m -Xmx1303m -XX:MaxPermSize=256m .... </programlisting> </para> - <para><remark>This is the default so the "adjust" statement is not correct. Should it be set higher than 256m?</remark></para> </section> @@ -99,39 +98,31 @@ <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-service.xml</remark> + <remark>$JBOSS_HOME/server/$CONFIG/deploy/messaging/messaging-jboss-beans.xml</remark> </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: - <programlisting> - &lt;mbean code="org.jboss.jms.server.ServerPeer" - name="jboss.messaging:service=ServerPeer" - xmbean-dd="xmdesc/ServerPeer-xmbean.xml"&gt; - ... - ... - ... - ... - &lt;!-- The password used by the message sucker connections to create connections. - THIS SHOULD ALWAYS BE CHANGED AT INSTALL TIME TO SECURE SYSTEM --&gt; - &lt;attribute name="SuckerPassword"&gt;&lt;/attribute&gt; - ... - ... - ... - &lt;/mbean&gt; - </programlisting> + <programlisting>&lt;bean name="SecurityStore" +class="org.jboss.jms.server.jbosssx.JBossASSecurityMetadataStore"&gt; + &lt;!­­ default security configuration ­­­&gt; + ­... + ­... + ­... + &lt;property name="suckerPassword"&gt;CHANGE ME!!&lt;/property&gt; + ­... + ­... + ­... +&lt;/bean&gt; +</programlisting> </para> </formalpara> - <para><remark>Note to Reviewer</remark></para> - <para>edit $JBOSS_HOME/server/$CONFIG/deploy/messaging/messaging-jboss-beans.xml as well?</para> - <para><literal>&lt;property name="suckerPassword"&gt;CHANGE ME!!&lt;/property&gt;</literal></para> - <para><remark>End Note to Reviewer</remark></para> </section> <section id="Disabling_Authentication"> <title>Disabling Authentication</title> - <para><remark>No changes here as all paths and files are the same</remark></para> <para> - It is also possible to disable authentication on specific services. All specified paths in the sections below are relative to <literal>$JBOSS_HOME</literal>. + 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>. </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/Uninstall_JBoss.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Uninstall_JBoss.xml 2010-04-15 12:14:27 UTC (rev 2654) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/en-US/Uninstall_JBoss.xml 2010-04-15 12:15:31 UTC (rev 2655) @@ -5,7 +5,7 @@ ]> <chapter id="Uninstall_JBoss"> - <title>Uninstall JBoss</title> + <title>Uninstall EPP</title> <para> As JBoss Enterprise Portal Platform was installed from a zipfile, you may uninstall it by simply deleting the &PRODUCT; installed directory. </para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/pom.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/pom.xml 2010-04-15 12:14:27 UTC (rev 2654) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide/pom.xml 2010-04-15 12:15:31 UTC (rev 2655) @@ -3,9 +3,9 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> - <groupId>org.exoplatform.portal</groupId> - <artifactId>exo.portal.parent</artifactId> - <version>3.0.1-GA-SNAPSHOT</version> + <groupId>dummy</groupId> + <artifactId>dummy</artifactId> + <version>0-SNAPSHOT</version> <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name>