[gatein-commits] gatein SVN: r8468 - in epp/docs/branches/5.2/Installation_Guide/en-US: images and 1 other directory.

Author: jaredmorgs Date: 2012-02-26 23:11:22 -0500 (Sun, 26 Feb 2012) New Revision: 8468 Added: epp/docs/branches/5.2/Installation_Guide/en-US/SP_Installation.xml epp/docs/branches/5.2/Installation_Guide/en-US/images/ecmdemo.png epp/docs/branches/5.2/Installation_Guide/en-US/images/epp-sp-homepage.png Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml 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/EMailServiceConfiguration.xml epp/docs/branches/5.2/Installation_Guide/en-US/GadgetProxyConfig.xml epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml epp/docs/branches/5.2/Installation_Guide/en-US/Installation.xml epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml epp/docs/branches/5.2/Installation_Guide/en-US/Post_Installation.xml epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml epp/docs/branches/5.2/Installation_Guide/en-US/Test_Your_Installation.xml Log: Incorporated changes to https://bugzilla.redhat.com/show_bug.cgi?id=741683. Site Publisher Installation Guide is deprecated as part of this fix. Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.2</productnumber> <edition>5.2.1</edition> - <pubsnumber>2</pubsnumber> + <pubsnumber>3</pubsnumber> <abstract> <para> This book provides information about obtaining, installing and running JBoss Enterprise Portal Platform. It forms part of the complete document suite along with the <emphasis role="bold">User Guide</emphasis> and <emphasis role="bold">Reference Guide</emphasis> available at <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... type="http"/>. Modified: epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/ClusteringConfiguration.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -1,19 +1,10 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> %BOOK_ENTITIES; ]> <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> <para>JBoss Enterprise Portal Platform has been developed to support high availability and high horizontal and vertical scalability. @@ -21,81 +12,81 @@ JBoss Enterprise Application Platform and JBoss Cache would be required in order to configure the optimal settings. </para> </section> - <section id="sect-Reference_Guide-Clustering_Configuration-Prerequisite"> <title>Prerequisites</title> - <para>The clustering services are available only in the <literal>all</literal> + <para>The clustering services are available only in the <literal>all</literal> and <literal>production</literal> server configurations. Additionally the following prerequisites should be met: </para> <itemizedlist> <listitem> <para> - a rapid shared file system is required such as a Storage Area Network (SAN) and; + A rapid shared file system is required such as a Storage Area Network (SAN). </para> </listitem> <listitem> - <para> - databases should be shared among the various nodes of the cluster and configured to point to the same instances. + <para>Databases should be shared among the cluster nodes. </para> </listitem> + <listitem> + <para>All cluster nodes should be configured to point to the shared databases. </para> + </listitem> </itemizedlist> </section> - <section id="sect-Reference_Guide-Clustering_Properties"> - <title>configuration.properties</title> - <para>Edit the following entries in the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/gatein/configuration.properties</filename> file:</para> - <itemizedlist> - <listitem> - <para> + <title>Configuration Properties</title> + <para>Edit the following entries in the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename> file:</para> + <itemizedlist> + <listitem> + <para> <literal>gatein.jcr.storage.data.dir;</literal> <itemizedlist> - <listitem> - <para> - To specify the location of the "value storage". This folder must not be deleted as it contains data required for the portal to run. For more details about "value storage" please refer to the JCR configuration in the JBoss Enterprise Portal Platform Reference Guide available at <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... + <listitem> + <para> + To specify the location of the &quot;value storage&quot;. This folder must not be deleted as it contains data required for the portal to run. For more details about &quot;value storage&quot; please refer to the JCR configuration in the JBoss Enterprise Portal Platform Reference Guide available at <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... type="http"/> </para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <literal>gatein.jcr.index.data.dir;</literal> <itemizedlist> - <listitem> - <para> + <listitem> + <para> To specify the location on a shared file system to store the JCR index. If the directory is deleted, the JCR will recreate the indexes on next start of the server. (This operation may take a very long time, depending on the size of the data stored in the JCR). </para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <literal>gatein.jcr.index.changefilterclass;</literal> <itemizedlist> - <listitem> - <para> + <listitem> + <para> This must be changed to <literal>org.exoplatform.services.jcr.impl.core.query.jbosscache.JBossCacheIndexChangesFilter</literal>. </para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> <literal>gatein.jcr.config.type;</literal> <itemizedlist> - <listitem> - <para> + <listitem> + <para> This must be changed to <literal>cluster</literal>. </para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> </para> - </listitem> - </itemizedlist> - <para> + </listitem> + </itemizedlist> + <para> The default property file would look like the following: <programlisting># gatein.conf.dir=${jboss.server.home.dir}/conf/gatein @@ -122,22 +113,22 @@ [...]</programlisting> </para> </section> - <section id="sect-Reference_Guide-Clustering_Running"> - <title>Running with the cluster profile</title> - <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> + <title>Run the Cluster</title> + <para>To run the portal in high-availability mode, start all nodes with an extra profile configuration as follows:</para> + <formalpara> + <title>In Linux</title> + <para> <programlisting><command>run.sh -c all -Dexo.profiles=cluster</command> </programlisting> </para> - </formalpara> - - <formalpara><title>In Windows</title> -<para> + </formalpara> + <formalpara> + <title>In Windows</title> + <para> <programlisting><command>run.bat -c all -Dexo.profiles=cluster</command> </programlisting> </para> - </formalpara> + </formalpara> </section> </section> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/DatabaseConfiguration.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -9,7 +9,7 @@ <para>JBoss Enterprise Portal Platform ships with the Hypersonic SQL (HSQLDB) database, which allows users to set up a database quickly for testing purposes. </para> <para>HSQLDB must not be used in a production environment because it does not scale effectively, and does not support clustering. It is therefore not a supported database configuration. You must install and configure a supported RDBMS for JBoss Enterprise Portal Platform. </para> - <para>JBoss Enterprise Portal Platform has two different production RDBMS dependencies: </para> + <para>JBoss Enterprise Portal Platform has two production RDBMS dependencies: </para> <itemizedlist> <listitem> <para>Java Content Repository (JCR) service, which depends on the native JDBC API. JCR has the capability to integrate with @@ -24,15 +24,15 @@ <para>You must create a separate database for both the JCR and IDM services. If you do not create a separate database for each service, database table conflicts will occur and JBoss Enterprise Portal Platform will not start.</para> </warning> <warning> - <title>Warning: Do not delete <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/data</filename></title> + <title>Warning: Do not delete <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/data</filename></title> <para> The JCR can store information both in a database and on the file system depending on the configuration of the value storage. Refer to the JBoss Enterprise Portal Platform Reference Guide for more information. </para> <para> - By default, the portal will store information required to run the portal in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/data/gatein/jcr/values/</filename>. + By default, the portal will store information required to run the portal in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/data/gatein/jcr/values/</filename>. </para> <para> - You can change this directory location by editing the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/gatein/configuration.properties</filename> file, the name of the property being: <literal>gatein.jcr.storage.data.dir</literal></para> + You can change this directory location by editing the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename> file, the name of the property being: <literal>gatein.jcr.storage.data.dir</literal></para> </warning> <para>In the case of HSQLDB, databases are created automatically. For production databases, you must first install the database and create a default user so the platform can create the correct database schema when it is first started.</para> <task id="task-Create_Production_Database"> @@ -44,7 +44,7 @@ <title>Prerequisites</title> <itemizedlist> <listitem> - <para>JBoss Enterprise Portal Platform installed, in its default state.</para> + <para>JBoss Enterprise Portal Platform installed.</para> </listitem> <listitem> <para>A JDBC-compliant database installer, from the list of certified databases described at <ulink url="http://www.redhat.com/resourcelibrary/articles/jboss-enterprise... Red Hat Resource Library for JBoss Enterprise Portal Platform</ulink></para> @@ -65,10 +65,10 @@ <para>Create a database that the JCR service will use exclusively.</para> </step> <step> - <para>Create another database that the IDM service will use exclusively.</para> + <para>Create a second database that the IDM service will use exclusively.</para> </step> <step> - <para>Create a database user that has access to both databases, with the following minimum permissions:</para> + <para>Create a database user that has access to all related databases, with the following minimum permissions:</para> <itemizedlist> <listitem> <para>create tables</para> @@ -332,7 +332,7 @@ <orderedlist> <listitem> <para> - Edit the file located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein-ds.xml</filename>. + Edit the file located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein-ds.xml</filename>. </para> </listitem> <listitem> @@ -385,7 +385,7 @@ </listitem> </orderedlist> <para><filename>gatein-ds.xml</filename> will then look like:</para> - <programlisting language="XML" role="XML"><![CDATA[<datasources> + <programlisting language="XML"><![CDATA[<datasources> <no-tx-datasource> <jndi-name>gatein-idm</jndi-name> <connection-url>jdbc:mysql://mysql-hostname:3306/gateinidm</connection-url> @@ -416,7 +416,7 @@ <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. + 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 JBoss Enterprise Application Platform documentation, or contact JBoss Support for assistance. </para> </important> </section> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/EMailServiceConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/EMailServiceConfiguration.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/EMailServiceConfiguration.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -1,30 +1,22 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" -"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-Reference_Guide-EMail_Service_Configuration"> <title>E-Mail Service Configuration</title> - <section id="sect-Reference_Guide-EMail_Service_Configuration-Overview"> <title>Overview</title> - <para>JBoss Enterprise Portal Platform includes an e-mail sending service that needs to be configured - before it can function properly. This service, for instance, is used to send e-mails to users who forgot + before it can function properly. This service, for instance, is used to send E-mails to users who forgot their password or username.</para> - </section> - <section id="sect-Reference_Guide-EMail_Service_Configuration-Parameters"> - <title>Configuring the outgoing e-mail account</title> - + <title>Configure Outgoing E-mail Account</title> <para>The e-mail service can use any SMTP account configured in - <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/gatein/configuration.properties</filename></para> - + <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename></para> <para>The relevant section looks like:</para> - -<programlisting># EMail + <programlisting># EMail gatein.email.smtp.username= gatein.email.smtp.password= gatein.email.smtp.host=smtp.gmail.com @@ -33,12 +25,10 @@ gatein.email.smtp.auth=true gatein.email.smtp.socketFactory.port=465 gatein.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory</programlisting> - <para>The email service is pre-configured 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, - such as in the 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&apos;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: epp/docs/branches/5.2/Installation_Guide/en-US/GadgetProxyConfig.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/GadgetProxyConfig.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/GadgetProxyConfig.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -1,35 +1,33 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> %BOOK_ENTITIES; ]> - <section> - <title>Gadget Proxy Configuration</title> - <section> - <title>Overview</title> - <para> + <title>Gadget Proxy Configuration</title> + <section> + <title>Overview</title> + <para> Gadget consumption requires a local anonymous proxy to route access to elements used by the gadgets. </para> - <para> + <para> This must be done to work around web-browser security mechanisms. </para> - </section> - - <section> - <title>Setup the Filter</title> - <para> + </section> + <section> + <title>Setup the Filter</title> + <para> The anonymous proxy can be setup to accept or refuse certain hosts. </para> - <para> + <para> By default, the proxy is closed to any host except the domain on which the gadget server is installed. </para> - <para> - To modify the filtering of domain names, modify: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/common-configuration.xml</filename> + <para> + To modify the filtering of domain names, modify: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/common/common-configuration.xml</filename> </para> -<example> -<title>common-configuration.xml</title> -<programlisting language="XML" role="XML"><![CDATA[<component> + <example> + <title>common-configuration.xml</title> + <programlisting language="XML" role="XML"><![CDATA[<component> <key>org.exoplatform.web.security.proxy.ProxyFilterService</key> <type>org.exoplatform.web.security.proxy.ProxyFilterService</type> <init-params> @@ -45,22 +43,22 @@ </init-params> </component> ]]> </programlisting> -</example> - <para> + </example> + <para> The proxy will deny access to a resource that is on the blacklist. If the domain name does not match any of the blacklist, the proxy filter will verify if the domain name is on the white list. </para> - <para> + <para> If the domain name is not defined in either the white list or black list, access will be denied. </para> - <para> + <para> Multiple values can be added for each list and wildcards can also be used. </para> - <para> + <para> Below is an example of a valid configuration: </para> -<example> -<title>Valid Proxy Configuration</title> -<programlisting language="XML" role="XML"><![CDATA[<component> + <example> + <title>Valid Proxy Configuration</title> + <programlisting language="XML" role="XML"><![CDATA[<component> <key>org.exoplatform.web.security.proxy.ProxyFilterService</key> <type>org.exoplatform.web.security.proxy.ProxyFilterService</type> <init-params> @@ -77,6 +75,6 @@ </init-params> </component> ]]> </programlisting> -</example> - </section> -</section> \ No newline at end of file + </example> + </section> +</section> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -1,796 +1,357 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> %BOOK_ENTITIES; ]> - <chapter id="Getting_Started"> - <title>Getting Started</title> - - <section id="sect-Installation_Guide-Getting_Started-Upgrading_Previous_Installations"> - <title>Upgrading and Add-ons</title> - <para> - If you currently have an installation of JBoss Enterprise Portal Platform in operation, you should read the notes below to ensure you choose the correct installation/migration path for your circumstances. + <title>Getting Started</title> + <section id="sect-Installation_Guide-Getting_Started-Upgrading_Previous_Installations"> + <title><remark>BZ#741683 </remark>Upgrading and Add-ons</title> + <remark>BZ#741683 - Adjusted section to reflect Site Publisher section in this guide now.</remark> + <para>Read the notes below to ensure you choose the correct installation/migration path for your circumstances. </para> - <important> - <title>Upgrading JBoss Enterprise Portal Platform</title> - <para> - It is possible to upgrade from JBoss Enterprise Portal Platform version 5.1.0 or 5.1.1 to JBoss Enterprise Portal Platform &VZ;. + <para>It is possible to upgrade from JBoss Enterprise Portal Platform version 5.1.0 or 5.1.1 to JBoss Enterprise Portal Platform &VZ;. </para> - <para> - To upgrade, copy any customized configuration files and database settings from your existing JBoss Enterprise Portal Platform installation to the corresponding location of the &VZ; installation. + <para>To upgrade, copy any customized configuration files and database settings from your existing JBoss Enterprise Portal Platform installation to the corresponding location of the &VZ; installation. </para> - </important> - <important> - <title>Add-ons</title> - <para> - The <emphasis role="bold">Site Publisher</emphasis> add-on that is part of the &VZ; release can only be installed into a <emphasis>clean</emphasis> installation of JBoss Enterprise Portal Platform version 5.1 or later. + <para> + The Site Publisher add-on (commonly referred to as Site Publisher) that is part of the &VZ; release can only be installed onto a <emphasis>clean</emphasis> installation of JBoss Enterprise Portal Platform version 5.1 or later. </para> - <itemizedlist> - <listitem> - <para> - It <emphasis role="bold">cannot</emphasis> be installed into a <emphasis>pre-existing</emphasis> and configured JBoss Enterprise Portal Platform installation (that is; a deployment that contains configuration settings or data that is not standard in the release). - </para> - </listitem> - <listitem> - <para> - Likewise, Site Publisher <emphasis role="bold">cannot</emphasis> be installed onto JBoss Enterprise Portal Platform 5.0 or 5.0.1 versions (including installations that include the technical preview release of the Site Publisher extension). - </para> - <para> - You must deploy a new instance of JBoss Enterprise Portal Platform &VZ; in order to use the Site Publisher add-on. - </para> - </listitem> - </itemizedlist> - </important> + <para>If you already have a clean installation of JBoss Enterprise Portal Platform, you can go directly to <xref linkend="Site_Publisher_Installation"/>.</para> + </section> + <section id="Getting_Started-Pre_Requisites"> + <title>Pre-Requisites</title> + <para> + You must have adequate disk space to install a JDK and JBoss Enterprise Portal Platform while also allowing enough space for your applications. Before installing JBoss Enterprise Portal Platform on your operating system, read the following sections to learn about the minimum and recommended operational requirements. </para> + <section id="Pre_Requisites-EAP"> + <title>Enterprise Application Platform</title> + <para>JBoss Enterprise Portal Platform is built upon JBoss Enterprise Application Platform. For more details about the underlying platform, refer to + the JBoss Enterprise Application Platform documentation resources available at: <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_... + </para> </section> - - <section id="Getting_Started-Pre_Requisites"> - <title>Pre-Requisites</title> + <section id="Pre_Requisites-Hardware_and_Operating_System_Requirements"> + <title>System Requirements</title> + <formalpara> + <title>Minimum Installation Requirements</title> <para> - You must have adequate disk space to install a JDK and JBoss Enterprise Portal Platform (about 550MB) while also allowing enough space for your applications. Before installing JBoss Enterprise Portal Platform 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. - </para> - <section id="Pre_Requisites-EAP"> - <title>Enterprise Application Platform</title> - <para>JBoss Enterprise Portal Platform is built upon JBoss Enterprise Application Platform. For more details about the underlying platform please refer to - the EAP installation guide available at: <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_... - </para> - </section> - <section id="Pre_Requisites-Hardware_and_Operating_System_Requirements"> - <title>System Requirements</title> - <formalpara> - <title>Minimum Installation Requirements</title> - <para> The minimum hard disk space required to support the installation of the JBoss Enterprise Portal Platform is about 550MB. Additional space is required for the installation of the JDK upon which the JBoss Application Server depends. The JDK installation size is currently up to 150MB. </para> - </formalpara> - <formalpara> - <title>Minimum Operational Requirements</title> - <para> + </formalpara> + <formalpara> + <title>Minimum Operational Requirements</title> + <para> The minimum hardware required to support an operational JBoss Application Server varies depending on the following: </para> - </formalpara> - <itemizedlist> - <listitem> - <para> + </formalpara> + <itemizedlist> + <listitem> + <para> The size and complexity of the applications being served; </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> The demand placed on the server by the number and frequency of client requests; </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> The server configuration including the selected log files, their designated size and general server tuning. </para> - </listitem> - </itemizedlist> - <para> + </listitem> + </itemizedlist> + <para> The following discussion relates to the deployment of a simple application on a server experiencing minimal demand. In view of this, the absolute minimum requirements for an operational server are: </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Disk Space: 1.5 GB </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> The default server log file storage configuration is 500MB. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> 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> - </listitem> - <listitem> - <para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> CPU: Intel Pentium Processor @ 1GHz </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Core 2 Duo, Core 2 Quad and Intel Xeon chips will improve the performance of servers which experience high demand. </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> RAM: 1.5 GB </para> - <itemizedlist> - <listitem> - <para> + <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. 4 GB or more is preferable for larger applications or to run a GUI server interface. </para> - </listitem> - </itemizedlist> - </listitem> - </itemizedlist> - <important> - <para> - A server's performance must be viewed in light of the applications deployed on the server, the demand placed on the server by client requests and any post-installation server configuration or tuning. + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + <important> + <para> + A server&apos;s performance must be viewed in light of the applications deployed on the server, the demand placed on the server by client requests and any post-installation server configuration or tuning. </para> - </important> - <formalpara> - <title>Supported Installations</title> - <para> - For the latest information on supported Operating System / JVM combinations and supported Database platforms, please always refer to <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura...;. + </important> + <formalpara> + <title>Supported Installations</title> + <para> + For the latest information on supported Operating System / JVM combinations and supported Database platforms, refer to <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura...;. </para> - </formalpara> - <para> + </formalpara> + <para> The following is a list of certified operating systems and JVM version combinations: </para> - <indexterm> - <primary>System Requirements</primary> - <secondary>OS/JVM</secondary> - </indexterm> - <table> - <title> - Supported Operating System / JVM Combinations. - </title> - <tgroup cols="2"> - <colspec colnum="1" colname="OS" colwidth="1*"></colspec> - <colspec colnum="2" colname="JVM" colwidth="1*"></colspec> - - <thead> - <row> - <entry> - <emphasis>Operating System</emphasis> - </entry> - <entry> - <emphasis>JVM Version</emphasis> - </entry> - </row> - </thead> - <tbody> - <row> - <entry> - Red Hat Enterprise Linux 6 - </entry> - <entry> - OpenJDK 1.6 Update 15 - </entry> - </row> - <row> - <entry> - Red Hat Enterprise Linux 6 - </entry> - <entry> - SunJDK 1.6 Update 15 - </entry> - </row> - <row> - <entry> - Red Hat Enterprise Linux 5 x86 - </entry> - <entry> - Sun JVM 1.6 Update 15 - </entry> - </row> - <row> - <entry> - Red Hat Enterprise Linux 5 x86 - </entry> - <entry> - OpenJDK 1.6.0-b09 - </entry> - </row> - <row> - <entry> - Red Hat Enterprise Linux 5 x86 - </entry> - <entry> - IBM JDK 1.6.0 SR5 - </entry> - </row> - <row> - <entry> - Red Hat Enterprise Linux 5 x86_64 - </entry> - <entry> - Sun JVM 1.6 Update 15 - </entry> - </row> - <row> - <entry> - Red Hat Enterprise Linux 5 x86_64 - </entry> - <entry> - OpenJDK 1.6.0-b09 - </entry> - </row> - <row> - <entry> - Red Hat Enterprise Linux 5 x86_64 - </entry> - <entry> - IBM JDK 1.6.0 SR5 - </entry> - </row> - <row> - <entry> - Microsoft Windows 2008 x86 - </entry> - <entry> - Sun JVM 1.6 Update 15 - </entry> - </row> - <row> - <entry> - Microsoft Windows 2008 x86_64 - </entry> - <entry> - Sun JVM 1.6 Update 15 - </entry> - </row> - <row> - <entry> - Solaris 10 - </entry> - <entry> - Sun JVM 1.6 Update 15 - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para> + <indexterm> + <primary>System Requirements</primary> + <secondary>OS/JVM</secondary> + </indexterm> + <table> + <title> Supported Operating System / JVM Combinations. </title> + <tgroup cols="2"> + <colspec colnum="1" colname="OS" colwidth="1*"/> + <colspec colnum="2" colname="JVM" colwidth="1*"/> + <thead> + <row> + <entry> + <emphasis>Operating System</emphasis> + </entry> + <entry> + <emphasis>JVM Version</emphasis> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> Red Hat Enterprise Linux 6 </entry> + <entry> OpenJDK 1.6 Update 15 </entry> + </row> + <row> + <entry> Red Hat Enterprise Linux 6 </entry> + <entry> SunJDK 1.6 Update 15 </entry> + </row> + <row> + <entry> Red Hat Enterprise Linux 5 x86 </entry> + <entry> Sun JVM 1.6 Update 15 </entry> + </row> + <row> + <entry> Red Hat Enterprise Linux 5 x86 </entry> + <entry> OpenJDK 1.6.0-b09 </entry> + </row> + <row> + <entry> Red Hat Enterprise Linux 5 x86 </entry> + <entry> IBM JDK 1.6.0 SR5 </entry> + </row> + <row> + <entry> Red Hat Enterprise Linux 5 x86_64 </entry> + <entry> Sun JVM 1.6 Update 15 </entry> + </row> + <row> + <entry> Red Hat Enterprise Linux 5 x86_64 </entry> + <entry> OpenJDK 1.6.0-b09 </entry> + </row> + <row> + <entry> Red Hat Enterprise Linux 5 x86_64 </entry> + <entry> IBM JDK 1.6.0 SR5 </entry> + </row> + <row> + <entry> Microsoft Windows 2008 x86 </entry> + <entry> Sun JVM 1.6 Update 15 </entry> + </row> + <row> + <entry> Microsoft Windows 2008 x86_64 </entry> + <entry> Sun JVM 1.6 Update 15 </entry> + </row> + <row> + <entry> Solaris 10 </entry> + <entry> Sun JVM 1.6 Update 15 </entry> + </row> + </tbody> + </tgroup> + </table> + <para> The following is a cumulative table of supported databases and JDBC drivers. </para> - <para> + <para> Entries shown for each release are supported <emphasis role="bold">in addition to those in previous releases</emphasis>: </para> - <indexterm> - <primary>System Requirements</primary> - <secondary>Database</secondary> - </indexterm> - <indexterm> - <primary>Database</primary> - <secondary>System Requirements</secondary> - </indexterm> <!-- Source Metadata URL: https://docspace.corp.redhat.com/docs/DOC-16080 Author [w/email]: Added at request of Vlastislav Ramik (vramik(a)redhat.com) License: ---> - <table> - <title>Supported Database and JDBC driver Combinations</title> - <tgroup cols="2"> - <colspec colnum="1" colname="c1" colwidth="1*"></colspec> - <colspec colnum="2" colname="c2" colwidth="1*"></colspec> - <thead> - <row> - <entry> - <emphasis>Database</emphasis> - </entry> - <entry> - <emphasis>Database driver</emphasis> - </entry> - </row> - </thead> - <tbody> - <row> - <entry> - IBM DB2 9.7 - </entry> - <entry> - IBM DB2 JDBC Universal Driver Architecture 4.12.55 - </entry> - </row> - <row> - <entry> - Oracle 10g R2, (10.2.0.4) - </entry> - <entry> - Oracle JDBC Driver v10.2.0.5 - </entry> - </row> - <row> - <entry> - Oracle 11g R1, (11.1.0.7.0) - </entry> - <entry> - Oracle JDBC Driver v11.1.0.7 - </entry> - </row> - <row> - <entry> - Oracle 11g R1 RAC (11.1.0.7.0) - </entry> - <entry> - Oracle JDBC Driver v11.1.0.7 - </entry> - </row> - <row> - <entry> - Oracle 11g R2 - </entry> - <entry> - Oracle JDBC Driver v11.2.0.2.0 - </entry> - </row> - <row> - <entry> - Oracle 11g R2 RAC - </entry> - <entry> - Oracle JDBC Driver v11.2.0.2.0 - </entry> - </row> - <row> - <entry> - MySQL 5.0 (5.0.79) - </entry> - <entry> - MySQL Connector/J 5.0.8 - </entry> - </row> - <row> - <entry> - MySQL 5.0 (5.0.79) - </entry> - <entry> - MySQL Connector/J 5.1.17 - </entry> - </row> - <row> - <entry> - MySQL 5.1 (5.1.36) - </entry> - <entry> - MySQL Connector/J 5.1.17 - </entry> - </row> - <row> - <entry> - Microsoft SQL Server 2005 (Deprecated from 5.1.2) - </entry> - <entry> - Microsoft SQL Server JDBC Driver 3.0.1301.101 - </entry> - </row> - <row> - <entry> - Microsoft SQL Server 2008 - </entry> - <entry> - Microsoft SQL Server JDBC Driver 3.0.1301.101 - </entry> - </row> - <row> - <entry> - Microsoft SQL Server 2008 R2 - </entry> - <entry> - Microsoft SQL Server JDBC Driver 3.0.1301.101 - </entry> - </row> - <row> - <entry> - PostgreSQL 8.2.17 - </entry> - <entry> - JDBC4 Postgresql Driver, Version 8.2-511 - </entry> - </row> - <row> - <entry> - PostgreSQL 8.3.11 - </entry> - <entry> - JDBC4 Postgresql Driver, Version 8.3-606 - </entry> - </row> - <row> - <entry> - PostgreSQL 8.4.7 - </entry> - <entry> - JDBC4 Postgresql Driver, Version 8.4-703 - </entry> - </row> - <row> - <entry> - Sybase ASE 15.0.3 - </entry> - <entry> - Sybase jConnect JDBC driver v7 (Build 26502/EBF17993) - </entry> - </row> - <row> - <entry> - Sybase ASE 15.5 - </entry> - <entry> - Sybase jConnect JDBC driver v7 (Build 26502/EBF17993) - </entry> - </row> - </tbody> - </tgroup> - </table> - - <indexterm> - <primary>System Requirements</primary> - <secondary>Directory server</secondary> - </indexterm> - <para> +--> <table> + <title>Supported Database and JDBC driver Combinations</title> + <tgroup cols="2"> + <colspec colnum="1" colname="c1" colwidth="1*"/> + <colspec colnum="2" colname="c2" colwidth="1*"/> + <thead> + <row> + <entry> + <emphasis>Database</emphasis> + </entry> + <entry> + <emphasis>Database driver</emphasis> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> IBM DB2 9.7 </entry> + <entry> IBM DB2 JDBC Universal Driver Architecture 4.12.55 </entry> + </row> + <row> + <entry> Oracle 10g R2, (10.2.0.4) </entry> + <entry> Oracle JDBC Driver v10.2.0.5 </entry> + </row> + <row> + <entry> Oracle 11g R1, (11.1.0.7.0) </entry> + <entry> Oracle JDBC Driver v11.1.0.7 </entry> + </row> + <row> + <entry> Oracle 11g R1 RAC (11.1.0.7.0) </entry> + <entry> Oracle JDBC Driver v11.1.0.7 </entry> + </row> + <row> + <entry> Oracle 11g R2 </entry> + <entry> Oracle JDBC Driver v11.2.0.2.0 </entry> + </row> + <row> + <entry> Oracle 11g R2 RAC </entry> + <entry> Oracle JDBC Driver v11.2.0.2.0 </entry> + </row> + <row> + <entry> MySQL 5.0 (5.0.79) </entry> + <entry> MySQL Connector/J 5.0.8 </entry> + </row> + <row> + <entry> MySQL 5.0 (5.0.79) </entry> + <entry> MySQL Connector/J 5.1.17 </entry> + </row> + <row> + <entry> MySQL 5.1 (5.1.36) </entry> + <entry> MySQL Connector/J 5.1.17 </entry> + </row> + <row> + <entry> Microsoft SQL Server 2005 (Deprecated from 5.1.2) </entry> + <entry> Microsoft SQL Server JDBC Driver 3.0.1301.101 </entry> + </row> + <row> + <entry> Microsoft SQL Server 2008 </entry> + <entry> Microsoft SQL Server JDBC Driver 3.0.1301.101 </entry> + </row> + <row> + <entry> Microsoft SQL Server 2008 R2 </entry> + <entry> Microsoft SQL Server JDBC Driver 3.0.1301.101 </entry> + </row> + <row> + <entry> PostgreSQL 8.2.17 </entry> + <entry> JDBC4 Postgresql Driver, Version 8.2-511 </entry> + </row> + <row> + <entry> PostgreSQL 8.3.11 </entry> + <entry> JDBC4 Postgresql Driver, Version 8.3-606 </entry> + </row> + <row> + <entry> PostgreSQL 8.4.7 </entry> + <entry> JDBC4 Postgresql Driver, Version 8.4-703 </entry> + </row> + <row> + <entry> Sybase ASE 15.0.3 </entry> + <entry> Sybase jConnect JDBC driver v7 (Build 26502/EBF17993) </entry> + </row> + <row> + <entry> Sybase ASE 15.5 </entry> + <entry> Sybase jConnect JDBC driver v7 (Build 26502/EBF17993) </entry> + </row> + </tbody> + </tgroup> + </table> + <indexterm> + <primary>System Requirements</primary> + <secondary>Directory server</secondary> + </indexterm> + <para> The following is a list of supported directory servers: </para> - - <table> - <title>Supported and Certified directory servers</title> - <tgroup cols="2"> - <colspec colnum="1" colname="LDAP" colwidth="1*"></colspec> - <thead> - <row> - <entry> - <emphasis>Directory Server</emphasis> - </entry> - <entry> - <emphasis>Version</emphasis> - </entry> - </row> - </thead> - <tbody> - <row> - <entry> - OpenDS - </entry> - <entry> - 1.2 - </entry> - </row> - <row> - <entry> - OpenDS - </entry> - <entry> - 2.0 - </entry> - </row> - <row> - <entry> - OpenLDAP - </entry> - <entry> - 2.4 - </entry> - </row> - <row> - <entry> - Red Hat Directory Server - </entry> - <entry> - 7.1 - </entry> - </row> - <row> - <entry> - MS Active Directory - </entry> - <entry> - Windows Server 2008 - </entry> - </row> - </tbody> - </tgroup> - </table> + <table> + <title>Supported and Certified directory servers</title> + <tgroup cols="2"> + <colspec colnum="1" colname="LDAP" colwidth="1*"/> + <thead> + <row> + <entry> + <emphasis>Directory Server</emphasis> + </entry> + <entry> + <emphasis>Version</emphasis> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> OpenDS </entry> + <entry> 1.2 </entry> + </row> + <row> + <entry> OpenDS </entry> + <entry> 2.0 </entry> + </row> + <row> + <entry> OpenLDAP </entry> + <entry> 2.4 </entry> + </row> + <row> + <entry> Red Hat Directory Server </entry> + <entry> 7.1 </entry> + </row> + <row> + <entry> MS Active Directory </entry> + <entry> Windows Server 2008 </entry> + </row> + </tbody> + </tgroup> + </table> <!-- <note> <para> JBoss uses an embedded Tomcat and does not require a stand-alone Tomcat. </para> </note> ---> - </section> - - <section id="Pre_Requisites-Configuring_Your_Java_Environment"> - <title>Configuring Your Java Environment</title> - - <para> - You must have a working installation of <emphasis role="bold">JDK 1.6</emphasis> before you install JBoss Enterprise Portal Platform. You can install the 32-bit or 64-bit JVM as per your requirements. In this guide we will show you how to install a 32-bit Sun JDK 6.0 using RHN, on a generic Linux Platform and Microsoft Windows Platform. But before we do that let's take a look at some of the benefits of using a 64-bit JVM. - </para> - - <itemizedlist id="Configuring_Your_Java_Environment-Benefits_of_64_bit_JVM_on_64_bit_OS_and_Hardware"> - <title>Benefits of 64-bit JVM on 64-bit OS and Hardware:</title> - <listitem> - <para> - Wider datapath: The pipe between RAM and CPU is doubled, which improves the performance of memory-bound applications. - </para> - </listitem> - <listitem> - <para> - 64-bit memory addressing gives virtually unlimited (1 exabyte) heap allocation. However large heaps affect garbage collection. - </para> - </listitem> - <listitem> - <para> - 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> - <note> - <para> - Applications that run on a 32-bit JVM and do not require more than minimal heap sizes will gain nothing from a 64-bit JVM. Barring memory issues, 64-bit hardware with the same relative clock speed and architecture is not likely to run Java applications faster than their 32-bit cousin. - </para> - </note> - <itemizedlist id="Configuring_Your_Java_Environment-Installing_and_Configuring_JDK_6.0_using_RHN"> - <title>Installing and Configuring JDK 6.0 using RHN</title> - <listitem> - <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> - <variablelist> - <title>Red Hat Enterprise Linux 5 Java SDKs</title> - <varlistentry> - <term> - Channel: rhel-&lt;arch&gt;-server-5 - </term> - <listitem> - <para> - java-1.6.0-openjdk - </para> - </listitem> - </varlistentry> - <varlistentry> - <term> - Channel: rhel-&lt;arch&gt;-server-supplementary-5 - </term> - <listitem> - <para> - java-1.6.0-sun (Sun) - </para> - - <para> - java-1.6.0-ibm (IBM) - </para> - </listitem> - </varlistentry> - </variablelist> - <para> - Ensure that the -devel packages are also installed. - </para> - </listitem> - - <listitem> - <para> - Selecting <command moreinfo="none">alternatives</command> for <command moreinfo="none">java</command>, <command moreinfo="none">javac</command> and <command moreinfo="none">java_sdk_1.6.0</command> (setting <command moreinfo="none">java_sdk_1.6.0</command> is optional). - </para> - - <para> - This is only needed if you want to use the SysV service script - and/or want this installed SDK to be the default java and javac - in the system. This choice can often be overridden by setting - the <command moreinfo="none">JAVA_HOME</command> environment variable. - </para> - - <para> - The <command moreinfo="none">alternatives</command> system allows different versions of Java, from different sources, to co-exist on your system. You should make sure the desired one is selected so that the service script uses the one you want. - </para> - - <para> - As root, issue the following command: - </para> - <screen><command moreinfo="none">/usr/sbin/alternatives --config java</command></screen> - <para> - and make sure the desired one is selected (marked with a '+'), or select it by entering its number as prompted. - </para> - - <para> - Make sure you do the same for <command moreinfo="none">javac</command> and <command moreinfo="none">java_sdk_1.6.0.</command> We recommend that all point to the same manufacturer and version. - </para> - </listitem> - </itemizedlist> - - <itemizedlist id="Configuring_Your_Java_Environment-Installing_and_Configuring_JDK_6.0_on_a_generic_Linux_platform"> - <title>Installing and Configuring JDK 6.0 on a generic Linux platform</title> - <listitem> - <para> - Download the Java 2 Platform, Standard Edition (J2SE) Development Kit (JDK) 6.0 from Oracle's website: <ulink type="http" url="http://www.oracle.com/technetwork/java/javase/downloads/index.h...;. - </para> - </listitem> - <listitem> - <para> - From this page, select the latest update under the <literal>Java Platform, Standard Edition</literal> heading. Alternatively, this page can be accessed directly at <ulink type="http" url="http://www.oracle.com/technetwork/java/javase/downloads/jdk6-js...;. - </para> - </listitem> - <listitem> - <para> - Follow the instructions presented on this page including selecting the appropriate platform and architecture. - </para> - </listitem> - <listitem> - <para> - Clicking the <guibutton>Continue</guibutton> button will display the download options (depending on whether the user chooses to register): - </para> - <itemizedlist> - <listitem> - <para> - jdk-6u&lt;update number&gt;-linux-&lt;arch&gt;-rpm.bin or; - </para> - </listitem> - <listitem> - <para> - jdk-6u&lt;update number&gt;-linux-&lt;arch&gt;.bin - </para> - </listitem> - </itemizedlist> - <para>If installing the JDK on Red Hat Enterprise Linux, Fedora, or another RPM-based Linux system, it is recommended that the self-extracting file containing the RPM package is selected. This option will set up and use the SysV service scripts in addition to installing the JDK. The RPM option is also recommended if the JBoss Enterprise Portal Platform is being set up in a production environment. - </para> - </listitem> -<!-- <listitem> - <para> - Download and install the appropriate <literal>-compat RPM</literal> from <literal>JPackage</literal> <ulink url="ftp://jpackage.hmdc.harvard.edu/JPackage/1.7/generic/RPMS.non-f... here</ulink>. Please ensure you choose a matching version of the <literal>-compat</literal> package to the JDK you installed. - </para> - <note> - <title>DOC TODO:</title> - <para> - The latest JDK available from Sun's site is update 19. The jpackage site linked to above lists the latest <literal>-compat rpm</literal> at update 6 (java-1.6.0-sun-compat-1.6.0.06-1jpp.i586.rpm). So there is a conflict here as the downloaded package and the -compat rpm cannot be matched as stated above. - </para> - <para> - QE NOTE: "Download and install the appropriate -compat RPM from JPackage here." Should we instruct users to install unsigned rpms? - </para> - </note> - </listitem> --> - <listitem> - <para> - Create an environment variable that points to the JDK installation directory and call it <literal>JAVA_HOME</literal>. Add <literal>$JAVA_HOME/bin</literal> to the system path to be able to run <literal>java</literal> from the command line. You can do this by adding the following lines to the <filename>.bashrc</filename> file in your home directory. <programlisting> -#In this example /usr/java/jdk1.6.0_19 is the JDK installation directory. -export JAVA_HOME=/usr/java/jdk1.6.0_19 -export PATH=$PATH:$JAVA_HOME/bin -</programlisting> - Set this variable for the user account performing the installation and also for the user account that will run the server. - </para> - </listitem> - <listitem> - <para> - If you have more than one version of JVM installed in your machine, make sure you are using the JDK1.6 installation as the default <literal>java</literal> and <literal>javac</literal>. You can do this using the alternatives system. The alternatives system allows different versions of Java, from different sources to co-exist on your system. - <note> - <para> - Selecting alternatives as decribed below can be avoided by setting the <literal>JAVA_HOME</literal> environment variable as explained in the previous step. - </para> - </note> - <itemizedlist> - <title>Select alternatives for java, javac and java_sdk_1.6.0</title> - - <listitem> - <para> - As root, type the following command at the shell prompt and you should see something like this: - </para> - <programlisting>[root@vsr ~]$ /usr/sbin/alternatives --config java -There are 2 programs which provide 'java'. -Selection Command ------------------------------------------------ - 1 /usr/lib/jvm/jre-1.4.2-gcj/bin/java -*+ 2 /usr/lib/jvm/jre-1.6.0-sun/bin/java -Enter to keep the current selection[+], or type selection number: - -</programlisting> - <para> - Make sure the Sun version - <literal>jre-1.6.0-sun</literal> in this case - is selected (marked with a '+' in the output), or select it by entering its number as prompted. - </para> - </listitem> - <listitem> - <para> - Repeat the same for javac and java_sdk_1.6.0. - </para> - <programlisting> -[root@vsr ~]$ /usr/sbin/alternatives --config javac -There are 1 programs which provide 'javac'. - Selection Command ------------------------------------------------ -*+ 1 /usr/lib/jvm/java-1.6.0-sun/bin/javac -Enter to keep the current selection[+], or type selection number: -</programlisting> -<programlisting> -[root@vsr ~]$ /usr/sbin/alternatives --config java_sdk_1.6.0 -There are 1 programs which provide 'java_sdk_1.6.0'. - Selection Command ------------------------------------------------ -*+ 1 /usr/lib/jvm/java-1.6.0-sun -Enter to keep the current selection[+], or type selection number: -</programlisting> - <para> - You should verify that java, javac and java_sdk_1.6.0 all point to the same manufacturer and version. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - Make sure that the <literal>java</literal> executable is in your path and that you are using an appropriate version. To verify your Java environment, type <literal>java -version</literal> at the shell prompt and you should see something like this: <programlisting> -[root@vsr ~]$ java -version -java version "1.6.0_19" -Java(TM) SE Runtime Environment (build 1.6.0_19-b01) -Java HotSpot(TM) Server VM (build 14.2-b01, mixed mode) -</programlisting> - </para> - </listitem> - </itemizedlist> - - <itemizedlist id="Configuring_Your_Java_Environment-Installing_and_Configuring_JDK_6.0_on_Microsoft_Windows"> - <title>Installing and Configuring JDK 6.0 on Microsoft Windows</title> - <listitem> - <para> - Download the Java 2 Platform, Standard Edition (J2SE) Development Kit (JDK) 6.0 from Oracle's website: <ulink type="http" url="http://www.oracle.com/technetwork/java/javase/downloads/index.h...;. - </para> - </listitem> - <listitem> - <para> - From this page, select the latest update under the <literal>Java Platform, Standard Edition</literal> heading. Alternatively, this page can be accessed directly at <ulink url="http://www.oracle.com/technetwork/java/javase/downloads/jdk6-js...;. - </para> - </listitem> - <listitem> - <para> - Follow the instructions presented on this page including selecting the appropriate platform and architecture. - </para> - </listitem> - <listitem> - <para> - Clicking the <guibutton>Continue</guibutton> button will display the download option (depending on whether the user chooses to register): - </para> - <itemizedlist> - <listitem> - <para> - jdk-6u&lt;update number&gt;-windows-&lt;arch&gt;.exe - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - Create an environment variable called <literal>JAVA_HOME</literal> that points to the JDK installation directory, for example: <literal>C:\Program Files\Java\jdk1.6.0_19\</literal>. - </para> - </listitem> - <listitem> - <para> - In order to run java from the command line add the <literal>jre\bin</literal> directory to your path, for example: <literal>C:\Program Files\Java\jdk1.6.0_19\jre\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. - </para> - </listitem> - </itemizedlist> - </section> - +--> </section> + <section id="Pre_Requisites-Configuring_Your_Java_Environment"> + <title>Configure Java</title> + <para>You must have a working installation of <emphasis role="bold">JDK 1.6</emphasis> before you install JBoss Enterprise Portal Platform. You can install the 32-bit or 64-bit JVM to suit your operational requirements.</para> + <para>Installation instructions for supported Java Development Kits are available in the JBoss Enterprise Application Platform <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_... Guide</ulink>, in <citetitle>Appendix C</citetitle> and <citetitle>Appendix D</citetitle> of the guide.</para> </section> - <section> - <title>Recommended Practices</title> - <para> + </section> + <section> + <title>Recommended Practices</title> + <para> JBoss Enterprise Portal Platform includes four pre-configured user accounts for testing and evaluation purposes. These accounts can be used for direct access to the portal. </para> - <para> - For security reasons, before going in production, you should restrict the access to the login servlet to POST. + <para>Before going to production, restrict login servlet access to POST to prevent unauthorized logins. </para> - <para> - To do so, edit the file <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: + <para>Edit the file <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: </para> -<programlisting language="XML" role="XML"><![CDATA[ + <programlisting language="XML" role="XML"><![CDATA[ <security-constraint> <web-resource-collection> <web-resource-name>login</web-resource-name> @@ -804,10 +365,8 @@ </web-resource-collection> <auth-constraint/> </security-constraint> ]]></programlisting> - <para> + <para> Doing this will render the login links provided on the front page inactive. </para> - - </section> + </section> </chapter> - Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Installation.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Installation.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Installation.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -1,88 +1,79 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> %BOOK_ENTITIES; ]> - <chapter id="Installation"> - <title>Installation</title> - - <section id="Download"> - <title>Downloading</title> - - <para> - The officially supported versions are available from the JBoss Customer Support Portal (CSP) located at <ulink url="https://access.redhat.com/home">https://access.redhat.c...;. Platforms including in your Support subscription are listed in the <literal>Software</literal> section. + <title>Platform Installation</title> + <section id="Download"> + <title>Download</title> + <para> + The officially supported platform versions are available from the JBoss Customer Support Portal (CSP) located at <ulink url="https://access.redhat.com/home">https://access.redhat.c...;. Platforms including in your Support subscription are listed in the <literal>Software</literal> section. </para> - </section> - - <section id="Installing"> - <title>Installing</title> + </section> + <section id="Installing"> + <title>Install</title> + <para> + To install from a zip file, unzip the downloaded file to a directory of your choice. - <para> - To install from a zip file, simply unzip the downloaded file to a directory of your choice. - <itemizedlist> - <listitem> - <para> - Unzip <literal>jboss-epp-<replaceable>&lt;release&gt;</replaceable>.zip</literal> to extract the archive contents into the location of your choice. You can do this using the JDK <literal>jar</literal> tool (or any other ZIP extraction tool). -<programlisting> -[vsr]$ <literal>cd jbeppinstallationdir</literal> -[vsr]$ <literal>jar -xvf jboss-epp-<replaceable>&lt;release&gt;</replaceable>.zip</literal> -</programlisting> + <listitem> + <para> + Unzip <literal>jboss-epp-<replaceable>VERSION</replaceable>.zip</literal> to extract the archive contents into the location of your choice. You can do this using the JDK <literal>jar</literal> tool (or any other ZIP extraction tool). +<programlisting>[vsr]$ <literal>cd jbeppinstallationdir</literal> +[vsr]$ <literal>jar -xvf jboss-epp-<replaceable>RELEASE</replaceable>.zip</literal></programlisting> </para> - </listitem> - <listitem> - <para> - You are done with the installation! You should now have a directory called <filename>jboss-epp-<replaceable>&lt;release&gt;</replaceable></filename>. + </listitem> + <listitem> + <para> + You are done with the installation! You should now have a directory called <filename>jboss-epp-<replaceable>VERSION</replaceable></filename>. </para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> </para> - <note> - <title>Server Configurations</title> - <para> - Six types of server configurations will be included in your installation: <literal>minimal</literal>, <literal>default</literal>, <literal>production</literal>, <literal>all</literal>, <literal>standard</literal> and <literal>web</literal>. + <note> + <title>Server Configurations</title> + <para> + Six types of server configurations are included in your installation: <literal>minimal</literal>, <literal>default</literal>, <literal>production</literal>, <literal>all</literal>, <literal>standard</literal> and <literal>web</literal>. </para> <para> - The JBoss Enterprise Application Platform <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_... Started Guide</ulink> explains in detail the different server configuration file sets. + The JBoss Enterprise Application Platform <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_... type="http">Getting Started Guide</ulink> explains in detail the different server configuration file sets. </para> - </note> - - </section> - - <section id="server-config-differences"> - <title>Choosing a server configuration</title> - <para> + </note> + </section> + <section id="server-config-differences"> + <title>Choose a Server Profile</title> + <para> The important differences between the Portal and JBoss Enterprise Application Platform server configurations are: <itemizedlist> - <listitem> - <para> + <listitem> + <para> the <literal>minimal</literal>, <literal>web</literal> and <literal>standard</literal> server configurations do not contain any Portal relevant components. These directories exist for the sake of consistency with JBoss Enterprise Application Platform </para> - </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. --> This is the server configuration that is started when no other configuration is specified. + </listitem> + <listitem> + <para> + the <literal>default</literal> server configuration includes non-clustered Portal components. This is the server configuration that is started when no other configuration is specified. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> the <literal>all</literal> server configuration includes the Portal and services used for running on a cluster. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> the <literal>production</literal> server configuration includes Portal components and clustering services. It is pre-configured with default settings which would be more accurate for a production environment. </para> - </listitem> - </itemizedlist> + </listitem> + </itemizedlist> </para> - <note><title>gatein.ear Archive</title> - <para> - The gatein.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. + <note> + <title>gatein.ear Archive</title> + <para> + The <filename>gatein.ear</filename> archive, which contains the Portal components, is located in the <filename>/deploy</filename> directory of the <literal>default</literal>, <literal>all</literal> and <literal>production</literal> server configurations. </para> - </note> - </section> + </note> + </section> </chapter> - Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -8,9 +8,9 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Introduction.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Getting_Started.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Installation.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="SP_Installation.xml" encoding="UTF-8"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Post_Installation.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configuration.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Add-ons.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Test_Your_Installation.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Uninstall_JBoss.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> 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 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Post_Installation.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -1,137 +1,121 @@ -<?xml version='1.0'?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="Post_Installation_Configuration"> - <title>Post Installation Configuration</title> - <section id="Set_JBOSS_HOME"> - <title> - Set JBOSS_HOME Environment Variable - </title> - <formalpara> - <title> - On a Linux Platform - </title> - <para> - Create an environment variable that points to the installation directory (<filename><replaceable>&lt;JBOSS_DIST&gt;</replaceable>/jboss-as</filename>) and call it <literal>JBOSS_HOME</literal>. Add <literal>$JBOSS_HOME/bin</literal> to the system path to be able to run the server from the command line. You can do this by adding the following lines to the <filename>.bashrc</filename> file in your home directory. + <title>Post Installation Configuration</title> + <section id="Set_JBOSS_HOME"> + <title> Set JBOSS_HOME Environment Variable </title> + <formalpara> + <title> On a Linux Platform </title> + <para> + Create an environment variable that points to the installation directory (<filename><replaceable>JBOSS_DIST</replaceable>/jboss-as</filename>) and call it <literal>JBOSS_HOME</literal>. Add <literal>$JBOSS_HOME/bin</literal> to the system path to be able to run the server from the command line. You can do this by adding the following lines to the <filename>.bashrc</filename> file in your <filename>/home</filename> directory. </para> - </formalpara> -<programlisting> -#In this example /home/user/jboss-epp-<replaceable>&lt;VERS&gt;</replaceable>/jboss-as is the installation directory. - export JBOSS_HOME=/home/user/jboss-epp-<replaceable>&lt;VERS&gt;</replaceable>/jboss-as + </formalpara> + <programlisting> +#In this example /home/user/jboss-epp-<replaceable>VERSION</replaceable>/jboss-as is the installation directory. + export JBOSS_HOME=/home/user/jboss-epp-<replaceable>VERSION</replaceable>/jboss-as export PATH=$PATH:$JBOSS_HOME/bin </programlisting> - <para> + <para> Set this variable for the user account(s) that will run the server. </para> - - <formalpara> - <title> - On Microsoft Windows - </title> - <para> - Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: <filename>C:\jboss-epp-<replaceable>&lt;VERS&gt;</replaceable>\jboss-as\</filename>. + <formalpara> + <title> On Microsoft Windows </title> + <para> + Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: <filename>C:\jboss-epp-<replaceable>VERSION</replaceable>\jboss-as\</filename>. </para> - </formalpara> - <para> - 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-<replaceable>&lt;VERS&gt;</replaceable>\jboss-as\bin</filename>. + </formalpara> + <para> + 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-<replaceable>VERSION</replaceable>\jboss-as\bin</filename>. </para> - <para> + <para> 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> - </section> - - <section id="Adjust_Memory_Settings"> - <title>Adjust memory settings</title> - - <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><replaceable>JBOSS_HOME</replaceable>/jboss-as/bin/run.conf</filename> on Linux or <filename><replaceable>JBOSS_HOME</replaceable>/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> + </section> + <section id="Adjust_Memory_Settings"> + <title>Adjust Memory Settings</title> + <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><replaceable>JBOSS_HOME</replaceable>/jboss-as/bin/run.conf</filename> on Linux or <filename><replaceable>JBOSS_HOME</replaceable>\jboss-as\bin\run.conf.bat</filename> on Windows. The default values do not take into account the memory requirements of your applications: +<programlisting>-Xms1303m -Xmx1303m -XX:MaxPermSize=256m ....</programlisting> </para> - </section> - - - - <section id="Post-Installation"> - <title> - Post Installation Security Configuration - </title> - <para> + </section> + <section id="Post-Installation"> + <title>Configure Security </title> + <para> When installed from the zip archive, authentication is required to access the majority of JBoss services, including administrative services. User accounts have not been set up to eliminate the possibility of default username/password based attacks. </para> - - <important><title>Default Admin User Configuration</title> - <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 username/password definition format only. </para> - </important> - <note> - <title><replaceable>JBOSS_HOME</replaceable> and <replaceable>&lt;PROFILE&gt;</replaceable></title> - <para> - <replaceable>JBOSS_HOME</replaceable> is the <filename>jboss-as</filename> directory, a level above the bin directory. <replaceable>&lt;PROFILE&gt;</replaceable> is the chosen server profile: all, default, minimal production, standard or web. + </important> + <note> + <title><replaceable>JBOSS_HOME</replaceable> and <replaceable>PROFILE</replaceable></title> + <para> + <replaceable>JBOSS_HOME</replaceable> is the <filename>jboss-as</filename> directory, a level above the bin directory. <replaceable>PROFILE</replaceable> is the chosen server profile: all, default, minimal production, standard or web. </para> - </note> - <formalpara><title>Set up the <literal>jmx-console</literal> users and roles</title> - <para> - Edit the <filename>jmx-console-users.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/props/</filename> directory defining the username and password: + </note> + <formalpara> + <title>Set up the <literal>jmx-console</literal> users and roles</title> + <para> + Edit the <filename>jmx-console-users.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/conf/props/</filename> directory defining the username and password: </para> - </formalpara> - <programlisting>user=password</programlisting> - <para> - Edit the <filename>jmx-console-roles.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/props/</filename> directory to define the user's roles: + </formalpara> + <programlisting>user=password</programlisting> + <para> + Edit the <filename>jmx-console-roles.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/conf/props/</filename> directory to define the user&apos;s roles: </para> - <programlisting>user=JBossAdmin,HttpInvoker</programlisting> - - <formalpara><title>Set up the <literal>admin-console</literal> users and roles</title> - <para> - Edit the <filename>web-console-users.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: + <programlisting>user=JBossAdmin,HttpInvoker</programlisting> + <formalpara> + <title>Set up the <literal>admin-console</literal> users and roles</title> + <para> + Edit the <filename>web-console-users.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: </para> - </formalpara> - <programlisting>user=password</programlisting> - <para> - Edit the <filename>web-console-roles.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: + </formalpara> + <programlisting>user=password</programlisting> + <para> + Edit the <filename>web-console-roles.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: </para> - <programlisting>user=JBossAdmin,HttpInvoker</programlisting> - - <important> - <para> + <programlisting>user=JBossAdmin,HttpInvoker</programlisting> + <important> + <para> Login credentials for the <literal>admin-console</literal> are the same as those used for the JMX console. </para> - </important> - <formalpara> - <title>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 the <literal>suckerPassword</literal> attribute in the Server Peer configuration file: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/messaging/messaging-jboss-beans.xml</filename>. + </important> + <formalpara> + <title>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 the <literal>suckerPassword</literal> attribute in the Server Peer configuration file: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/messaging/messaging-jboss-beans.xml</filename>. </para> - </formalpara> - <procedure> - <title>Set suckerPassword for JBoss Messaging</title> - <step> - <para> - Edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/messaging/messaging-jboss-beans.xml</filename> file and change the suckerPassword value from "CHANGE ME!!" to a plain text password: + </formalpara> + <procedure> + <title>Set suckerPassword for JBoss Messaging</title> + <step> + <para> + Edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/messaging/messaging-jboss-beans.xml</filename> file and change the suckerPassword value from &quot;CHANGE ME!!&quot; to a plain text password: </para> -<programlisting>&lt;property name="suckerPassword"&gt;CHANGE ME!!&lt;/property&gt; + <programlisting>&lt;property name=&quot;suckerPassword&quot;&gt;CHANGE ME!!&lt;/property&gt; </programlisting> - </step> - <step> - <para> + </step> + <step> + <para> Insert the same password you stored in the <filename>messaging-jboss-beans.xml</filename> file into the following command: </para> -<programlisting><replaceable>/path/to/java/executable</replaceable> -cp <replaceable>JBOSS_HOME</replaceable>/client/jboss-messaging-client.jar org.jboss.messaging.util.SecurityUtil <replaceable>PLAIN_TEXT_PASSWORD</replaceable> + <programlisting><replaceable>/path/to/java/executable</replaceable> -cp <replaceable>JBOSS_HOME</replaceable>/client/jboss-messaging-client.jar org.jboss.messaging.util.SecurityUtil <replaceable>PLAIN_TEXT_PASSWORD</replaceable> </programlisting> - </step> - <step> - <para> - Copy the encrypted password generated by the above command into the SuckerPassword attribute of the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/messaging/messaging-service.xml</filename> file: + </step> + <step> + <para> + Copy the encrypted password generated by the above command into the SuckerPassword attribute of the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/messaging/messaging-service.xml</filename> file: </para> -<programlisting>&lt;attribute name="SuckerPassword"&gt;<replaceable>ENCRYPTED_PASSWORD</replaceable>&lt;/attribute&gt;</programlisting> - </step> - </procedure> - <para> - The suckerpassword in the messaging-service.xml file is for "client side" configuration and is used to initiate a connection, while the suckerpassword in messaging-jboss-beans.xml is part of the "server side" configuration and is used to authenticate incoming connection request. + <programlisting>&lt;attribute name=&quot;SuckerPassword&quot;&gt;<replaceable>ENCRYPTED_PASSWORD</replaceable>&lt;/attribute&gt;</programlisting> + </step> + </procedure> + <para> + The suckerpassword in the messaging-service.xml file is for &quot;client side&quot; configuration and is used to initiate a connection, while the suckerpassword in messaging-jboss-beans.xml is part of the &quot;server side&quot; configuration and is used to authenticate incoming connection requests. </para> <!-- <para> 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: @@ -147,24 +131,19 @@ ­... ­... &lt;/bean&gt; -</programlisting>--> - - </section> - - <section id="Disabling_Authentication"> - <title>Disabling Authentication</title> - - <para> +</programlisting>--> </section> + <section id="Disabling_Authentication"> + <title>Disable Authentication</title> + <para> It is possible to disable authentication for specific services by following the instructions in this section. </para> - - <formalpara> - <title>Disabling Authentication for JXM Console:</title> - <para> - To disable authentication for the JMX console, edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/jmx-console.war/WEB-INF/web.xml</filename> file and comment out the security-constraint section: + <formalpara> + <title>Disabling Authentication for JXM Console:</title> + <para> + To disable authentication for the JMX console, edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/jmx-console.war/WEB-INF/web.xml</filename> file and comment out the security-constraint section: </para> - </formalpara> -<programlisting language="XML" role="XML"> + </formalpara> + <programlisting language="XML" role="XML"> &lt;security-constraint&gt; &lt;web-resource-collection&gt; &lt;web-resource-name&gt;HtmlAdaptor&lt;/web-resource-name&gt; @@ -179,11 +158,14 @@ &lt;/auth-constraint&gt; &lt;/security-constraint&gt; </programlisting> - <formalpara> - <title>Disabling Authentication for Web Console:</title> - <para> - To disable authentication for the Web console, 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</filename> file to comment out the security-constraint section: -<programlisting language="XML" role="XML"> + <formalpara> + <title>Disabling Authentication for Web Console:</title> + <para> + To disable authentication for the Web console, edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml</filename> file to comment out the security-constraint section: + + </para> + </formalpara> + <programlisting language="XML" role="XML"> &lt;security-constraint&gt; &lt;web-resource-collection&gt; &lt;web-resource-name&gt;HtmlAdaptor&lt;/web-resource-name&gt; @@ -199,13 +181,14 @@ &lt;/auth-constraint&gt; &lt;/security-constraint&gt; </programlisting> + <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>PROFILE</replaceable>/deploy/httpha-invoker.sar/invoker.war/WEB-INF/web.xml</filename> file: + </para> - </formalpara> - <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/httpha-invoker.sar/invoker.war/WEB-INF/web.xml</filename> file: -<programlisting language="XML" role="XML"> + </formalpara> + <programlisting language="XML" role="XML"> &lt;security-constraint&gt; &lt;web-resource-collection&gt; &lt;web-resource-name&gt;HttpInvokers&lt;/web-resource-name&gt; @@ -221,43 +204,40 @@ &lt;/auth-constraint&gt; &lt;/security-constraint&gt; </programlisting> + <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>PROFILE</replaceable>/deploy/jmx-invoker-service.xml</filename> file to comment out the security interceptor passthrough: </para> - </formalpara> - <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/jmx-invoker-service.xml</filename> file to comment out the security interceptor passthrough: - </para> - </formalpara> - <para> + </formalpara> + <para> Locate the mbean section with the class <literal>org.jboss.jmx.connector.invoker.InvokerAdaptorService</literal>. In that section comment out the line that relates to authenticated users: </para> -<programlisting language="XML" role="XML"> + <programlisting language="XML" role="XML"> &lt;descriptors&gt; &lt;interceptors&gt; &lt;!-- Uncomment to require authenticated users --&gt; - &lt;interceptor code="org.jboss.jmx.connector.invoker.AuthenticationInterceptor" - securityDomain="java:/jaas/jmx-console"/&gt; + &lt;interceptor code=&quot;org.jboss.jmx.connector.invoker.AuthenticationInterceptor&quot; + securityDomain=&quot;java:/jaas/jmx-console&quot;/&gt; &lt;!-- Interceptor that deals with non-serializable results --&gt; - &lt;interceptor code="org.jboss.jmx.connector.invoker.SerializableInterceptor" - policyClass="StripModelMBeanInfoPolicy"/&gt; + &lt;interceptor code=&quot;org.jboss.jmx.connector.invoker.SerializableInterceptor&quot; + policyClass=&quot;StripModelMBeanInfoPolicy&quot;/&gt; &lt;/interceptors&gt; &lt;/descriptors&gt; </programlisting> - <formalpara> - <title>Disabling Pre-configured Accounts</title> - <para> + <title>Disabling Pre-configured Accounts</title> + <para> JBoss Enterprise Portal Platform includes four pre-configured user accounts for testing and evaluation purposes. These accounts can be used for direct access to the portal. </para> </formalpara> - <para> + <para> For security reasons, before going in production, you should restrict the access to the login servlet to POST. </para> - <para> - To do so, edit the file <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: + <para> + To do so, edit the file <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: </para> -<programlisting language="XML" role="XML"><![CDATA[ + <programlisting language="XML" role="XML"><![CDATA[ <security-constraint> <web-resource-collection> <web-resource-name>login</web-resource-name> @@ -271,11 +251,8 @@ </web-resource-collection> <auth-constraint/> </security-constraint> ]]></programlisting> - <para> + <para> Doing this will render the login links provided on the front page inactive. </para> - - - - </section> + </section> </chapter> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Revision_History.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -9,6 +9,20 @@ <simpara> <revhistory> <revision> + <revnumber>5.2.1-3</revnumber> + <date>Mon Feb 27 2012</date> + <author> + <firstname>Jared</firstname> + <surname>Morgan</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Incorporated changes to https://bugzilla.redhat.com/show_bug.cgi?id=741683. Site Publisher Installation Guide is deprecated as part of this fix.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>5.2.1-2</revnumber> <date>Mon Feb 21 2012</date> <author> Added: epp/docs/branches/5.2/Installation_Guide/en-US/SP_Installation.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/SP_Installation.xml (rev 0) +++ epp/docs/branches/5.2/Installation_Guide/en-US/SP_Installation.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -0,0 +1,185 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Site_Publisher_Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<chapter id="Site_Publisher_Installation"> + <title><remark>BZ#741683 </remark>Site Publisher Installation</title> + <formalpara> + <title>Clean Installation</title> + <para>An instance of JBoss Enterprise Portal Platform that has just been installed. The instance does not contain any non-standard configuration settings or data, common in pre-existing platform installations.</para> + </formalpara> + <para>The Site Publisher add-on (referred to commonly as Site Publisher) is an extension to the JBoss Enterprise Portal Platform product. Site Publisher must be installed onto a <firstterm>clean installation</firstterm> of JBoss Enterprise Portal Platform 5.1.0 or later to function. + </para> + <para>If you are currently operating JBoss Enterprise Portal Platform in your production environment, you must deploy a new instance of JBoss Enterprise Portal Platform 5.1.0 or later, and install Site Publisher onto the new instance. + </para> + <note> + <title>JBoss Enterprise Portal Platform Subscriptions</title> + <para> + Subscriptions for Site Publisher are separate from JBoss Enterprise Portal Platform subscriptions. + </para> + <para> + If you do not already have a subscription to JBoss Enterprise Portal Platform, you will need to obtain one in addition to your Site Publisher subscription in order to install and run Site Publisher. + </para> + </note> + <section id="sect-Site_Publisher_Installation_Guide-Installing_Site_Publisher-Configuration_Locations"> + <title>Configuration Locations</title> + <para>Site Publisher requires configuration files to be copied to the configuration location of the clean JBoss Enterprise Portal Platform instance. + </para> + <para>There are three possible locations for these configuration files depending on your JBoss Enterprise Portal Platform configuration setup: + </para> + <variablelist> + <varlistentry> + <term>Default</term> + <listitem> + <para> + <filename>jboss-epp-<replaceable>&lt;version&gt;</replaceable>/jboss-as/server/default/deploy</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>All</term> + <listitem> + <para> + <filename>jboss-epp-<replaceable>&lt;version&gt;</replaceable>/jboss-as/server/all/deploy</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Production</term> + <listitem> + <para> + <filename>jboss-epp-<replaceable>&lt;version&gt;</replaceable>/jboss-as/server/production/deploy</filename>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para>Ensure you know which of the above configuration profiles will be used in your JBoss Enterprise Portal Platform environment before you begin the installation. + </para> + <para>The required files can be copied into each of the three locations to ensure that Site Publisher can be used with each of the three configuration profiles. + </para> + <para> + If you use a custom configuration profile, copy the files into the corresponding location of your profile. + </para> + </section> + <section> + <title>Install</title> + <para>Read this section to learn the steps required to install Site Publisher.</para> + <task> + <title>Task: Install Site Publisher</title> + <tasksummary> + <para>Complete this task to install Site Publisher on a clean JBoss Enterprise Application Platform instance.</para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>You have installed a clean instance of JBoss Enterprise Portal Platform 5.1.0 or later.</para> + </listitem> + <listitem> + <para>You understand the available Site Publisher configuration locations as described in <xref linkend="sect-Site_Publisher_Installation_Guide-Installing_Site_Publisher-Configuration_Locations"/>.</para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Download the <filename>jboss-eppsp-<replaceable>VERSION</replaceable>-exo-<replaceable>VERSION</replaceable>-GA.zip</filename> file from the Red Hat JBoss Customer Support Portal. + </para> + </step> + <step> + <para>Extract the contents of the Zip archive to a local directory on the clean JBoss Enterprise Portal Platform instance.</para> + </step> + <step> + <para>Create a back-up of <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein-ds.xml</filename>. Creating a back-up of this key configuration file will allow you to roll-back to a standard JBoss Enterprise Portal Platform installation in the future. </para> + </step> + <step> + <para>Copy the files in the list below from the extracted location to the configuration location of your JBoss Enterprise Portal Platform installation: + </para> + <itemizedlist> + <listitem> + <para> + <filename>gatein-wcm-extension-<replaceable>VERSION</replaceable>-GA.ear</filename> + </para> + </listitem> + <listitem> + <para> + <filename>gatein-eppspdemo-portal-<replaceable>VERSION</replaceable>-GA.ear</filename> + </para> + </listitem> + <listitem> + <para> + <filename>gatein-ds.xml</filename> + </para> + </listitem> + <listitem> + <para> + <filename>wcm-ds.xml</filename> + </para> + </listitem> + </itemizedlist> + </step> +<!-- Removed from live text as SP documentation relies on ecmdemo being deployed. + <step> + <para> + <emphasis role="bold">Optional step</emphasis>: + </para> + <para> + The extracted location will also contain the following files: + </para> + <itemizedlist> + <listitem> + <para> + <filename>gatein-eppspdemo-portal-<replaceable>&lt;version&gt;</replaceable>-GA.ear</filename> + </para> + </listitem> + <listitem> + <para> + <filename>gatein-ds.xml</filename> + </para> + </listitem> + <listitem> + <para> + <filename>wcm-ds.xml</filename> + </para> + </listitem> + </itemizedlist> + <para> + These files provides a sample portal and are not required for the Site Publisher add-on to operate. + </para> + <para> + Copying these files to the configuration location used in the previous step, however, will include a sample portal which can be used to verify a successful installation of the Site Publisher component. + </para> + <note> + <title>Overwriting gatein-ds.xml</title> + <para> + Be aware that a base installation of JBoss Enterprise Portal Platform already contains a <filename>gatein-ds.xml</filename> file in the <filename>deploy</filename> directory. It is recommended that this file be backed-up before copying the new Site Publisher version of the file. + </para> + <para> + This ensures that if you wish to 'uninstall' the Site Publisher add-on, you can revert to the original <filename>gatein-ds.xml</filename> file. + </para> + </note> + </step> --> <step> + <formalpara> + <title>Result</title> + <para>You have copied all required configuration files to the platform. Site Publisher is now ready to use once all other configuration tasks have been completed in this guide.</para> + </formalpara> + </step> + </procedure> + </task> + <para>Once you have completed all other configuration tasks in this guide, start the platform and navigate to <ulink url="http://localhost:8080/ecmdemo/public/classic" type="http">http://localhost:8080/ecmdemo/public/classic</ulink>. + </para> + <para> + If your installation has been successful, you will see the following sample homepage: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata width="444" scale="90" fileref="images/epp-sp-homepage.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata width="444" contentwidth="150mm" fileref="images/epp-sp-homepage.png" format="PNG"/> + </imageobject> + </mediaobject> +<!-- <para> + If you did not include the <filename>gatein-ecmdemo-portal-&lt;version&gt;-GA.ear</filename> file, refer to the documentation available at <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... /> for instructions on how to create a portal using Site Publisher's features. + </para> --> </section> +</chapter> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Test_Your_Installation.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Test_Your_Installation.xml 2012-02-25 11:23:44 UTC (rev 8467) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Test_Your_Installation.xml 2012-02-27 04:11:22 UTC (rev 8468) @@ -29,7 +29,7 @@ <itemizedlist> <listitem> <para> - Ensure that you run the configuration corresponding to the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/</filename> chosen in <xref linkend="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"/> + Ensure that you run the configuration corresponding to the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/</filename> chosen in <xref linkend="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"/> </para> </listitem> </itemizedlist> Added: epp/docs/branches/5.2/Installation_Guide/en-US/images/ecmdemo.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/5.2/Installation_Guide/en-US/images/ecmdemo.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: epp/docs/branches/5.2/Installation_Guide/en-US/images/epp-sp-homepage.png =================================================================== (Binary files differ) Property changes on: epp/docs/branches/5.2/Installation_Guide/en-US/images/epp-sp-homepage.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream