[portal-commits] JBoss Portal SVN: r12331 - in docs/enterprise/trunk/Installation_Guide/en-US: images and 1 other directory.

Author: sradvan Date: 2008-12-03 00:04:12 -0500 (Wed, 03 Dec 2008) New Revision: 12331 Added: docs/enterprise/trunk/Installation_Guide/en-US/Author_Group.xml docs/enterprise/trunk/Installation_Guide/en-US/Book_Info.xml docs/enterprise/trunk/Installation_Guide/en-US/Configuration.xml docs/enterprise/trunk/Installation_Guide/en-US/Databases.xml docs/enterprise/trunk/Installation_Guide/en-US/Getting_Started.xml docs/enterprise/trunk/Installation_Guide/en-US/Installation.xml docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide_CP03.ent docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide_CP03.xml docs/enterprise/trunk/Installation_Guide/en-US/Introduction.xml docs/enterprise/trunk/Installation_Guide/en-US/Post_Installation.xml docs/enterprise/trunk/Installation_Guide/en-US/Revision_History.xml docs/enterprise/trunk/Installation_Guide/en-US/Test_Your_Installation.xml docs/enterprise/trunk/Installation_Guide/en-US/Uninstall_JBoss.xml docs/enterprise/trunk/Installation_Guide/en-US/images/ docs/enterprise/trunk/Installation_Guide/en-US/images/step3.png docs/enterprise/trunk/Installation_Guide/en-US/images/step4.png docs/enterprise/trunk/Installation_Guide/en-US/images/step8.png docs/enterprise/trunk/Installation_Guide/en-US/images/test_install.png docs/enterprise/trunk/Installation_Guide/en-US/images/title.jpg docs/enterprise/trunk/Installation_Guide/en-US/images/uninstall.png Log: merging EPP guide info to EAP install guide Added: docs/enterprise/trunk/Installation_Guide/en-US/Author_Group.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Author_Group.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Author_Group.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,10 @@ +<?xml version='1.0'?> +<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> + +<authorgroup> +<author> + <firstname>Red Hat Documentation Group</firstname> + <surname></surname> + </author> +</authorgroup> Added: docs/enterprise/trunk/Installation_Guide/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Book_Info.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Book_Info.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,31 @@ +<?xml version='1.0'?> +<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> + +<bookinfo id="Installation_Guide_JBoss_Enterprise_Application_Platform"> + <title>Installation Guide CP03</title> + <subtitle>For use with JBoss Enterprise Application Platform 4.3 Cumulative Patch 3</subtitle> + <edition>2.0</edition> + <pubsnumber>4</pubsnumber> + <productname>JBoss Enterprise Application Platform</productname> + <productnumber>4.3</productnumber> + <pubdate>Dec, 2008</pubdate> + <isbn>N/A</isbn> + <abstract><para>This Installation Guide documents relevant information regarding +the installation of JBoss Enterprise Application Platform</para> + </abstract> + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="Common_Content/images/redhat-logo.svg" /> + </imageobject> + </inlinemediaobject> + </corpauthor> + <copyright> + <year>&YEAR;</year> + <holder>&HOLDER;</holder> + </copyright> + <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</bookinfo> + Added: docs/enterprise/trunk/Installation_Guide/en-US/Configuration.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Configuration.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Configuration.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,55 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<chapter> + <title>Database Configuration</title> + + <section id="sect-Portal_EAP-Configuration-Installing_an_RDBMS_JDBC_connector"> + <title>Installing an RDBMS JDBC connector</title> + <para> + A relational database management system (RDBMS) Java Database Connectivity (JDBC) connector is required for JBoss Portal to communicate with a database. Test suites have been run against the <trademark class="registered">Oracle</trademark> 9, <trademark class="registered">Oracle</trademark> 10, <trademark class="registered">Microsoft SQL Server</trademark>, MySQL 4, MySQL 5, and PostgreSQL 8 databases - these databases are recommended for production use. Please refer to your database documentation for the correct RDBMS JDBC connector. The MySQL RDBMS JDBC connector can be downloaded from <ulink url="http://www.mysql.com/products/connector/j/"></ulink>;, and the PostgreSQL RDBMS JDBC connector can be downloaded from <ulink url="http://jdbc.postgresql.org/download.html"></ulink>;. + </para> + <para> + Refer to the help files in each download for installation instructions. In most cases, the RDBMS JDBC connector comes as a <computeroutput>.jar</computeroutput> file. Copy this file into the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/lib/</filename> directory. + </para> + </section> + + <section id="sect-Portal_EAP-Configuration-Datasource_Descriptors"> + <title>Datasource Descriptors</title> + <para> + A Datasource descriptor is required for JBoss Portal to communicate with a database. Sample Datasource descriptor files are provided for the Hypersonic SQL, <trademark class="registered">Microsoft SQL Server</trademark>, MySQL, <trademark class="registered">Oracle</trademark>, and PostgreSQL databases. These can be found in the <filename>setup/</filename> subdirectory where the <computeroutput>JBoss Portal <replaceable>x.x.x</replaceable> binary distribution</computeroutput> file was extracted to. For example, if JBoss Portal was extracted into the <filename>/jboss/</filename> directory, the sample Datasource descriptors would be in the <filename>/jboss/jboss-portal-<replaceable>x.x.x</replaceable>/setup/</filename> directory. + </para> + <para> + The sample Datasource descriptors will work with default installations of external databases; however, you may need to configure the correct username and password. As well, the sample MySQL and PostgreSQL Datasource descriptors assume the name of the database to be <computeroutput>jbossportal</computeroutput>. + </para> + <para> + When copying a Datasource descriptor for MySQL, <trademark class="registered">Microsoft SQL Server</trademark>, PostgreSQL, or <trademark class="registered">Oracle</trademark> databases, change the <computeroutput>&lt;user-name&gt;<replaceable>portal</replaceable>&lt;/user-name&gt;</computeroutput> and <computeroutput>&lt;password&gt;<replaceable>portalpassword</replaceable>&lt;/password&gt;</computeroutput> sections to reflect the correct username and password for the user who has access to the jbossportal database. + </para> + <important> + <title>Different Datasource Descriptors</title> + <para> + Only have one Datasource descriptor in the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename> directory. For example, if you want to use a MySQL database, remove the <filename>portal-hsqldb-ds.xml</filename> file, and other descriptors, if they exists. + </para> + </important> + <para> + The following is an example Datasource descriptor file for MySQL 5: + </para> + <para> +<screen> +&lt;?xml version="1.0" encoding="UTF-8"?&gt; +&lt;datasources&gt; + &lt;local-tx-datasource&gt; + &lt;jndi-name&gt;PortalDS&lt;/jndi-name&gt; + &lt;connection-url&gt;jdbc:mysql://localhost:3306/jbossportal? + useServerPrepStmts=false&amp;amp&semi;jdbcCompliantTruncation=false&lt;/connection-url&gt; + &lt;driver-class&gt;com.mysql.jdbc.Driver&lt;/driver-class&gt; + &lt;user-name&gt;&lt;replaceable&gt;portal&lt;/replaceable&gt;&lt;/user-name&gt; + &lt;password&gt;&lt;replaceable&gt;portalpassword&lt;/replaceable&gt;&lt;/password&gt; + &lt;/local-tx-datasource&gt; +&lt;/datasources&gt; +</screen> + </para> + </section> + +</chapter> + Added: docs/enterprise/trunk/Installation_Guide/en-US/Databases.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Databases.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Databases.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,196 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> + +<chapter id="chap-Portal_EAP-Databases"> + <title>Databases</title> + <para> + The following chapter contains examples for how to use the Hypersonic SQL and MySQL databases to store JBoss Portal user information. + </para> + <section id="sect-Portal_EAP-Databases-Using_a_Hypersonic_SQL_Database"> + <title>Using a Hypersonic SQL Database</title> + <para> + JBoss EAP contains an embedded <ulink url="http://hsqldb.org/">Hypersonic SQL</ulink> database instance. After starting JBoss EAP and deploying JBoss portal for the first time, the Hypersonic SQL database is created in the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/data/</filename> directory. This directory will not exist until after starting JBoss EAP and deploying JBoss Portal. The Hypersonic SQL database is used by default, but is only recommended for developer use. + </para> + <para> + To use the Hypersonic SQL database, change into the <filename>setup/</filename> subdirectory where JBoss Portal was extracted to. Copy the <filename>portal-hsqldb-ds.xml</filename> file into the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename> directory. Alternatively, copy and save the following example as <filename>portal-hsqldb-ds.xml</filename> into the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename> directory: + </para> + <para> +<screen> +&lt;?xml version="1.0" encoding="UTF-8"?&gt; +&lt;datasources&gt; + &lt;local-tx-datasource&gt; + &lt;jndi-name&gt;PortalDS&lt;/jndi-name&gt; + &lt;connection-url&gt;jdbc:hsqldb:${jboss.server.data.dir}$ + {/}portal${/}hypersonic${/}database&lt;/connection-url&gt; + &lt;driver-class&gt;org.hsqldb.jdbcDriver&lt;/driver-class&gt; + &lt;user-name&gt;sa&lt;/user-name&gt; + &lt;password&gt;&lt;![CDATA[]]&gt;&lt;/password&gt; + &lt;/local-tx-datasource&gt; +&lt;/datasources&gt; +</screen> + </para> + </section> + + <section id="sect-Portal_EAP-Databases-Using_a_MySQL_Database"> + <title>Using a MySQL Database</title> + <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Installing_the_MySQL_RDBMS_JDBC_connector"> + <title>Installing the MySQL RDBMS JDBC connector</title> + <para> + The RDBMS JDBC MySQL connector is required for JBoss Portal to use a MySQL database: + </para> + </formalpara> + <orderedlist> + <listitem> + <para> + Navigate to the <ulink url="http://dev.mysql.com/downloads/connector/j/3.1.html">JDBC MySQL connector</ulink> section of dev.mysql.com. Download the <computeroutput>Source and Binaries (zip)</computeroutput> file. + </para> + </listitem> + <listitem> + <para> + Unzip the <filename>mysql-java-connector</filename> into the desired directory. It does not matter which directory is used. + </para> + </listitem> + <listitem> + <para> + Change into the directory where the <filename>mysql-java-connector</filename> was extracted to. Copy the <filename>mysql-connector-java-<replaceable>version-number</replaceable>-bin.jar</filename> file into the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/lib/</filename> directory. + </para> + </listitem> + </orderedlist> + <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Data_Truncation_Errors"> + <title>Data Truncation Errors</title> + <para> + If you are running MySQL 5, data truncation errors such as the following may occur: + </para> + </formalpara> + <para> +<screen> +ERROR JDBCExceptionReporter Data truncation: Data too long for column &#39;jbp_viewrealemail&#39; at row 1 +</screen> + </para> + <para> + If you are running MySQL in strict mode, remove <computeroutput>STRICT_TRANS_TABLES</computeroutput> from the <computeroutput>sql-mode=</computeroutput> line, in the <filename>my.cnf</filename> file if you are running Linux, and from the <filename>my.cfg</filename> file if you are running <trademark class="registered">Windows</trademark>. For further information, please see <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=AvoidMySQL5DataTruncat...;. + </para> + <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"> + <title>Creating a MySQL Database</title> + <para> + If you have just installed MySQL, make sure the MySQL server is running, and then run the following command to set the root user password: + </para> + </formalpara> + <para> +<screen> +mysqladmin -u root password &#39;<replaceable>new-root-user-password</replaceable>&#39; +</screen> + </para> + <orderedlist> + <listitem> + <para> + Run the following command to log in to MySQL. Enter the root user password when prompted: + </para> + <para> +<screen> +mysql -u root -p +</screen> + </para> + </listitem> + <listitem> + <para> + Use the <command>CREATE DATABASE</command> command to create a new jbossportal database. Note: the rest of this guide, and configuration examples following here after, assume the database name to be jbossportal. If you change the database name, please change the name in all necessary configuration files: + </para> + <para> +<screen> +mysql&gt; CREATE DATABASE jbossportal; +</screen> + </para> + <para> + The output should be similar to the following: + </para> + <para> +<screen> +Query OK, 1 row affected (0.00 sec) +</screen> + </para> + <para> + At this point, the <command>SHOW DATABASES;</command> command should display the <command>jbossportal</command> database: + </para> + <para> +<screen> +mysql&gt; SHOW DATABASES; ++--------------------+ +| Database | ++--------------------+ +| information_schema | +| jbossportal | +| mysql | ++--------------------+ +3 rows in set (0.00 sec) +</screen> + </para> + <para> + It is safe to ignore the other databases. + </para> + </listitem> + <listitem> + <para> + Add a new user and give that user access to the jbossportal database. The following example adds a new user named <computeroutput>portal</computeroutput>, with the password <computeroutput>portalpassword</computeroutput>, and gives the portal user access to the jbossportal database. It is recommended that you change the password. Change <replaceable>portalpassword</replaceable> to change the password: + </para> + <para> +<screen> +mysql&gt; GRANT ALL PRIVILEGES ON jbossportal.* TO &#39;<replaceable>portal</replaceable>&#39;@&#39;localhost&#39; +IDENTIFIED BY &#39;<replaceable>portalpassword</replaceable>&#39; WITH GRANT OPTION; +</screen> + </para> + <para> + The output should be similar to the following: + </para> + <para> +<screen> +Query OK, 0 rows affected (0.00 sec) +</screen> + </para> + <para> + If you changed the portal user&#39;s password, also change the password in the MySQL Datasource descriptor. + </para> + </listitem> + </orderedlist> + <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-MySQL_Datasource_Descriptor"> + <title>MySQL Datasource Descriptor</title> + <para> + To install the MySQL Datasource descriptor: + </para> + </formalpara> + <orderedlist> + <listitem> + <para> + Change into the <filename>setup</filename> subdirectory where JBoss Portal was extracted to. Copy the MySQL Datasource descriptor into the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/</filename> directory. If you are running MySQL 5, use <filename>portal-mysql5-ds.xml</filename>, otherwise use <filename>portal-mysql-ds.xml</filename>. + </para> + </listitem> + <listitem> + <para> + Update the <computeroutput>&lt;user-name&gt;<replaceable>portal</replaceable>&lt;/user-name&gt;</computeroutput> and <computeroutput>&lt;password&gt;<replaceable>portalpassword</replaceable>&lt;/password&gt;</computeroutput> sections in the Datasource descriptor to reflect the correct username and password for the user who has access to the jbossportal database. + </para> + </listitem> + </orderedlist> + <formalpara id="form-Portal_EAP-Using_a_MySQL_Database-MySQL_Table_Errors"> + <title>MySQL Table Errors</title> + <para> + Tables are set up automatically when JBoss Portal first starts. Initially, two users will be stored in the jbossportal MySQL database: a standard user with the username user, and the password user, and an administrative user with the username admin, and the password admin. Since the database tables are created during initial startup, errors such as the following may occur, but are safe to ignore: + </para> + </formalpara> + <para> +<screen> +WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02 +ERROR [JDBCExceptionReporter] Table &#39;jbossportal.jbp_cms_repositoryentry&#39; doesn&#39;t exist +WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02 +ERROR [JDBCExceptionReporter] Table &#39;jbossportal.jbp_cms_version_refs&#39; doesn&#39;t exist +WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02 +ERROR [JDBCExceptionReporter] Table &#39;jbossportal.jbp_cms_wsp_node&#39; doesn&#39;t exist +WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02 +ERROR [JDBCExceptionReporter] Table &#39;jbossportal.jbp_cms_cmsentry&#39; doesn&#39;t exist +WARN [JDBCExceptionReporter] SQL Error: 1146, SQLState: 42S02 +</screen> + </para> + </section> + +</chapter> + Added: docs/enterprise/trunk/Installation_Guide/en-US/Getting_Started.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Getting_Started.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Getting_Started.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,593 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> + +<chapter id="Getting_Started"> + <title>Getting Started</title> + <section id="Getting_Started-Pre_Requisites"> + <title>Pre-Requisites</title> + <para> + You must have adequate disk space<!--TODO how much --> to install JDK and &JBEAP; while also allowing enough space for your applications. Before installing &JBEAP; you must have a working installation of Java. Since JBoss is 100% pure Java you can have it working on any Operating System / Platform that supports Java. However, there are a few Operating System-specific issues that you should be aware of. Refer to <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossOperatingSystemSp... for more information. + </para> + <section id="Pre_Requisites-Hardware_and_Operating_System_Requirements"> + <title>Hardware and Operating System Requirements</title> + + <para>For the latest information on supported Operating System / JVM combinations and supported Database platforms, please refer to <ulink url="http://www.jboss.com/products/platforms/application/testedconfi...;. + </para> + <!-- <para> + The following is a list of supported operating systems and JVM version combination: + </para> + + <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> + <tbody> + <row> + <entry> + <emphasis>Operating System</emphasis> + </entry> + <entry> + <emphasis>JVM Version</emphasis> + </entry> + </row> + <row> + <entry> + RHEL 4.5 x86 + </entry> + <entry> + Sun JVM 1.5 latest + </entry> + </row> + <row> + <entry> + RHEL 4.5 x86_64 + </entry> + <entry> + Sun JVM 1.5 latest + </entry> + </row> + <row> + <entry> + RHEL 5 x86 + </entry> + <entry> + Sun JVM 1.5 latest + </entry> + </row> + <row> + <entry> + RHEL 5 x86_64 + </entry> + <entry> + Sun JVM 1.5 latest + </entry> + </row> + <row> + <entry> + RHEL 4.5 x86 + </entry> + <entry> + BEA JRockit 1.5 latest + </entry> + </row> + <row> + <entry> + RHEL 4.5 x86_64 + </entry> + <entry> + BEA JRockit 1.5 latest + </entry> + </row> + <row> + <entry> + RHEL 5 x86 + </entry> + <entry> + BEA JRockit 1.5 latest + </entry> + </row> + <row> + <entry> + RHEL 5 x86_64 + </entry> + <entry> + BEA JRockit 1.5 latest + </entry> + </row> + <row> + <entry> + Solaris SPARC 9 + </entry> + <entry> + Sun JVM 1.5 latest + </entry> + </row> + <row> + <entry> + MS-Windows 2003 x86 + </entry> + <entry> + Sun JVM 1.5 latest + </entry> + </row> + <row> + <entry> + MS-Windows 2003 x86_64 + </entry> + <entry> + Sun JVM 1.5 latest + </entry> + </row> + <row> + <entry> + MS-Windows 2003 x86 + </entry> + <entry> + BEA JRockit 1.5 latest + </entry> + </row> + <row> + <entry> + MS-Windows 2003 x86_64 + </entry> + <entry> + BEA JRockit 1.5 latest + </entry> + </row> + <row> + <entry> + Solaris SPARC 10 + </entry> + <entry> + Sun JVM 1.5 latest + </entry> + </row> + <row> + <entry> + HP 11i 1,2 RISC + </entry> + <entry> + HP JVM + </entry> + </row> + <row> + <entry> + HP 11i, 1,2 ia64 + </entry> + <entry> + HP JVM + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + The following is a list of supported databases and database drivers: + </para> + + <table> + <title> + Supported Database / Database driver Combinations. + </title> + + <tgroup cols="2"> + <colspec colnum="1" colname="DB" colwidth="1*"></colspec> + <colspec colnum="2" colname="DB_driver" colwidth="1*"></colspec> + <tbody> + <row> + <entry> + <emphasis>Database</emphasis> + </entry> + <entry> + <emphasis>Database driver</emphasis> + </entry> + </row> + <row> + <entry> + Oracle 9i + </entry> + <entry> + Oracle thin driver + </entry> + </row> + <row> + <entry> + Oracle 10g R2 + </entry> + <entry> + Oracle thin driver + </entry> + </row> + <row> + <entry> + Microsoft SQL Server 2005 + </entry> + <entry> + Microsoft JDBC Driver + </entry> + </row> + <row> + <entry> + MySQL 5.0 + </entry> + <entry> + MySQL Driver + </entry> + </row> + <row> + <entry> + Postgres SQL 8.1 + </entry> + <entry> + Postgres Driver + </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.5</emphasis> before you install &JBEAP;. 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 5.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. + <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.5GB of RAM (including free space for garbage collection optimization) should utilize the 64-bit JVM. + </para> + </listitem> + <listitem> + <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> + </listitem> + </itemizedlist> + <itemizedlist id="Configuring_Your_Java_Environment-Installing_and_Configuring_32_bit_Sun_JDK_5.0_using_RHN"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 using RHN</title> + <listitem> + <para> + Java SDKs are provided by the Red Hat Enterprise Linux 5 Supplementary channel for your Linux variant and architecture. Depending on the architecture, the channel names are: + </para> + <para> + rhel-i386-server-supplementary-5 and rhel-x86_64-server-supplementary-5 + </para> + <para> + The <command moreinfo="none">java-1.5.0-bea</command>, + <command moreinfo="none">java-1.5.0-ibm</command> and + <command moreinfo="none">java-1.5.0-sun</command> SDKs are available from + these channels. Make sure you also install the + <command moreinfo="none">-devel</command> subpackages. + </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.5.0</command> (setting <command moreinfo="none">java_sdk_1.5.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.5.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_32_bit_Sun_JDK_5.0_on_a_generic_Linux_platform"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on a generic Linux platform</title> + <listitem> + <para> + Download the Sun JDK 5.0 (Java 2 Development Kit) from Sun&#39;s website: <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">&l...;. Choose "JDK 5.0 Update &lt;x&gt;" (where x is the latest update number) for download and then select "RPM in self-extracting" file for Linux<footnote><para>Make sure you choose the appropriate file for your platform.</para></footnote>. Read the instructions on Sun&#39;s website for installing the JDK. + </para> + </listitem> + <listitem> + <para> + If you don&#39;t want to use SysV service scripts you can install the "self-extracting file" for Linux instead of choosing the "RPM in self-extracting" file. In that case you can skip the next step mentioned here. But it is recommended to use the SysV service scripts for production servers. + </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> + </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.5.0_11 is the JDK installation directory. +export JAVA_HOME=/usr/java/jdk1.5.0_11 +export PATH=$PATH:$JAVA_HOME/bin +</programlisting> + Set this variable for the user account doing 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.5 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. + <itemizedlist> + <title>Select alternatives for java, javac and java_sdk_1.5.0</title> + <listitem> + <para> + As root, type the following command at the shell prompt and you should see something like this: <programlisting> +[root@vsr ~]$ /usr/sbin/alternatives --config java +There are 2 programs which provide &#39;java&#39;. +Selection Command +----------------------------------------------- + 1 /usr/lib/jvm/jre-1.4.2-gcj/bin/java +*+ 2 /usr/lib/jvm/jre-1.5.0-sun/bin/java +Enter to keep the current selection[+], or type selection number: +</programlisting> + Make sure the Sun version [<literal>jre-1.5.0-sun</literal> in this case] is selected (marked with a &#39;+&#39; in the output), or select it by entering its number as prompted. + </para> + </listitem> + <listitem> + <para> + Repeat the same for javac and java_sdk_1.5.0. <programlisting> +[root@vsr ~]$ /usr/sbin/alternatives --config javac +There are 1 programs which provide &#39;javac&#39;. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.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.5.0 +There are 1 programs which provide &#39;java_sdk_1.5.0&#39;. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun +Enter to keep the current selection[+], or type selection number: +</programlisting> + You should verify that java, javac and java_sdk_1.5.0 all point to the same manufacturer and version. + </para> + </listitem> + </itemizedlist> + </para> + <note> + <para> + You can always override this step by setting the <literal>JAVA_HOME</literal> environment variable as explained in the previous step. + </para> + </note> + </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.5.0_11" +Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_11-b03) +Java HotSpot(TM) Client VM (build 1.5.0_11-b03, mixed mode, sharing) +</programlisting> + </para> + </listitem> + </itemizedlist> + <itemizedlist id="Configuring_Your_Java_Environment-Installing_and_Configuring_32_bit_Sun_JDK_5.0_on_Microsoft_Windows"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Microsoft Windows</title> + <listitem> + <para> + Download the Sun JDK 5.0 (Java 2 Development Kit) from Sun&#39;s website: <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">&l...;. Choose "JDK 5.0 Update &lt;x&gt;" (where x is the latest update number) for download and then select your Windows Platform options to perform the installation. + </para> + </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.5.0_11\</literal>. 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.5.0_11\jre\bin</literal>. To do this, open the Control Panel from the Start Menu, switch to Classic View if necessary, open the System Control Panel applet, select the Advanced Tab, and click on the Environment Variables button. + </para> + </listitem> + </itemizedlist> + </para> + </section> + + </section> + + <section id="Getting_Started-Components_of_JBoss_Enterprise_Application_Platform"> + <title>Components of &JBEAP;</title> + + <para>For current information on the revision level of included components please refer to <ulink url="http://www.jboss.com/products/platforms/application/components&...;. + </para> + + <!--<para> + Below is a listing of the components of &JBEAP; and their revision level at the time of writing. For an updated list of component revision levels please refer to <ulink url="http://www.redhat.com/docs/manuals/jboss">http://www.re...;. + </para> + + <para> + <table id="Components_of_JBoss_Enterprise_Application_Platform_version_4.2-Application_Platform_4.2"> + <title>Application Platform 4.2</title> + <tgroup cols="2"> + <colspec colname="Project" colnum="1" colwidth="4*"></colspec> + <colspec colname="Version" colnum="2" colwidth="4*"></colspec> + <thead> + <row> + <entry> + Project + </entry> + <entry> + Version + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + Hibernate + </entry> + <entry> + 3.2.4.SP1_CP01 + </entry> + </row> + <row> + <entry> + Hibernate Entity Manager + </entry> + <entry> + 3.2.1 + </entry> + </row> + <row> + <entry> + Hibernate Annotations + </entry> + <entry> + 3.2.1 + </entry> + </row> + <row> + <entry> + JBoss AS + </entry> + <entry> + 4.2.0 + </entry> + </row> + <row> + <entry> + JBoss MQ + </entry> + <entry> + 4.2.0 + </entry> + </row> + <row> + <entry> + JBoss Web + </entry> + <entry> + 2.0.0 + </entry> + </row> + <row> + <entry> + JBoss Transactions + </entry> + <entry> + 4.2.3.SP4 + </entry> + </row> + <row> + <entry> + JTA + </entry> + <entry> + 1.0.1B + </entry> + </row> + <row> + <entry> + JBoss EJB3 + </entry> + <entry> + RC10 + </entry> + </row> + <row> + <entry> + JBoss WS + </entry> + <entry> + 1.2.1 + </entry> + </row> + <row> + <entry> + JBoss AOP + </entry> + <entry> + 1.5.5 + </entry> + </row> + <row> + <entry> + JBoss Remoting + </entry> + <entry> + 2.0.0.SP4 + </entry> + </row> + <row> + <entry> + JBoss Serialization + </entry> + <entry> + 1.0.3 + </entry> + </row> + <row> + <entry> + JBoss Cache + </entry> + <entry> + 1.4.1.SP3 + </entry> + </row> + <row> + <entry> + JGroups + </entry> + <entry> + 2.4.1.SP3 + </entry> + </row> + <row> + <entry> + JBoss Seam + </entry> + <entry> + 1.2.0.AP + </entry> + </row> + <row> + <entry> + jBPM (JPDL) + </entry> + <entry> + 3.1.4 (Seam dependency) + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> --> + </section> + +</chapter> + Added: docs/enterprise/trunk/Installation_Guide/en-US/Installation.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Installation.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Installation.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,39 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> + +<chapter id="Installation"> + <title>Installation</title> + + <section id="Download"> + <title>Download</title> + + <para> + You can download the zip file from the JBoss Customer Service Portal (CSP), located at <ulink url="https://network.jboss.com">https://network.jboss.com</ulink>. + </para> + </section> + + <section id="Installing"> + <title>Installing</title> + + <para> + To install from a zip file, simply unzip the downloaded file to a directory of your choice. You can unzip the platform on any operating system that supports the zip format. Four types of server configurations will be included in your installation - minimal, default, production and all. The Getting Started Guide explains in detail the different server configuration file sets. + + <itemizedlist> + <listitem> + <para> + Unzip <literal>jboss-eap-<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 jbeapinstallationdir</literal> + [vsr]$ <literal>jar -xvf jboss-eap-<replaceable>&lt;release&gt;</replaceable>.zip</literal></programlisting> + </para> + </listitem> + <listitem> + <para> + You are done with the installation! You should now have a directory called <filename>jboss-eap-<replaceable>&lt;release&gt;</replaceable></filename>. Refer to the Getting Started Guide to understand and explore the Platform Directory Structure. + </para> + </listitem> + </itemizedlist> + </para> + </section> +</chapter> + Added: docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide_CP03.ent =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide_CP03.ent (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide_CP03.ent 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,4 @@ +<!ENTITY JBEAP "JBoss Enterprise Application Platform"> +<!ENTITY JBEAPVERS "4.3"> +<!ENTITY HOLDER "Red Hat, Inc"> +<!ENTITY YEAR "2008"> Added: docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide_CP03.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide_CP03.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Installation_Guide_CP03.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,16 @@ +<?xml version='1.0'?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> + +<book> + <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Getting_Started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Post_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Uninstall_JBoss.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Databases.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Test_Your_Installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> +</book> Added: docs/enterprise/trunk/Installation_Guide/en-US/Introduction.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Introduction.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Introduction.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,53 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> + +<chapter id="Introduction"> + <title>Introduction</title> + <para> + &JBEAP; is the open source implementation of the Java EE suite of services. It comprises a set of offerings for enterprise customers who are looking for preconfigured 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, &JBEAP; is cross-platform and easy to install and use on any operating system that supports Java. The readily available source code is a powerful learning tool to debug the server and understand it. It also gives you the flexibility to create customized versions for your personal or business use. + </para> + <para> + Installing &JBEAP; is simple and easy. You can have it installed and running in no time. This guide will teach you to install and uninstall JBoss.<!--: <itemizedlist> + <listitem> + <para> + How to install &JBEAP; + </para> + </listitem> + <listitem> + <para> + How to Start and Stop your JBoss AS instance + </para> + </listitem> + <listitem> + <para> + The Directory structure + </para> + </listitem> + <listitem> + <para> + The key services and configuration files + </para> + </listitem> + </itemizedlist>--> + </para> + <section id="introduction-Feedback"> + <title>Feedback</title> + <para> + If you spot a typo in this guide, or if you have thought of a way to make this manual better, we would love to hear from you! Submit a report in <ulink url="http://jira.jboss.com/jira/browse/JBPAPP">JIRA</ulin... against the Product: JBoss Enterprise Application Platform, Version: <replaceable>&lt;version&gt;</replaceable>, Component: <emphasis>Doc</emphasis>. If you have a suggestion for improving the documentation, try to be as specific as possible. If you have found an error, include the section number and some of the surrounding text so we can find it easily. + </para> + </section> + + <section id="Introduction-Other_Manuals"> + <title>Other Manuals</title> + <para> + If you are looking for detailed product information refer to the manuals available online at <ulink url="http://www.redhat.com/docs/manuals/jboss"></ulink>;. + <!--TODO mention about the other guides attached--> + </para> + </section> + +</chapter> + Added: docs/enterprise/trunk/Installation_Guide/en-US/Post_Installation.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Post_Installation.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Post_Installation.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,207 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> +<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>JBOSS_DIST/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. + <programlisting> +#In this example /home/vrenish/EnterprisePlatform-4.3.0/jboss-as is the installation directory. + export JBOSS_HOME=/home/vrenish/EnterprisePlatform-4.3.0/jboss-as + export PATH=$PATH:$JBOSS_HOME/bin + </programlisting> + Set this variable for the user account(s) that will run the server. + </para> + </formalpara> + <formalpara> + <title> + On Microsoft Windows + </title> + <para> + Create an environment variable called <literal>JBOSS_HOME</literal> that points to the installation directory, for example: C:\Program Files\EnterprisePlatform-4.3.0\jboss-as\. In order to run the server from the command line add the <filename>bin</filename> directory to your path, for example: C:\Program Files\EnterprisePlatform-4.3.0\jboss-as\bin. To do this, open the Control Panel from the Start Menu, switch to Classic View if necessary, open the System Control Panel applet, select the Advanced Tab, and click on the Environment Variables button. + </para> + </formalpara> + </section> + <section id="Adjust_Memory_Settings"> + <title>Adjust memory settings</title> + <para> + The default configuration for the server to start with, if no other configuration is specified, is the production configuration. It is recommended to run the example Seam applications that are included with the documentation using the production configuration. + </para> + <para> + To avoid memory issues, adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/server/production/run.conf</filename> with these recommended values: +<programlisting> + -Xms1303m -Xmx1303m -XX:PermSize=256m -XX:MaxPermSize=256m +</programlisting> + </para> + </section> + <section id="Post-Installation"> + <title> + Post Installation Security Configuration + </title> + <para> + When installed from the zip archive, all JBoss services require authentication to access most JBoss services, including administrative services. Additionally no user accounts are set up. This is to stop default user/password-based attacks. + </para> + + <formalpara> + <title>Set up Accounts for <literal>jmx-console</literal> and the invokers by modifying:</title> + <para> + <programlisting> + $JBOSS_HOME/server/$CONFIG/conf/props/jmx-console-users.properties + </programlisting> + </para> + </formalpara> + <formalpara> + <title>Set up Accounts for <literal>web-console</literal> users by modifying:</title> + <para> + <programlisting> + $JBOSS_HOME/server/$CONFIG/deploy/management/console-mgr.sar/ + web-console.war/WEB-INF/classes/web-console-users.properties + </programlisting> + Where <literal>$JBOSS_HOME</literal> is the install directory and <literal>$CONFIG</literal> is the server configuration being used. + </para> + </formalpara> + <formalpara> + <title>Set SuckerPassword for JBoss Messaging:</title> + <para> + JBoss Messaging makes internal connections between nodes in order to redistribute messages between clustered destinations. These connections are made with the user name of a special reserved user whose password is specified by this parameter <literal>SuckerPassword</literal> in the Server Peer configuration file: + <programlisting> + $JBOSS_HOME/server/$CONFIG/deploy/jboss-messaging.sar/messaging-service.xml + </programlisting> + Where <literal>$JBOSS_HOME</literal> is the install directory and <literal>$CONFIG</literal> is the server configuration being used. + To avoid a security risk, you MUST specify the value of the attribute <literal>SuckerPassword</literal>, failing which the default value will be used. Any one who knows the default password will be able to gain access to any destinations on the server. The following fragment should be uncommented and modified: + <programlisting> + &lt;mbean code="org.jboss.jms.server.ServerPeer" + name="jboss.messaging:service=ServerPeer" + xmbean-dd="xmdesc/ServerPeer-xmbean.xml"&gt; + ... + ... + ... + ... + &lt;!-- The password used by the message sucker connections to create connections. + THIS SHOULD ALWAYS BE CHANGED AT INSTALL TIME TO SECURE SYSTEM --&gt; + &lt;attribute name="SuckerPassword"&gt;&lt;/attribute&gt; + + ... + ... + ... + &lt;/mbean&gt; + </programlisting> + </para> + </formalpara> + </section> + <section id="Disabling_Authentication"> + <title>Disabling Authentication</title> + <para> + It is also possible to disable authentication on specific services. All specified paths in the sections below are relative to <literal>$JBOSS_HOME</literal>. + </para> + <formalpara> + <title>Disabling Authentication for JXM Console:</title> + <para> + To disable authentication for the JMX console, edit the following file and comment out the security-constraint section: + <programlisting> +server/$CONFIG/deploy/jmx-console.war/WEB-INF/web.xml + </programlisting> + The following fragment should be commented out: + <programlisting> +&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> + </para> + </formalpara> + <formalpara> + <title>Disabling Authentication for Web Console:</title> + <para> + To disable authentication for the Web console, edit the following file to comment out the security-constraint section: + <programlisting> +server/$CONFIG/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml + </programlisting> + The following fragment should be commented out: + <programlisting> +&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> + </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 file: + <programlisting> +server/$CONFIG/deploy/httpha-invoker.sar/invoker.war/WEB-INF/web.xml + </programlisting> + For example, the security-constraint element should look as follows: + <programlisting> +&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> + </para> + </formalpara> + <formalpara> + <title>Disabling Authentication for JMX Invoker:</title> + <para> + To disable authentication for the JMX invoker, edit the following file to comment out the security interceptor passthrough: + <programlisting> +server/$CONFIG/deploy/jmx-invoker-service.xml + </programlisting> + 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: + <programlisting> +&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 that deals with non-serializable results --&gt; + &lt;interceptor code="org.jboss.jmx.connector.invoker.SerializableInterceptor" + policyClass="StripModelMBeanInfoPolicy"/&gt; + &lt;/interceptors&gt; +&lt;/descriptors&gt; + </programlisting> + </para> + </formalpara> + </section> +</chapter> Added: docs/enterprise/trunk/Installation_Guide/en-US/Revision_History.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Revision_History.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Revision_History.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,26 @@ +<?xml version='1.0'?> +<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> + +<appendix id="appe-Publican-Revision_History"> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>1.0</revnumber> + <date></date> + <author> + <firstname></firstname> + <surname></surname> + <email></email> + </author> + <revdescription> + <simplelist> + <member></member> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> +</appendix> + Added: docs/enterprise/trunk/Installation_Guide/en-US/Test_Your_Installation.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Test_Your_Installation.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Test_Your_Installation.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,62 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> + +<chapter id="Test_your_Installation"> + <title>Test your Installation</title> + <para> + After you have installed the JBoss Enterprise Application Platform, it is wise to perform a simple startup test to validate that there are no major problems with your Java VM/operating system combination. Make sure you have set the <literal>JBOSS_HOME</literal> envirnoment variables as explained in <ulink url="Post_Installation_Configuration"/>. To test your installation, move to <filename>JBOSS_DIST/jboss-as/bin</filename> directory and execute the <filename>run.bat</filename> (for Windows) or <filename>run.sh</filename> (for Linux) script, as appropriate for your operating system. Your output should look like the following (accounting for installation directory differences) and contain no error or exception messages: + </para> +<programlisting> +[vrenish@vinux bin]$ ./run.sh +===================================================== + + JBoss Bootstrap Environment + + JBOSS_HOME: /home/vrenish/jboss-eap-4.3/jboss-as + + JAVA: /usr/java/jdk1.5.0_11/bin/java + + JAVA_OPTS: -Dprogram.name=run.sh -server -Xms1503m -Xmx1503m -Dsun.rmi.dgc.cli ent.gcInterval=3600000 + -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.net.prefer IPv4Stack=true + + CLASSPATH: /home/vrenish/jboss-eap-4.3/jboss-as/bin/run.jar:/u sr/java/jdk1.5.0_11/lib/tools.jar + +===================================================== + +18:45:49,550 INFO [Server] Starting JBoss (MX MicroKernel)... +. +. +. +. +18:45:50,449 INFO [ServerInfo] Java version: 1.5.0_11,Sun Microsystems Inc. +18:45:50,449 INFO [ServerInfo] Java VM: Java HotSpot(TM) Server VM 1.5.0_11-b03 ,Sun Microsystems Inc. +18:45:50,449 INFO [ServerInfo] OS-System: Linux 2.6.9-42.0.3.EL,i386 +18:45:51,824 INFO [Server] Core system initialized +18:45:59,622 INFO [WebService] Using RMI server codebase: http://127.0.0.1:8083 / +18:45:59,659 INFO [Log4jService$URLWatchTimerTask] Configuring from URL: resour ce:jboss-log4j.xml +</programlisting> + <note> + <para> + Note that there is no "Server Started" message shown at the console when the server is started using the <literal>production</literal> profile, which is the default profile used when no other is specified. This message may be observed in the <filename>server.log</filename> file located in the <filename>server/production/log</filename> subdirectory. + </para> + </note> + <para> + Now open <literal>http://localhost:8080</literal> in your web browser. (Make sure you dont have anything else already on your machine using that port).<footnote><para> + Note that on some machines, the name localhost won’t resolve properly and you should use the local loopback address 127.0.0.1 instead.</para></footnote> The contents of your page should look similar to this: <xref linkend="Test_your_Installation-Test_your_Installation" />. + </para> + <para> + <figure id="Test_your_Installation-Test_your_Installation"> + <title>Test your Installation</title> + <mediaobject> + <imageobject> + <imagedata align="center" fileref="images/test_install.png" /> + </imageobject> + </mediaobject> + </figure> + </para> + <para> + You are now ready to use the JBoss Enterprise Application Platform. Refer to the Getting Started Guide for more information about the platform layout and example applications showcasing JBoss in action. + </para> +</chapter> + Added: docs/enterprise/trunk/Installation_Guide/en-US/Uninstall_JBoss.xml =================================================================== --- docs/enterprise/trunk/Installation_Guide/en-US/Uninstall_JBoss.xml (rev 0) +++ docs/enterprise/trunk/Installation_Guide/en-US/Uninstall_JBoss.xml 2008-12-03 05:04:12 UTC (rev 12331) @@ -0,0 +1,11 @@ +<?xml version='1.0'?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +]> + +<chapter id="Uninstall_JBoss"> + <title>Uninstall JBoss</title> + <para> + As JBoss Enterprise Application Platform was installed from a zipfile, you may uninstall it by simply deleting the &JBEAP; installed directory. + </para> +</chapter> + Added: docs/enterprise/trunk/Installation_Guide/en-US/images/step3.png =================================================================== (Binary files differ) Property changes on: docs/enterprise/trunk/Installation_Guide/en-US/images/step3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: docs/enterprise/trunk/Installation_Guide/en-US/images/step4.png =================================================================== (Binary files differ) Property changes on: docs/enterprise/trunk/Installation_Guide/en-US/images/step4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: docs/enterprise/trunk/Installation_Guide/en-US/images/step8.png =================================================================== (Binary files differ) Property changes on: docs/enterprise/trunk/Installation_Guide/en-US/images/step8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: docs/enterprise/trunk/Installation_Guide/en-US/images/test_install.png =================================================================== (Binary files differ) Property changes on: docs/enterprise/trunk/Installation_Guide/en-US/images/test_install.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: docs/enterprise/trunk/Installation_Guide/en-US/images/title.jpg =================================================================== (Binary files differ) Property changes on: docs/enterprise/trunk/Installation_Guide/en-US/images/title.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: docs/enterprise/trunk/Installation_Guide/en-US/images/uninstall.png =================================================================== (Binary files differ) Property changes on: docs/enterprise/trunk/Installation_Guide/en-US/images/uninstall.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream