Author: jaredmorgs Date: 2012-03-01 23:11:02 -0500 (Thu, 01 Mar 2012) New Revision: 8526 Added: epp/docs/branches/5.2/Installation_Guide/en-US/Customer_Portal.xml epp/docs/branches/5.2/Installation_Guide/en-US/Installation_With_ZIP_Download.xml epp/docs/branches/5.2/Installation_Guide/en-US/Native_Components.xml Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml epp/docs/branches/5.2/Installation_Guide/en-US/Configuration.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/Introduction.xml epp/docs/branches/5.2/Installation_Guide/en-US/Post_Installation.xml epp/docs/branches/5.2/Installation_Guide/en-US/SP_Installation.xml epp/docs/branches/5.2/Installation_Guide/en-US/Test_Your_Installation.xml epp/docs/branches/5.2/Installation_Guide/en-US/Uninstall_JBoss.xml Log: Converting guide to task-based format as part of https://bugzilla.redhat.com/show_bug.cgi?id=798839 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-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Book_Info.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -5,7 +5,7 @@ ]> <bookinfo id="book-Install_Guide-Install_Guide"> <title>Installation Guide</title> - <subtitle>An Installation Guide for JBoss Enterprise Portal Platform &VZ;</subtitle> + <subtitle>for use with JBoss Enterprise Portal Platform and Site Publisher &VZ;</subtitle> <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.2</productnumber> <edition>5.2.1</edition> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Configuration.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Configuration.xml 2012-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Configuration.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -1,15 +1,13 @@ -<?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; ]> <chapter id="chapter-Reference_Guide-Configuration"> - <title>Configuration</title> - - <xi:include href="DatabaseConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="EMailServiceConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="ClusteringConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="HTTPSConfiguration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="GadgetProxyConfig.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <title>Configuration</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="DatabaseConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="EMailServiceConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ClusteringConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="HTTPSConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GadgetProxyConfig.xml"/> </chapter> - Added: epp/docs/branches/5.2/Installation_Guide/en-US/Customer_Portal.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Customer_Portal.xml (rev 0) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Customer_Portal.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -0,0 +1,25 @@ +<?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.3/docbookx.dtd" [ +]> +<appendix id="Accessing_the_Customer_Service_Portal"> + <title>The Red Hat Customer Portal</title> + <itemizedlist> + <listitem> + <para> + See + <xref linkend="Installation_With_ZIP_Download"/> + for ZIP installation instructions. + </para> + </listitem> + <listitem> + <para> + See <xref linkend="Install_Native_Components"/> for Native Component installation instructions. + </para> + </listitem> +<!-- PicketLink is integrated into the ZIP and Graphical installer, there is no separate download --><!-- <listitem> + <para> + To install the PicketLink Federation Technical Preview, choose the PicketLink Technical Preview download. See + <xref linkend=""/> for PicketLink Federation Technical Preview Installation Instructions. + </para> + </listitem> --> </itemizedlist> +</appendix> 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-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Getting_Started.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -23,24 +23,16 @@ <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="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>The platform itself requires a minimum of 550MB. The mandatory Java Development Kit (JDK) requires up to 150MB. </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>A number of factors affect the minimum hardware required to support JBoss Enterprise Portal Platform: </para> </formalpara> <itemizedlist> @@ -60,313 +52,52 @@ </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: + <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> + <para>The absolute minimum requirements for an operational server are: </para> - <itemizedlist> - <listitem> - <para> - Disk Space: 1.5 GB - </para> - <itemizedlist> - <listitem> - <para> + <variablelist> + <varlistentry> + <term> Disk Space: 1.5 GB</term> + <listitem> + <para> The default server log file storage configuration is 500MB. </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> + The remaining space 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> - CPU: Intel Pentium Processor @ 1GHz - </para> - <itemizedlist> - <listitem> - <para> - Core 2 Duo, Core 2 Quad and Intel Xeon chips will improve the performance of servers which experience high demand. + </listitem> + </varlistentry> + <varlistentry> + <term> CPU: Intel Pentium Processor @ 1GHz</term> + <listitem> + <para>Intel Core 2 Duo, Intel Core 2 Quad, and Intel Xeon chips will improve high demand server performance. </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - RAM: 1.5 GB - </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. + </listitem> + </varlistentry> + <varlistentry> + <term> RAM: 1.5 GB</term> + <listitem> + <para>2 GB or more is required to run a server on which small to medium applications are deployed. </para> + <para>4 GB or more is preferable for larger applications, or to run a Graphical User Interface (GUI) server interface. </para> - </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> + </listitem> + </varlistentry> + </variablelist> <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...;. + For the latest information on supported JBoss Enterprise Portal Platform technology combinations, refer to <ulink url="http://www.jboss.com/products/platforms/portals/testedconfigura...;. </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 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> - Entries shown for each release are supported <emphasis role="bold">in addition to those in previous releases</emphasis>: - </para> -<!-- 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 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*"/> - <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> <section id="Pre_Requisites-Configuring_Your_Java_Environment"> - <title>Configure Java</title> + <title>Java Requirements</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> - <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>Before going to production, restrict login servlet access to POST to prevent unauthorized logins. - </para> - <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[ -<security-constraint> - <web-resource-collection> - <web-resource-name>login</web-resource-name> - <url-pattern>/login</url-pattern> - <http-method>GET</http-method> - <http-method>PUT</http-method> - <http-method>DELETE</http-method> - <http-method>HEAD</http-method> - <http-method>OPTIONS</http-method> - <http-method>TRACE</http-method> - </web-resource-collection> - <auth-constraint/> -</security-constraint> ]]></programlisting> - <para> - Doing this will render the login links provided on the front page inactive. - </para> - </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-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Installation.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -31,49 +31,5 @@ </listitem> </itemizedlist> </para> - <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 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>Choose a Server Profile</title> - <para> - The important differences between the Portal and JBoss Enterprise Application Platform server configurations are: - - <itemizedlist> - <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 is the server configuration that is started when no other configuration is specified. - </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> - 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> - </para> - <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> </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-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Installation_Guide.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -1,16 +1,16 @@ <?xml version='1.0' encoding='UTF-8'?> <!-- This document was created with Syntext Serna Free. --><!DOCTYPE book 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; ]> <book status="draft"> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/> <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="Installation_With_ZIP_Download.xml" encoding="UTF-8"/> <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="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"/> Added: epp/docs/branches/5.2/Installation_Guide/en-US/Installation_With_ZIP_Download.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Installation_With_ZIP_Download.xml (rev 0) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Installation_With_ZIP_Download.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -0,0 +1,133 @@ +<?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" []> +<!-- Chapter sources: + JBPAPP-4551 - WS CXF Installation + + --> +<chapter id="Installation_With_ZIP_Download"> + <title>ZIP Installation from the Red Hat Customer Portal</title> + <para>The Red Hat Customer Portal at <ulink url="http://access.redhat.com">http://access.redhat.com</ulink> + provides access to the value of the Red Hat Subscription, including knowledge base articles, support case management, + and file downloads. + </para> + <task id="task-Download_Installation_Files"> + <title>Task: Download Installation Files</title> + <tasksummary> + <para>Complete this task to download the Zip archives from the Red Hat Customer Portal used to install the platform, and Site Publisher .</para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>You have a login to the Red Hat Customer Portal ( + <ulink url="http://access.redhat.com">http://access.redhat.com</ulink> + ). + </para> + </listitem> + <listitem> + <para>You have a valid JBoss Enterprise Portal Platform subscription.</para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Open + <ulink url="http://access.redhat.com"/> + in a web browser. + </para> + </step> + <step> + <para>Click the + <guibutton>Downloads</guibutton> + option in the menu across the top of the page. + </para> + </step> + <step> + <para>Click on + <guibutton>Download your software</guibutton> + in the list under JBoss Enterprise Middleware. + </para> + </step> + <step> + <para>Enter your login information.</para> + <formalpara> + <title>Result:</title> + <para>You are taken to the Software Downloads page.</para> + </formalpara> + </step> + <step> + <title>Download the Portal</title> + <para>Select + <literal>Portal Platform</literal> + from either the drop-down box or the menu on the left. + </para> + <formalpara> + <title>Result:</title> + <para>You are presented with a list of file downloads.</para> + </formalpara> + </step> + <step> + <para>Click the + <filename>JBoss Portal Platform <replaceable>VERSION</replaceable></filename> + download link.</para> + </step> + <step> + <para>Click the <guibutton>Download</guibutton> link to start the Portal download.</para> + </step> + <step> + <title>Optional: Download the Site Publisher add-on</title> + <para>If you intend to use the Site Publisher add-on, select <literal>Site Publisher</literal> + from either the Software Downloads drop-down box or the menu on the left.</para> + <substeps> + <step> + <para>Click the + <filename>Site Publisher <replaceable>VERSION</replaceable> for JBoss EPP <replaceable>VERSION</replaceable></filename> + download link.</para> + </step> + <step> + <para>Click the <guibutton>Download</guibutton> link to start the Portal download.</para> + </step> + </substeps> + </step> + </procedure> + </task> + <para>Now you have downloaded the required Zip archives, you can install the platform.</para> + <task id="task-Install_The_Platform"> + <title>Task: Install the Platform</title> + <tasksummary> + <para>Complete this task to install the platform a Zip archive.</para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>Complete <xref linkend="task-Download_Installation_Files"/></para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Unzip <literal>jboss-epp-<replaceable>VERSION</replaceable>.zip</literal> to extract the archive + contents into the location of your choice. + </para> + <formalpara> + <title>Result:</title> + <para> + This creates the <filename>jboss-epp-<replaceable>VERSION</replaceable></filename> directory, + with an installation of JBoss Enterprise Portal Platform in its default configuration.</para> + </formalpara> + </step> +<!--<step> + <title>Optional: Install Native Components</title> + <para>Refer to <xref linkend="Install_Native_Components"/> for Native Component installation instructions.</para> +</step>--> <step> + <title>Optional: Site Publisher</title> + <para>If you need to install Site Publisher, complete the tasks in to <xref linkend="Site_Publisher_Installation"/>.</para> + </step> + <step> + <title>Perform post-installation configuration</title> + <para>Refer to <xref linkend="Post_Installation_Configuration"/> for post-installation configuration instructions.</para> + </step> + </procedure> + </task> +</chapter> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Introduction.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Introduction.xml 2012-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Introduction.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -1,26 +1,13 @@ -<?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="Introduction"> - <title>Introduction</title> - <para> - JBoss Enterprise Portal Platform is the open source implementation of the Java EE suite of services and Portal services running atop JBoss Enterprise Application Platform. It comprises a set of offerings for enterprise customers who are looking for pre-configured profiles of JBoss Enterprise Middleware components that have been tested and certified together to provide an integrated experience. Its easy-to-use server architecture and high flexibility makes JBoss the ideal choice for users just starting out with J2EE, as well as senior architects looking for a customizable middleware platform. - </para> - <para> - Because it is Java-based, JBoss Enterprise Portal Platform is cross-platform and easy to install and use on any operating system that supports Java. - </para> - <para> - Installing JBoss Enterprise Portal Platform is simple and easy. In this guide you will learn how to install, configure and secure JBoss Enterprise Portal Platform. - </para> - <section id="Introduction-Other_Manuals"> - <title>Other Manuals</title> - <para> - If you are looking for detailed information about other JBoss Middleware products such as JBoss Enterprise Applications Platform please refer to the manuals available online at <ulink url="http://docs.redhat.com/docs/en-US/index.html"></ulin...;. - - </para> - </section> + <title>Introduction</title> + <para>Read this guide if you are a system administrator that needs to download and install JBoss Enterprise Portal Platform, and configure the product to work in a production environment.</para> + <para>By following the tasks in this guide, you will configure mandatory settings required for the portal to start and operate correctly. The guide is structured in a way that you can jump to a relevant section of the guide at any time and have all the information you need to perform a discreet task. If you need to perform prerequisite configuration, this is declared in each task.</para> + <para>Because JBoss Enterprise Portal Platform is a JBoss Middleware product, the platform runs and is supported on JBoss Enterprise Application Platform. References to detailed information in the JBoss Enterprise Application Platform documentation is called out when required. All JBoss Enterprise Application Platform product documentation is available online at the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_... Hat Documentation Portal</ulink>. + + </para> </chapter> - Added: epp/docs/branches/5.2/Installation_Guide/en-US/Native_Components.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Native_Components.xml (rev 0) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Native_Components.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -0,0 +1,103 @@ +<?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.3/docbookx.dtd" [ +]> +<chapter id="Install_Native_Components"> + <title>Install Native Components</title> + <formalpara> + <title>The Native Components Package</title> + <para> + The Native Components package is an optional component for the JBoss Enterprise Application Platform that incorporates + native operating system components and connectors for web servers, including OpenSSL, JBoss Native, mod_jk, + mod_cluster, NSAPI for Solaris, ISAPI for Windows, HornetQ LibAIO Native for Red Hat Enterprise Linux. + </para> + </formalpara> + <para> + Installing JBoss Native results in higher server performance, as native operating system + code becomes available for the server to optimize tasks. + </para> + <para> + For more information on configuring the web server connectors, refer to the JBoss Enterprise Application Platform + <citetitle>HTTP Connectors Load Balancing Guide</citetitle>.</para> + <itemizedlist> + <title>Native Components Manifest</title> + <listitem> + <para> + JBoss Native consists of the Apache Portable Runtime (APR), OpenSSL and Tomcat Native (TC-native); + </para> + <itemizedlist> + <listitem> + <para> + <literal>Apache Portable Runtime (APR)</literal> provides superior scalability, performance, and improved integration with + native server technologies. APR is a highly portable library that is at the heart of Apache HTTP Server 2.x. + It enables access to advanced IO functionality (for example: sendfile, epoll and OpenSSL), Operating System + level functionality (for example: random number generation and system status), and native process handling + (shared memory, NT pipes and Unix sockets). + </para> + </listitem> + <listitem> + <para> + <literal>OpenSSL</literal> implements the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocols and + includes a basic cryptographic library. + </para> + </listitem> + <listitem> + <para> + <literal>Tomcat Native (TC-Native)</literal> is a Java Native Interface (JNI) that provides much of Tomcat&apos;s core functionality + in native code rather than Java. This allows for an overall increase in the speed of a server. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <literal>mod_jk</literal> connects the Tomcat JSP container to the Apache webserver, providing load-balancing. + </para> + </listitem> + <listitem> + <para> + <literal>mod_cluster</literal> is an httpd-based load balancer. In contrast to mod_jk, mod_cluster creates a feedback + loop between the proxy server and the worker nodes, enabling intelligent load distribution and routing within a + load-balancing cluster. + </para> + </listitem> + <listitem> + <para> + <literal>ISAPI</literal> is a connector for the Microsoft IIS web server. + </para> + </listitem> + <listitem> + <para> + HornetQ LibAIO is used as a bridge between HornetQ and Linux LibAIO. It is used in HornetQ&apos;s high performance journal, when configured. + </para> + </listitem> + </itemizedlist> + <section> + <title>Red Hat Enterprise Linux-specific notes</title> + <para> + Red Hat Enterprise Linux includes some of the Native Components in the base operating system. + These include OpenSSL and the Apache Portable Runtime (APR). The Apache Portable Runtime is provided by the packages + <filename>apr</filename> and <filename>apr-util</filename>. + </para> + <para> + If the server is started without the <filename>apr</filename> and <filename>apr-util</filename> packages + installed, a message similar to the following will appear in logs: + </para> + <programlisting>WARN [AprLifecycleListener] The Apache Tomcat Native library which allows optimal performance +in production environments was not found on the java.library.path: +/home/eapuser/jboss-eap-5.1/native/lib. + </programlisting> + </section> + <section> + <title>Solaris-specific notes</title> + <para> + Both the 32-bit and 64-bit versions of <filename>jboss-ep-native</filename> can be installed on the same + machine. The libraries for each are separated by the directories <filename>lib</filename> and + <filename>lib64</filename> respectively and each is automatically loaded depending on the JVM version that is + used. + </para> + <para> + To install both 32-bit and 64-bit versions of <filename>jboss-ep-native</filename>, use <command>unzip -qo</command>. The <code>-o</code> option ensures that one version of the package does not replace another + during the installation. + </para> + </section> +</chapter> 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-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Post_Installation.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -5,6 +5,44 @@ ]> <chapter id="Post_Installation_Configuration"> <title>Post Installation Configuration</title> + <section id="server-config-differences"> + <title>Choose a Server Profile</title> + <para>The server profiles shipped with the platform include: <literal>minimal</literal>, <literal>default</literal>, <literal>production</literal>, <literal>all</literal>, <literal>standard</literal> and <literal>web</literal>. + </para> + <para>There are important differences between the Portal and JBoss Enterprise Application Platform server profiles: + <itemizedlist> + <listitem> + <para> + The <literal>minimal</literal>, <literal>web</literal> and <literal>standard</literal> server profiles do not contain any Portal relevant components. These profiles exist for the sake of consistency with JBoss Enterprise Application Platform. </para> + </listitem> + <listitem> + <para> + The <literal>default</literal> server profile includes non-clustered Portal components. This is the server configuration that is started when no other configuration is specified. + </para> + </listitem> + <listitem> + <para> + the <literal>all</literal> server profile includes the Portal and services used for running on a cluster. + </para> + </listitem> + <listitem> + <para> + the <literal>production</literal> server profile includes Portal components and clustering services. It is pre-configured with default settings which would be more accurate for a production environment. + </para> + </listitem> + <listitem> + <para> + The <filename>gatein.ear</filename> archive containing the portal components is located in the <filename>/deploy</filename> directory of the <literal>default</literal>, <literal>all</literal> and <literal>production</literal> server profiles. + </para> + </listitem> + </itemizedlist> + </para> + <note> + <para> + 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 profiles. + </para> + </note> + </section> <section id="Set_JBOSS_HOME"> <title> Set JBOSS_HOME Environment Variable </title> <formalpara> @@ -52,192 +90,62 @@ 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>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>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>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>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>PROFILE</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: - </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>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>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=&quot;suckerPassword&quot;&gt;CHANGE ME!!&lt;/property&gt; -</programlisting> - </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> - </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=&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: - </para> -<programlisting language="XML" role="XML">&lt;bean name="SecurityStore" -class="org.jboss.jms.server.jbosssx.JBossASSecurityMetadataStore"&gt; - &lt;!­­ default security configuration ­­­&gt; - ­... - ­... - ­... - &lt;property name="suckerPassword"&gt;CHANGE ME!!&lt;/property&gt; - ­... - ­... - ­... -&lt;/bean&gt; -</programlisting>--> </section> + <para>The JBoss Enterprise Application Platform <citetitle>Installation Guide</citetitle> features a comprehensive chapter about <citetitle>Post Installation Security Configuration</citetitle>. Refer to this chapter for the guidance on the following required configuration tasks:</para> + <itemizedlist> + <listitem> + <para>Security Configuration: JMX Console, Admin Console, HttpInvoker</para> + </listitem> + <listitem> + <para>Security Configuration: JBoss Messaging</para> + </listitem> + </itemizedlist> + </section> <section id="Disabling_Authentication"> <title>Disable Authentication</title> + <para>The JBoss Enterprise Application Platform <citetitle>Installation Guide</citetitle> features a comprehensive chapter about <citetitle>Disabling Authentication</citetitle>. Refer to this chapter for the guidance on the following configuration tasks:</para> + <itemizedlist> + <listitem> + <para>Disabling Authentication for JMX Console</para> + </listitem> + <listitem> + <para>Disabling Authentication for Web Console</para> + </listitem> + <listitem> + <para>Disabling Authentication for HTTP Invoker</para> + </listitem> + <listitem> + <para>Disabling Authentication for JMX Invoker</para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Disable Pre-configured Accounts</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>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"> -&lt;security-constraint&gt; - &lt;web-resource-collection&gt; - &lt;web-resource-name&gt;HtmlAdaptor&lt;/web-resource-name&gt; - &lt;description&gt;An example security config that only allows -users with the -role JBossAdmin to access the HTML JMX console web application - &lt;/description&gt; - &lt;url-pattern&gt;/*&lt;/url-pattern&gt; - &lt;/web-resource-collection&gt; - &lt;auth-constraint&gt; - &lt;role-name&gt;JBossAdmin&lt;/role-name&gt; - &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>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; - &lt;description&gt;An example security config that only allows -users with the role JBossAdmin to access the HTML JMX console web application - &lt;/description&gt; - &lt;url-pattern&gt;/*&lt;/url-pattern&gt; - &lt;http-method&gt;GET&lt;/http-method&gt; - &lt;http-method&gt;POST&lt;/http-method&gt; - &lt;/web-resource-collection&gt; - &lt;auth-constraint&gt; - &lt;role-name&gt;JBossAdmin&lt;/role-name&gt; - &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> - <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; - &lt;description&gt;An example security config that only allows -users with the role HttpInvoker to access the HTTP invoker servlets - &lt;/description&gt; - &lt;url-pattern&gt;/restricted/*&lt;/url-pattern&gt; - &lt;http-method&gt;GET&lt;/http-method&gt; - &lt;http-method&gt;POST&lt;/http-method&gt; - &lt;/web-resource-collection&gt; - &lt;auth-constraint&gt; - &lt;role-name&gt;HttpInvoker&lt;/role-name&gt; - &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> - <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"> -&lt;descriptors&gt; - &lt;interceptors&gt; - &lt;!-- Uncomment to require authenticated users --&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=&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> 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> 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>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: - </para> - <programlisting language="XML" role="XML"><![CDATA[ + <task> + <title>Task: Restrict Login Servlet Access</title> + <tasksummary> + <para>Complete this task to restrict access to the default testing users, which are enabled by default in a clean installation.</para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>The platform is installed, and you have performed or assessed all tasks to this point.</para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Open <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> in your preferred text editor.</para> + </step> + <step> + <para>Append the following &lt;security-constraint&gt; block to the file:</para> + <programlisting language="XML"><![CDATA[ <security-constraint> <web-resource-collection> <web-resource-name>login</web-resource-name> @@ -251,8 +159,20 @@ </web-resource-collection> <auth-constraint/> </security-constraint> ]]></programlisting> - <para> - Doing this will render the login links provided on the front page inactive. + </step> + <step> + <formalpara> + <title>Result</title> + <para>The login links present on the front page of the portal main screen are not displayed, and the accounts are not available for use. </para> + </formalpara> + </step> + </procedure> + </task> </section> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="DatabaseConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="EMailServiceConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ClusteringConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="HTTPSConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GadgetProxyConfig.xml"/> </chapter> Modified: epp/docs/branches/5.2/Installation_Guide/en-US/SP_Installation.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/SP_Installation.xml 2012-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/SP_Installation.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -58,8 +58,7 @@ </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>If you intend using a custom configuration profile, copy the files into the corresponding location of your profile. </para> </section> <section> @@ -74,7 +73,7 @@ <title>Prerequisites</title> <itemizedlist> <listitem> - <para>You have installed a clean instance of JBoss Enterprise Portal Platform 5.1.0 or later.</para> + <para>Complete <xref linkend="task-Install_The_Platform"/> </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> @@ -83,13 +82,9 @@ </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> + <para>Extract the contents of the downloaded Zip archive to a local directory on the clean JBoss Enterprise Portal Platform instance.</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> @@ -118,6 +113,16 @@ </listitem> </itemizedlist> </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> + <step> + <title>Perform post-installation configuration</title> + <para>Refer to <xref linkend="Post_Installation_Configuration"/> for post-installation configuration instructions.</para> + </step> <!-- Removed from live text as SP documentation relies on ecmdemo being deployed. <step> <para> @@ -158,13 +163,7 @@ 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> + </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> 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-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Test_Your_Installation.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -23,8 +23,14 @@ <title>Prerequisites</title> <itemizedlist> <listitem> - <para>Complete all previous tasks and procedures in this user guide, or assess each task for relevance to your installation.</para> + <para>Complete all tasks in <xref linkend="Installation_With_ZIP_Download"/>.</para> </listitem> + <listitem> + <para>Complete all tasks in <xref linkend="Site_Publisher_Installation"/>, if you intend running Site Publisher.</para> + </listitem> + <listitem> + <para>Complete all tasks in <xref linkend="Post_Installation_Configuration"/>.</para> + </listitem> </itemizedlist> </taskprerequisites> <procedure> @@ -38,8 +44,7 @@ </para> <example> <title>Sample Server Output using Production</title> - <para> - The example below uses the production configuration. Your output should look like the following (accounting for installation directory differences and version numbers) and should not contain any error or exception messages: + <para>The example uses the production configuration. Your output should look like the following (accounting for installation directory differences and version numbers) and should not contain any error or exception messages: </para> <programlisting>[user@localhost bin]$ ./run.sh -c production ========================================================================= Modified: epp/docs/branches/5.2/Installation_Guide/en-US/Uninstall_JBoss.xml =================================================================== --- epp/docs/branches/5.2/Installation_Guide/en-US/Uninstall_JBoss.xml 2012-03-01 18:25:22 UTC (rev 8525) +++ epp/docs/branches/5.2/Installation_Guide/en-US/Uninstall_JBoss.xml 2012-03-02 04:11:02 UTC (rev 8526) @@ -1,10 +1,75 @@ <?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="Uninstall_JBoss"> - <title>Remove the Platform</title> - <para>You can remove the platform by deleting the JBoss Enterprise Portal Platform directory installed on your system. - </para> + <title>Remove JBoss Enterprise Application Platform</title> +<!--Divide into GUI/CLI procedures. +<para> + There are several options for uninstalling JBoss Enterprise Application Platform. The options available to you depend on your installation method. +</para> + +<section> + <title>If you used the graphical installation</title> + <para> + There are two options for uninstalling if you installed using the graphical installer; you can uninstall with either the graphical uninstaller, or via the command line. + </para> + <procedure> + <title>Graphical uninstall</title> + <step> + <para> + + </para> + </step> + <step performance="optional"> + <para> + + </para> + </step> + + +</section> + +<section> + <title>If you used the ZIP installation</title> + + + + +</section> +--> <task> + <title>Remove Platform By Deleting Root Installation Directory </title> + <tasksummary> + <para>Complete this task to remove the root installation directory, which removes the platform from your system. To verify the root installation directory, ensure the directory contains the <filename>/jboss-as</filename> directory.</para> + </tasksummary> + <taskprerequisites> + <title>Prerequisites</title> + <itemizedlist> + <listitem> + <para>A JBoss Enterprise Portal Platform instance, originally installed using the <xref linkend="Installation_With_ZIP_Download"/> method.</para> + </listitem> + </itemizedlist> + </taskprerequisites> + <procedure> + <step> + <para>Open a terminal.</para> + </step> + <step> + <para>Navigate to the location where you installed the platform.</para> + </step> + <step> + <warning> + <para>This step completely removes the platform, and all related configuration files stored in the location indicated in Step 2. Ensure you have made copies of configuration files you may want to reuse if you decide to reinstall the platform later.</para> + </warning> + <para>Execute the following command, substituting <replaceable>[root_folder_name]</replaceable> with the full path, and name of the platform&apos;s root installation folder. </para> + <para>If you installed the platform to a protected directory on your system, ensure you run this command with the correct access privileges.</para> + <programlisting>[home]$ rm -r <replaceable>[root_folder_name]</replaceable></programlisting> + </step> + <step> + <formalpara> + <title>Result</title> + <para>You have completely removed the platform, and all related configuration files and folders from the original installation location. </para> + </formalpara> + </step> + </procedure> + </task> </chapter>