From do-not-reply at jboss.org Mon Apr 12 04:02:14 2010 Content-Type: multipart/mixed; boundary="===============1401072126733360606==" MIME-Version: 1.0 From: do-not-reply at jboss.org To: gatein-commits at lists.jboss.org Subject: [gatein-commits] gatein SVN: r2583 - in portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Installation_Guide: en-US and 1 other directory. Date: Mon, 12 Apr 2010 04:02:14 -0400 Message-ID: <201004120802.o3C82EIG003691@svn01.web.mwc.hst.phx2.redhat.com> --===============1401072126733360606== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: benlc Date: 2010-04-12 04:02:10 -0400 (Mon, 12 Apr 2010) New Revision: 2583 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Install= ation_Guide/en-US/Configuration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Install= ation_Guide/en-US/Databases.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Install= ation_Guide/en-US/Getting_Started.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Install= ation_Guide/en-US/Installation.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Install= ation_Guide/en-US/Installation_Guide.ent portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Install= ation_Guide/en-US/Post_Installation.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Install= ation_Guide/en-US/Test_Your_Installation.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Install= ation_Guide/publican.cfg Log: 'committing revision following platform install and test' Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Installation_Guide/en-US/Configuration.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Configuration.xml 2010-04-10 08:49:41 UTC (rev 2582) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Configuration.xml 2010-04-12 08:02:10 UTC (rev 2583) @@ -5,7 +5,7 @@ ]> Database Configuration - + =
Installing an RDBMS JDBC connector @@ -22,7 +22,28 @@ Refer to the help files in each download for installation instructions.= In most cases, the RDBMS JDBC connector comes as a .jar file. Copy this file into the $JBOSS_HOME/server/<= replaceable>configuration/lib/ directory.
- = + = + &START_EDIT; +
+ Installing an RDBMS JDBC connector + + A relational database management system (RDBMS) Java Database Connectiv= ity (JDBC) connector is required for &PRODUCT; to communicate with a databa= se. + &PRODUCT; comes bundled with Hypersonic SQL (HSQL) database so that use= rs can get up and running quickly without having to initially set up = + a database. However, HSQL should not be used in a production environm= ent. Removing HSQL is simply a matter of removing = + JBOSS_DIST/jboss-as/server/$CONFIG/deploy/hsql-ds.x= ml. + = + + Test suites have been run against = + the Oracle 9, Oracle 10, Microsoft SQL Server, = + MySQL 4, MySQL 5, and PostgreSQL 8 databases - these databases are re= commended for production use. Please refer to your database documentation f= or the correct = + RDBMS JDBC connector to use. The MySQL RDBMS JDBC connector can be do= wnloaded from , and the + PostgreSQL RDBMS JDBC connector can be downloaded from . + + + Refer to the help files in each download for installation instructions.= In most cases, the RDBMS JDBC connector comes as a .jar file within the downloaded zip file. Copy this file into the= $JBOSS_HOME/server/$CONFIG/lib/ directory. + +
+ &END_EDIT;
Datasource Descriptors @@ -59,6 +80,71 @@
+ = + &START_EDIT; +
+ Datasource Descriptors + + A Datasource descriptor is required for JBoss Portal to communicate wit= h a database. Sample Datasource descriptor files are provided for the Hyper= sonic SQL, Microsoft SQL Server= , MySQL, Oracle, and PostgreSQL= databases. These can be found in the $JBOSS_HOME/jboss-a= s/docs/examples/jca directory. + + + The sample Datasource descriptors will work with default installations = of external databases; however, you may need to configure the correct usern= ame and password. As indicated in the mysql-ds.xml file displayed below, th= e sample MySQL and PostgreSQL Datasource descriptors assume the name of the= database to be jbossdb. + + + Copy the required Datasource descriptor file to $JBOSS_HOME/s= erver/$CONFIG/deploy/ directory. When= copying a Datasource descriptor for MySQL, Microsoft SQL Server, PostgreSQL, or Oracle databases, change the <user-na= me>portal</user-name> = and <password>portalpassword</password> sections to reflect the correct userna= me and password of the user who has access to the jbossportal database. + + + Different Datasource Descriptors + + Ensure that there is only one Datasource descriptor in the $= JBOSS_HOME/server/$CONFIG/deploy/ dir= ectory. For example, if you want to use a MySQL database, remove the hsqldb-ds.xml file, and other descriptors, if they exists. F= or a default configuration this will require removing the gatein-= ds.xml and hsqldb-ds.xml files. + + + + The following is an example Datasource descriptor file for MySQL 5: + + +<?xml version=3D"1.0" encoding=3D"UTF-8"?> = +<!-- See http://www.jboss.org/community/wiki/Multiple1PC for informatio= n about local-tx-datasource --> +<!-- $Id: mysql-ds.xml 88948 2009-05-15 14:09:08Z jesper.pedersen $ --&= gt; +<!-- Datasource config for MySQL using 3.0.9 available from: + http://www.mysql.com/downloads/api-jdbc-stable.html +--> + +<datasources> + <local-tx-datasource> + <jndi-name>MySqlDS</jndi-name> + <connection-url>jdbc:mysql://mysql-hostname:3306/jbossdb</con= nection-url> + <driver-class>com.mysql.jdbc.Driver</driver-class> + <user-name>x</user-name> + <password>y</password> + <exception-sorter-class-name> + org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter + </exception-sorter-class-name> + <!-- should only be used on drivers after 3.22.1 with "ping" support + <valid-connection-checker-class-name> + org.jboss.resource.adapter.jdbc.vendor.MySQLValidConnectionChecker + </valid-connection-checker-class-name> + --> + <!-- sql to call when connection is created + <new-connection-sql>some arbitrary sql</new-connection-sql> + --> + <!-- sql to call on an existing pooled connection when it is obtaine= d from pool - = + MySQLValidConnectionChecker is preferred for newer drivers + <check-valid-connection-sql> + some arbitrary sql + </check-valid-connection-sql> + --> + + <!-- corresponding type-mapping in the standardjbosscmp-jdbc.xml (op= tional) --> + <metadata> + <type-mapping>mySQL</type-mapping> + </metadata> + </local-tx-datasource> +</datasources> + +
+ &END_EDIT; + = Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Installation_Guide/en-US/Databases.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Databases.xml 2010-04-10 08:49:41 UTC (rev 2582) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Databases.xml 2010-04-12 08:02:10 UTC (rev 2583) @@ -36,6 +36,29 @@ + = + &START_EDIT; + = + + + + Navigate to the JDBC MySQL connector section of dev.mysql.com. Downlo= ad the Compressed Tar Archive (.tar.gz) fi= le or the Zip Archive (.zip) file. + + + + + Unzip the mysql-java-connector into the desired = directory. It does not matter which directory is used. + + + + + Change into the directory to which the mysql-java-connector= was extracted. Copy the mysql-connector-java-version-number-bin.jar file into the $JBOSS_HOME/server/$CONFIG/lib/ dir= ectory. + + + + = + &END_EDIT; + = Data Truncation Errors @@ -50,6 +73,23 @@ If you are running MySQL in strict mode, remove STRICT_= TRANS_TABLES from the sql-mode=3D line, in the my.cnf file if you are running L= inux, and from the my.cfg file if you are running Windows. For further information, p= lease see . + &START_EDIT; + = + + Data Truncation Errors + + If you are running MySQL 5, data truncation errors such as the followi= ng may occur: + + + + +ERROR JDBCExceptionReporter Data truncation: Data too long for column '= ;jbp_viewrealemail' at row 1 + + + + If you are running MySQL in strict mode, remove STRICT_= TRANS_TABLES from the sql-mode =3D<= /computeroutput> line of the relevant configuration file. For Linux= , this is the my.cnf file. For Windows, edit the my.cfg file. Fo= r further information, please see . + + &END_EDIT; Creating a MySQL Database @@ -132,6 +172,98 @@ + &START_EDIT; + + Creating a MySQL Database + + If you have just installed MySQL, make sure the MySQL server is runnin= g, and then run the following command to set the root user password: + + + + +mysqladmin -u root password 'new-root-user-password' + + + + + + Run the following command to log in to MySQL. Enter the root user pas= sword when prompted: + + + +mysql -u root -p + + + + + + Use the CREATE DATABASE command to create a new jb= ossportal database. Note: the rest of this guide, and configuration example= s following here after, assume the database name to be jbossportal. If you = change the database name, please change the name in all necessary configura= tion files: + + + +mysql> CREATE DATABASE jbossportal; + + + + The output should be similar to the following: + + + +Query OK, 1 row affected (0.00 sec) + + + + At this point, the SHOW DATABASES; command should = display the jbossportal database: + + + +mysql> SHOW DATABASES; ++--------------------+ +| Database | ++--------------------+ +| information_schema | = +| jbossportal | = +| mysql | = ++--------------------+ +3 rows in set (0.00 sec) + + + + It is safe to ignore the other databases. + + + + + Add a new user and give that user access to the jbossportal database.= The following example adds a new user named portal, with the password portalpassword. It is recommended that you choose a different password to the one suppli= ed here by changing portalpassword to some other= password: + + CREATE USER 'portal'@'localhost' IDENTIFIED BY 'portalpassword= '; + + + + Grant the necessary privileges to the user: + + + +mysql> GRANT ALL PRIVILEGES ON jbossportal.* TO 'porta= l'@'localhost' = +IDENTIFIED BY 'portalpassword' WITH GRA= NT OPTION; + + + + The output should be similar to the following: + + + +Query OK, 0 rows affected (0.00 sec) + + + Note: Changed Password? + + If you changed the portal user's password, remember to also chang= e the password in the MySQL Datasource descriptor. + + + + + &END_EDIT; MySQL Datasource Descriptor @@ -150,6 +282,65 @@ + &START_EDIT; + + MySQL Datasource Descriptor + + To install the MySQL Datasource descriptor: + + + + + + Copy the MySQL Datasource descriptor - $JBOSS_HOME/docs/exa= mples/jca/mysql-ds.xml - into the $JBOSS_HOME/server/<= replaceable>$CONFIG/deploy/ directory. + + + + + Update the following lines in the Datasource descriptor to reflect th= e correct database, user-name and password respectively: + + + + <connection-url>jdbc:mysql://mysql-ho= stname:3306/DATABASE</connection-url>; + + + + In this example the database name is jboss= portal. + + + = + + + + + <user-name>USER-NAME</user-name>; + + + + The user-name for this example is portal. + + + = + = + + + + <password>PASSWORD</password>; + + + + This example uses the portalpassword pas= sword. Enter this or the password chosen at . + + + = + + + + + + + &END_EDIT; + = MySQL Table Errors Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Installation_Guide/en-US/Getting_Started.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Getting_Started.xml 2010-04-10 08:49:41 UTC (rev 2582) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Getting_Started.xml 2010-04-12 08:02:10 UTC (rev 2583) @@ -243,6 +243,14 @@ Configuring Your Java Environment You must have a working installation of JDK 1.= 5 before you install &PRODUCT;. You can install the 32-bit or 64= -bit JVM as per your requirements. In this guide we will show you how to in= stall a 32-bit Sun JDK 5.0 using RHN, on a generic Linux Platform and Micro= soft Windows Platform. But before we do that let's take a look at some of t= he benefits of using a 64-bit JVM. + + &START_EDIT; + = + + You must have a working installation of JDK 1.= 6 before you install &PRODUCT;. You can install the 32-bit or 64= -bit JVM as per your requirements. In this guide we will show you how to in= stall a 32-bit Sun JDK 6.0 using RHN, on a generic Linux Platform and Micro= soft Windows Platform. But before we do that let's take a look at some of t= he benefits of using a 64-bit JVM. + + &END_EDIT; + = Benefits of 64-bit JVM on 64-bit OS and Hardware: @@ -315,6 +323,83 @@ + &START_EDIT; + + Installing and Configuring JDK 6.0 using RHN + + + Java SDKs are provided by the Red Hat Enterprise Linux 5 Base and S= upplementary channels for your Linux variant and architecture. The availabl= e JDKs corresponding to each channel and architecture are listed below: + + + = + + + + + Channel: rhel-<arch>-server-5 + + + + java-1.6.0-openjdk = + + + + + + Channel: rhel-<arch>-server-supplement= ary-5 + + + + java-1.6.0-sun (Sun) + + = + + java-1.6.0-ibm (IBM) + + = + + java-1.6.0-bea (JRockit) = + + + + + + Ensure that the -devel packages are also install= ed. + + + = + + + Selecting alternatives for java, javac and java_sdk_1.6.0 (setting java_sdk_1.6.0 is optional). = + + = + + 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 JAVA_HOME environment vari= able. + + = + + The alternatives system allows= different versions of Java, from different sources, to co-exist on your sy= stem. You should make sure the desired one is selected so that the service = script uses the one you want. + + = + + As root, issue the following command: + + + /usr/sbin/alternatives --config java + + + and make sure the desired one is selected (marked with a '+'), or s= elect it by entering its number as prompted. + + = + + Make sure you do the same for javac and java_sdk_1.6.0. We recommend= that all point to the same manufacturer and version. + + + + &END_EDIT; Installing and Configuring 32-bit Sun JDK 5.0 on a generic Lin= ux platform @@ -404,7 +489,128 @@ - + &START_EDIT; + + Installing and Configuring JDK 6.0 on a generic Linux platform= + + + Download the Java 2 Platform, Standard Edition (J2SE) Development= Kit (JDK) 6.0 from Sun's website: . + + = + + + From this page, select the latest update under the Java = Platform, Standard Edition heading. Alternatively, this page can = be accessed directly at . + + = + + + Follow the instructions presented on this page including selectin= g the appropriate platform and architecture. + + + + + Clicking the Continue button will display = the download options (depending on whether the user chooses to register): = + + + + + jdk-6u<update number>-linux-<arch>-rpm.bin or; + + + + + jdk-6u<update number>-linux-<arch>.bin + + + + If installing the JDK on Red Hat Enterprise Linux, Fedora, or= another RPM-based Linux system, it is recommended that the self-extracting= file containing the RPM package is selected. This option will set up and u= se the SysV service scripts in addition to installing the JDK. The RPM opt= ion is also recommended if the &PRODUCT; is being set up in a production en= vironment. Should you decide not to use the self-extracting file, the next = step can be ignored. + + + + + Download and install the appropriate -compat RPM= from JPackage here. Please ensure you = choose a matching version of the -compat package to the = JDK you installed. + + &START_NOTE; + + The latest JDK available from Sun's site is update 19. The jpackag= e site linked to above lists the latest -compat rpm at u= pdate 6 (java-1.6.0-sun-compat-1.6.0.06-1jpp.i586.rpm). So there is a confl= ict here as the downloaded package and the -compat rpm cannot be matched as= stated above. + + &END_NOTE; + + + + Create an environment variable that points to the JDK installation = directory and call it JAVA_HOME. Add $JAVA_HOME= /bin to the system path to be able to run java= from the command line. You can do this by adding the following lines to th= e .bashrc file in your home directory. +#In this example /usr/java/jdk1.6.0_19 is the JDK installation directory. +export JAVA_HOME=3D/usr/java/jdk1.6.0_19 +export PATH=3D$PATH:$JAVA_HOME/bin + + Set this variable for the user account performing the installation= and also for the user account that will run the server. + + + + + If you have more than one version of JVM installed in your machine,= make sure you are using the JDK1.6 installation as the default ja= va and javac. You can do this using the altern= atives system. The alternatives system allows different versions of Java, f= rom different sources to co-exist on your system. + + + Selecting alternatives as decribed below can be avoided by s= etting the JAVA_HOME environment variable as explained i= n the previous step. + + + + Select alternatives for java, javac and java_sdk_1.6.0</tit= le> + = + <listitem> + <para> + As root, type the following command at the shell prompt and you = should see something like this: <programlisting> +[root(a)vsr ~]$ /usr/sbin/alternatives --config java +There are 2 programs which provide 'java'. +Selection Command +----------------------------------------------- + 1 /usr/lib/jvm/jre-1.4.2-gcj/bin/java +*+ 2 /usr/lib/jvm/jre-1.6.0-sun/bin/java +Enter to keep the current selection[+], or type selection number: +</programlisting> + Make sure the Sun version [<literal>jre-1.6.0-sun</literal> in = this case] is selected (marked with a '+' in the output), or select= it by entering its number as prompted. + </para> + </listitem> + <listitem> + <para> + Repeat the same for javac and java_sdk_1.6.0. <programlisting> +[root(a)vsr ~]$ /usr/sbin/alternatives --config javac +There are 1 programs which provide 'javac'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.6.0-sun/bin/javac +Enter to keep the current selection[+], or type selection number: +</programlisting> +<programlisting> +[root(a)vsr ~]$ /usr/sbin/alternatives --config java_sdk_1.6.0 +There are 1 programs which provide 'java_sdk_1.6.0'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.6.0-sun +Enter to keep the current selection[+], or type selection number: +</programlisting> + You should verify that java, java= c and java_sdk_1.6.0 all point to the same manufacturer and version. + &START_NOTE; + Better to use java-1.6.0-variant = rather than java-1.6.0-sun as could be sun or openjdk. Also include openJDK= download site info http://openjdk.java.net/install/ ? + &END_NOTE; + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + Make sure that the <literal>java</literal> executable is in your pa= th and that you are using an appropriate version. To verify your Java envir= onment, type <literal>java -version</literal> at the shell prompt and you s= hould see something like this: <programlisting> +[root(a)vsr ~]$ java -version +java version "1.6.0_19" +Java(TM) SE Runtime Environment (build 1.6.0_19-b01) +Java HotSpot(TM) Server VM (build 14.2-b01, mixed mode) +</programlisting> + </para> + </listitem> + </itemizedlist> + &END_EDIT; + <itemizedlist id=3D"Configuring_Your_Java_Environment-Installing_an= d_Configuring_32_bit_Sun_JDK_5.0_on_Microsoft_Windows"> <title>Installing and Configuring 32-bit Sun JDK 5.0 on Microsoft Win= dows @@ -417,7 +623,70 @@ - + &START_EDIT; + + Installing and Configuring JDK 6.0 on Microsoft Windows + + + Download the Java 2 Platform, Standard Edition (J2SE) Development= Kit (JDK) 6.0 from Sun's website: . + + = + + + From this page, select the latest update under the Java = Platform, Standard Edition heading. Alternatively, this page can = be accessed directly at . + + = + + + Follow the instructions presented on this page including selectin= g the appropriate platform and architecture. + + + + + Clicking the Continue button will display = the download option (depending on whether the user chooses to register): = + + + + + jdk-6u<update number>-windows-<arch>.exe + + + + + + + Create an environment variable called JAVA_HOME = that points to the JDK installation directory, for example: C:\Pro= gram Files\Java\jdk1.6.0_19\. + + + + + In order to run java from the command line add the jre\bin= directory to your path, for example: C:\Program Files\J= ava\jdk1.6.0_19\jre\bin. To do this: = + + + + Open the Control Panel from the Start Menu, switching to Clas= sic View if necessary. = + + + + + Open the System Control Panel applet. = + + + + + Select the Advanced Tab = + + + + + Click on the Environment Variables button. = + + + = + + + + &END_EDIT; = Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Installation_Guide/en-US/Installation.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Installation.xml 2010-04-10 08:49:41 UTC (rev 2582) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Installation.xml 2010-04-12 08:02:10 UTC (rev 2583) @@ -39,6 +39,31 @@ = = + &START_EDIT; +
+ Installing + = + + To install from a zip file, simply unzip the downloaded file to a dire= ctory of your choice. You can unzip the platform on any operating system th= at supports the zip format. Six types of server configurations will be incl= uded in your installation - minimal, default, production, all, standard and= web. = + The Getting Started Guide of &JBEAP; as well as http://www.jboss.org/co= mmunity/docs/DOC-12942 explain in detail the different server configuration= file sets. = + = + + + + Unzip jboss-epp-<release>.= zip to extract the archive contents into the location of your cho= ice. You can do this using the JDK jar tool (or any othe= r ZIP extraction tool). + [vsr]$ cd jbeppinstallationdir + [vsr]$ jar -xvf jboss-epp-<release>.zip + + + + + You are done with the installation! You should now have a directory = called jboss-epp-<release>. Refer to the Getting Started Guide to understand and explore the Pla= tform Directory Structure. + + + + = +
+ &END_EDIT;
Choosing a server configuration @@ -74,5 +99,47 @@
+ &START_EDIT; + = +
+ Choosing a server configuration + + The important differences as far as Portal is concerned are: + + + + + the minimal, web and = standard server configurations do not contain any Portal relevant= components. These directories exist for the sake of consistency with &JBEA= P; + + + + + the default server configuration includes non-clu= stered Portal components contained within the httpha-invok= er.sar OR jbossweb.sar OR jbossws.sa= r OR uuid-key-generator.sar service a= rchive. This archive is located in the deploy folder. This is the server configuration that is started when no other config= uration is specified = + + = + + + the all server configuration includes clustered P= ortal components contained within httpha-invoker.sar OR jbossweb.sar OR jbossws.sar = OR juddi-service.sar OR snmp-adaptor.sar service archive. This archive is located in the deplo= y folder. = + + + + + the production server configuration includes clus= tered Portal components contained within httpha-invoker.sa= r OR jbossweb.sar OR jbossws.sar OR juddi-service.sar OR snmp-adaptor.sar= OR uuid-key-generator.sar. This arch= ive is located in the deploy folder. = + + = + + Note: Production Server + + The production server configuration has several = optimizations including logging and memory size. + If you do not need the clustered portal version and want to use this o= ptimized server configuration, you simply need to copy the + WHICH FILE? file from default/de= ploy to production/deploy. Don't forget to + remove WHICH FILE as jboss-portal-ha.sar doesn't exis= t? though. = + + + +
+ = + &END_EDIT; + = = Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Installation_Guide/en-US/Installation_Guide.ent =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Installation_Guide.ent 2010-04-10 08:49:41 UTC (rev 2582) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Installation_Guide.ent 2010-04-12 08:02:10 UTC (rev 2583) @@ -5,3 +5,7 @@ +<remark><!-- Start Edit</remark= >"> +<remark>End Edit --></remark></ti= tle><para></para></formalpara>"> +<!ENTITY START_NOTE "<formalpara><title><remark><!-- Start Note to Revi= ewer</remark>"> +<remark>End Note to Reviewer --><= /remark>"> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Installation_Guide/en-US/Post_Installation.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Post_Installation.xml 2010-04-10 08:49:41 UTC (rev 2582) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Post_Installation.xml 2010-04-12 08:02:10 UTC (rev 2583) @@ -32,6 +32,37 @@ = + &START_EDIT; = +
+ + Set JBOSS_HOME Environment Variable + + Minor edit changed 4.3 to 5.0 in path to installation dire= ctory. + + + On a Linux Platform + + + Create an environment variable that points to the installation directo= ry (JBOSS_DIST/jboss-as) and call it JBOSS_HO= ME. Add $JBOSS_HOME/bin 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 .bashrc file in your home d= irectory. + +#In this example /home/user/jboss-epp-5.0/jboss-as is the installation dir= ectory. + export JBOSS_HOME=3D/home/user/jboss-epp-5.0/jboss-as + export PATH=3D$PATH:$JBOSS_HOME/bin = + + Set this variable for the user account(s) that will run the server. = + + + + + On Microsoft Windows + + + Create an environment variable called JBOSS_HOME th= at points to the installation directory, for example: C:\Program Files\jbos= s-epp-5.0\jboss-as\. In order to run the server from the command line add t= he bin directory to your path, for example: C:\Program= Files\jboss-epp-5.0\jboss-as\bin. To do this, open the Control Panel from = the Start Menu, switch to Classic View if necessary, open the System Contro= l Panel applet, select the Advanced Tab, and click on the Environment Varia= bles button. + + +
= + &END_EDIT; + =
Adjust memory settings @@ -44,6 +75,24 @@
+ &START_EDIT; + = +
+ Adjust memory settings + + The default configuration for the server to start with, if no other con= figuration is specified, is the production configuration. It is recommended= to run the example Seam applications that are included with the documentat= ion using the production configuration. = + + + To avoid memory issues, adjust the memory settings before deploying the= applications. You can do this by updating JAVA_OPTS set= tings in the file JBOSS_DIST/jboss-as/bin/run.conf wit= h these recommended values: = + + -Xms1303m -Xmx1303m -XX:MaxPermSize=3D256m .... + + + This is the default so the "adjust" statement is not corre= ct. Should it be set higher than 256m? +
+ = + &END_EDIT; + =
Post Installation Security Configuration @@ -99,8 +148,88 @@ </para> </formalpara> </section> + = + &START_EDIT; + <section id=3D"Post-InstallationE"> + <title> + Post Installation Security Configuration + + + When installed from the zip archive, authentication is required to acce= ss the majority of JBoss services, including administrative services. User = accounts have not been set up to eliminate the possibility of default usern= ame/password based attacks. + + Default admin user configuration + + It is recommended that the admin=3Dadmin username and password configu= ration, which is commented out by default, not be used for a production ser= ver. The admin user is included as an example of the user/password definiti= on format only. = + + + = + Set up the <literal>jmx-console</literal> users and r= oles + + Edit the jmx-console-users.properties file loca= ted in the $JBOSS_HOME/server/$CONFIG/conf/props/ dire= ctory defining the username and password: + + + user=3Dpassword + + Edit the jmx-console-roles.properties file locate= d in the $JBOSS_HOME/server/$CONFIG/conf/props/ direct= ory to define the user's roles: + + user=3DJBossAdmin,HttpInvoker + = + Set up the <literal>admin-console</literal> users and= roles + + Edit the web-console-users.properties file loca= ted in the $JBOSS_HOME/server/$CONFIG/deploy/management/console-m= gr.sar/web-console.war/WEB-INF/classes/ directory: + + + user=3Dpassword + + Edit the web-console-roles.properties file locate= d in the $JBOSS_HOME/server/$CONFIG/deploy/management/console-mgr= .sar/web-console.war/WEB-INF/classes/ directory: + + user=3DJBossAdmin,HttpInvoker + $JBOSS_HOME and $CONFIG + + $JBOSS_HOME is the jboss-as di= rectory, a level above the bin directory. $CONFIG is the= chosen server configuration - all, default, minimal production, standard o= r web. + + + + + Login credentials for the admin-console are the sam= e as those used for the JMX console. + + + + Set SuckerPassword for JBoss Messaging: + + JBoss Messaging makes internal connections between nodes in order to r= edistribute messages between clustered destinations. These connections are = made with the user name of a special reserved user whose password is specif= ied by this parameter SuckerPassword in the Server Peer = configuration file: + + $JBOSS_HOME/server/$CONFIG/deploy/messaging/messaging-service.xm= l + + Where $JBOSS_HOME is the install directory and $CONFIG is the server configuration being used. + To avoid a security risk, you MUST specify the value of the attribute = SuckerPassword, 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 uncomment= ed and modified: + + <mbean code=3D"org.jboss.jms.server.ServerPeer" + name=3D"jboss.messaging:service=3DServerPeer" + xmbean-dd=3D"xmdesc/ServerPeer-xmbean.xml"> + ... + ... + ... + ... + <!-- The password used by the message sucker connections to create c= onnections. + THIS SHOULD ALWAYS BE CHANGED AT INSTALL TIME TO SECURE SYSTEM = --> + <attribute name=3D"SuckerPassword"></attribute> + ... + ... + ... + </mbean> = + + + + edit $JBOSS_HOME/server/$CONFIG/deploy/messaging/messaging= -jboss-beans.xml as well? = + <property name=3D"suckerPassword">CHANGE ME= !!</property> + Also can't see jmx console or admin-console in th= e interface so is section this relevant? +
+ = + &END_EDIT;
Disabling Authentication = + No changes here as all paths and files are the same It is also possible to disable authentication on specific services. All= specified paths in the sections below are relative to $JBOSS_HOME= . Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Installation_Guide/en-US/Test_Your_Installation.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Test_Your_Installation.xml 2010-04-10 08:49:41 UTC (rev = 2582) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/en-US/Test_Your_Installation.xml 2010-04-12 08:02:10 UTC (rev = 2583) @@ -6,6 +6,7 @@ = Test your Installation + = After you have installed the JBoss Enterprise Portal Platform, it is wis= e to perform a simple startup test to validate that there are no major prob= lems with your Java VM/operating system combination. Make sure you have set= the JBOSS_HOME envirnoment variables as explained in . To test your installation, = move to JBOSS_DIST/jboss-as/bin directory and execute = the run.bat (for Windows) or run.sh (for Linux) script, as appropriate for your operating system. Your outpu= t should look like the following (accounting for installation directory dif= ferences) and contain no error or exception messages: @@ -43,7 +44,76 @@ Note that there is no "Server Started" message shown at the console whe= n the server is started using the production profile, wh= ich is the default profile used when no other is specified. This message ma= y be observed in the server.log file located in the server/production/log subdirectory. + = + &START_EDIT; + After you have installed the JBoss Enterprise Portal Platform, it is wis= e to perform a simple startup test to validate that there are no major prob= lems with your Java VM/operating system combination. Make sure you have set= the JBOSS_HOME environment variables as explained in . + + = + To test your installation: + + + + move to the $JBOSS_HOME/bin directory; = + + + + + execute the run.bat (for Windows) or run.sh (for Linux) script, as appropriate for your operating s= ystem; + + + + Ensure that you run the configuration corresponding to the <= filename>$JBOSS_HOME/server/$CONFIG/ which you chose to set up t= he database connection in + + + = + + + = + + + The example below uses the production configuration. Your output shoul= d look like the following (accounting for installation directory difference= s) and should not contain any error or exception messages: + + +[user(a)localhost bin]$ ./run.sh -c production +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + + JBoss Bootstrap Environment + + JBOSS_HOME: /home/user/jboss-epp-5.0/jboss-as + + JAVA: /usr/java/jdk1.6.0_16/bin/java + + JAVA_OPTS: -Dprogram.name=3Drun.sh -server -Xms1303m -Xmx1303m -XX:MaxPe= rmSize=3D256m = + -Dorg.jboss.resolver.warning=3Dtrue -Dsun.rmi.dgc.client.gcIn= terval=3D3600000 = + -Dsun.rmi.dgc.server.gcInterval=3D3600000 -Dsun.lang.ClassLoa= der.allowArraySyntax=3Dtrue = + -Dexo.conf.dir.name=3Dgatein -Djava.net.preferIPv4Stack=3Dtrue + + CLASSPATH: /home/user/jboss-epp-5.0/jboss-as/bin/run.jar/usr/java/jdk1.6= .0_16/lib/tools.jar + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +16:59:41,401 INFO [ServerImpl] Starting JBoss (Microcontainer)... +16:59:41,401 INFO [ServerImpl] Release ID: JBoss [EAP] 5.0.0.GA (build: S= VNTag=3DJBPAPP_5_0_0_GA date=3D200910202128) +16:59:41,402 INFO [ServerImpl] Bootstrap URL: null +16:59:41,402 INFO [ServerImpl] Home Dir: /home/user/jboss-epp-5.0/jboss-as +16:59:41,402 INFO [ServerImpl] Home URL: file:/home/user/jboss-epp-5.0/jb= oss-as/ +16:59:41,402 INFO [ServerImpl] Library URL: file:/home/user/jboss-epp-5.0= /jboss-as/lib/ +16:59:41,403 INFO [ServerImpl] Patch URL: null +16:59:41,403 INFO [ServerImpl] Common Base URL: file:/home/user/jboss-epp= -5.0/jboss-as/common/ +16:59:41,404 INFO [ServerImpl] Common Library URL: file:/home/user/jboss-= epp-5.0/jboss-as/common/lib/ +16:59:41,404 INFO [ServerImpl] Server Name: production +... +... +16:59:44,345 INFO [JMXKernel] Legacy JMX core initialized + + + + Note that there is no "Server Started" message shown at the console whe= n the server is started using the production profile. Th= is message may be observed in the server.log file loca= ted in the server/production/log subdirectory. + + + &END_EDIT; + Now open http://localhost:8080/portal in your web bro= wser. (Make sure you dont have anything else already on your machine using = that port). Note that on some machines, the name localhost won=E2=80=99t resolve pro= perly and you should use the local loopback address 127.0.0.1 instead. The contents of your page should look similar to this: . @@ -60,5 +130,6 @@ You are now ready to use the JBoss Enterprise Portal Platform. Refer to = the User Guide and Reference Guide for more information about the platform= layout and example applications showcasing JBoss Portal in action. + = = Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_= Installation_Guide/publican.cfg =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/publican.cfg 2010-04-10 08:49:41 UTC (rev 2582) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Instal= lation_Guide/publican.cfg 2010-04-12 08:02:10 UTC (rev 2583) @@ -6,4 +6,5 @@ type: Book brand: JBoss debug:1 = +show_remarks:1 = --===============1401072126733360606==--