9:02 p.m.
Author: ips
Date: 2009-10-06 15:02:05 -0400 (Tue, 06 Oct 2009)
New Revision: 777
Modified:
trunk/BUILD.txt
Log:
update content and improve structure
Modified: trunk/BUILD.txt
===================================================================
--- trunk/BUILD.txt 2009-10-06 14:33:47 UTC (rev 776)
+++ trunk/BUILD.txt 2009-10-06 19:02:05 UTC (rev 777)
@@ -2,7 +2,9 @@
********************************
Compiling
=========
-1) Make sure you have JDK 5, a Subversion (SVN) client, and Maven 2 setup on your
system.
+1) Make sure you have JDK 5, a Subversion (SVN) client, and Maven 2 setup on
+ your system.
+
2) Check out the Embedded Jopr source from SVN:
svn co http://anonsvn.jboss.org/repos/embjopr/trunk/ embjopr
@@ -10,6 +12,7 @@
or, if you are a committer:
svn co https://svn.jboss.org/repos/embjopr/trunk/ embjopr
+
3) Build Embedded Jopr:
cd embjopr
@@ -17,53 +20,70 @@
This will produce two admin console WARs:
- * jbas4/target/jbas4-console.war - for JBAS 4.2.x deployment
- * jbas5/target/jbas5-console.war - for JBAS 5.x deployment
+ * jbas4/target/jbas4-console.war
+ - for deployment to JBoss AS 4.2.x or JBoss EAP 4.3.x
+ * jbas5/target/jbas5-console.war
+ - for deployment to JBoss AS 5.1.x or JBoss EAP 5.x
Installation
============
-See INSTALL.txt in the embjopr root directory for instructions on:
-1) Installing the admin console WAR to a JBAS instance.
-2) Logging in to the admin console.
+See INSTALL.txt in the embjopr root directory for instructions on installing
+the admin console WAR to a JBAS instance and logging in to the admin console.
+NOTE: If you are deploying the admin console to EAP 5.x, you should remove the
+ bundled admin-console.war from the deploy dir before installing your
+ self-built admin console WAR.
+
+NOTE: If you think you may want to activate the dev profile at some point, you
+ should deploy the admin console WAR in exploded form (i.e. as a
+ directory).
+
'dev' Profile
=============
-If you are doing development work on Embedded Jopr, the 'dev' Maven profile can
be used to speed up the dev/test cycle.
-This will cause Maven to automatically copy any updated files to a copy of the admin
console WAR deployed to a JBAS
-instance.
+If you are doing development work on Embedded Jopr, the 'dev' Maven profile can
+be used to speed up the dev/test cycle. This will cause the Maven compile and
+package phases to automatically copy any updated files to a copy of the admin
+console WAR deployed to a JBAS instance. For details on configuring the dev
+profile, see steps 3 and 4 below.
-One-Time Steps
---------------
-1) (OPTIONAL) Activate the 'dev' profile either by adding
"<activeProfile>dev</activeProfile>" to the
"activeProfiles"
- section of your Maven settings.xml or by specifying -Pdev when running "mvn
package" to build the Admin Console WAR.
-2) Add the following to the "profiles" section of your Maven settings.xml:
+Optional One-Time Steps
+=======================
+1) Increase your JVM memory settings in run.sh/conf/bat to at least the
+ following (via the JAVA_OPTS environment variable):
+
+ -Xms200M -Xmx200M -XX:PermSize=200M -XX:MaxPermSize=200M
+
+ This is recommended during development, because multiple redeploys of
+ Seam-based webapps can cause you to run out of heap, or more likely,
+ permgen. The app server must be restarted for this change to take effect.
+
+2) Add the reloadable="true" atrribute to
+ $JBOSS_HOME/server/$CONFIG/deploy/jboss-web.deployer/context.xml, i.e.:
+
+ <Context cookies="true" crossContext="true"
reloadable="true">
+
+ This will ensure that the WAR gets redeployed by JBAS whenever a dev profile
+ build is run. The app server must be restarted for this change to take
+ effect.
+
+3) In your ~/.m2/settings.xml, add the following to the "profiles" section
+ to set the properties required by the dev profile:
+
<profile>
<id>dev</id>
<properties>
- <!-- Set the below prop to the location to your dev JBAS 4.2/4.3 deploy
location for the admin console WAR.
+ <!-- Set the below prop to the location to your dev JBAS 4.2/4.3
+ deploy location for the admin console WAR.
e.g.: C:/opt/jboss-eap-4.3.0.GA_CP02/jboss-as/server/production -->
<jbas4.configDir>SET_ME</jbas4.configDir>
- <!-- Set the below prop to the location to your dev JBAS 5.0 deploy
location for the embedded console WAR.
- e.g.: C:/opt/jboss-5.0.0.CR1/server/default -->
+ <!-- Set the below prop to the location to your dev JBAS 5.0 deploy
+ location for the embedded console WAR.
+ e.g.: C:/opt/jboss-5.1.0.GA/server/default -->
<jbas5.configDir>SET_ME</jbas5.configDir>
</properties>
</profile>
-3) Add the reloadable="true" atrribute to
$JBOSS_HOME/server/$CONFIG/deploy/jboss-web.deployer/context.xml, i.e.:
- <Context cookies="true" crossContext="true"
reloadable="true">
- This will ensure that the WAR gets redeployed by JBAS whenever a dev-profile build is
run.
-4) Increase your JVM memory settings in run.sh/conf/bat to at least the following
- (via the JAVA_OPTS environment variable):
-
- -Xms200M -Xmx200M -XX:PermSize=200M -XX:MaxPermSize=200M
-
- This is recommended, because multiple redeploys of Seam-based webapps can cause you to
run out of heap,
- or more likely, permgen.
-5) Restart your JBAS instance, so the changes from 3) and 4) will take effect.
-6) Build Embedded Jopr using the instructions above, then copy the admin console WAR
corresponding to your
- JBAS version, *in exploded form*, to the deploy directory of your development JBAS
instance.
-
-Running Builds
---------------
-If you did not activate the 'dev' profile in your Maven settings.xml (step 1
above), make sure to include "-Pdev"
-to activate the 'dev' profile when running mvn.
+4) In your ~/.m2/settings.xml, activate the 'dev' profile by default by adding
+ "<activeProfile>dev</activeProfile>" to the
"activeProfiles" section. If you
+ do not do this, you can always activate the dev profile for a particular mvn
+ run by including "-Pdev" on the mvn command line.