Author: ips Date: 2008-10-17 10:00:07 -0400 (Fri, 17 Oct 2008) New Revision: 10 Added: trunk/BUILD.txt trunk/INSTALL.txt Removed: trunk/core/BUILD.txt trunk/core/INSTALL.txt Log: move BUILD.txt and INSTALL.txt up to the root dir Copied: trunk/BUILD.txt (from rev 9, trunk/core/BUILD.txt) =================================================================== --- trunk/BUILD.txt (rev 0) +++ trunk/BUILD.txt 2008-10-17 14:00:07 UTC (rev 10) @@ -0,0 +1,61 @@ +Embedded Jopr Build instructions +******************************** +Compiling +========= +1) Make sure you have JDK 5 and Maven 2 setup on your system. +2) Build Embedded Jopr: + + mvn install -Dmaven.test.skip=true + + 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 + +Installation +============ +See INSTALL.txt for instructions on: +1) Installing the admin console WAR to a JBAS instance. +2) Logging in to the admin console. + +'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. + +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: + <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. + 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 --> + <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): + + -Xms256M -Xmx256M -XX:PermSize=256M -XX:MaxPermSize=256M + + 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. Property changes on: trunk/BUILD.txt ___________________________________________________________________ Name: svn:mergeinfo + Copied: trunk/INSTALL.txt (from rev 9, trunk/core/INSTALL.txt) =================================================================== --- trunk/INSTALL.txt (rev 0) +++ trunk/INSTALL.txt 2008-10-17 14:00:07 UTC (rev 10) @@ -0,0 +1,35 @@ +Embedded Jopr Install instructions +********************************** +Note, for instructions on building Embedded Jopr, see BUILD.txt. + +To install the JBAS admin console webapp, perform the following steps: + +1) Uncomment the admin user (or some other user in the JBossAdmin role) in + ${JBOSS_CONFIG_DIR}/conf/props/jmx-console-users.properties. + +2) (OPTIONAL) If you want the Admin Console to expose JVM metrics and operations, add + -Djboss.platform.mbeanserver to your JAVA_OPTS. + +3) (OPTIONAL) Modify ${JBOSS_CONFIG_DIR}/conf/jboss-log4j.xml, and add the following in + the category section to turn off Seam DEBUG logging, which can be very noisy: + + <category name="org.jboss.seam"><priority value="INFO"/></category> + <category name="com.sun"><priority value="INFO"/></category> + +4) Stop your JBAS instance. + +5) Copy jbas4-console.war (JBAS 4.2.x/4.3.x) *or* jbas5-console.war (JBAS 5.x) + to your ${JBOSS_CONFIG_DIR}/deploy/ directory. + +6) (AS5 ONLY) Enable the Profile Service. + *NOTE* These instructions currently work for AS5 CR1, but not for CR2. + a) In the ${JBOSS_CONFIG_DIR}/conf directory, delete the bootstrap.xml file and + rename the bootstrap-repo.xml to bootstrap.xml. + b) In ${JBOSS_CONFIG_DIR}/deployers directory, rename the + profileservice-beans.xml.bak file to profile-service-beans.xml. + +7) Restart your JBAS instance. + +8) Once JBAS fully starts, go to http://localhost:8080/jbas4-console/ (JBAS 4.2.x/4.3.x) + *or* http://localhost:8080/jbas5-console/ (JBAS 5.x). Login with the same credentials + you would use for the JMX console (e.g. admin:admin). Property changes on: trunk/INSTALL.txt ___________________________________________________________________ Name: svn:mergeinfo + Deleted: trunk/core/BUILD.txt =================================================================== --- trunk/core/BUILD.txt 2008-10-17 13:58:44 UTC (rev 9) +++ trunk/core/BUILD.txt 2008-10-17 14:00:07 UTC (rev 10) @@ -1,61 +0,0 @@ -Embedded Jopr Build instructions -******************************** -Compiling -========= -1) Make sure you have JDK 5 and Maven 2 setup on your system. -2) Build Embedded Jopr: - - mvn install -Dmaven.test.skip=true - - 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 - -Installation -============ -See INSTALL.txt for instructions on: -1) Installing the admin console WAR to a JBAS instance. -2) Logging in to the admin console. - -'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. - -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: - <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. - 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 --> - <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): - - -Xms256M -Xmx256M -XX:PermSize=256M -XX:MaxPermSize=256M - - 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. Deleted: trunk/core/INSTALL.txt =================================================================== --- trunk/core/INSTALL.txt 2008-10-17 13:58:44 UTC (rev 9) +++ trunk/core/INSTALL.txt 2008-10-17 14:00:07 UTC (rev 10) @@ -1,35 +0,0 @@ -Embedded Jopr Install instructions -********************************** -Note, for instructions on building Embedded Jopr, see BUILD.txt. - -To install the JBAS admin console webapp, perform the following steps: - -1) Uncomment the admin user (or some other user in the JBossAdmin role) in - ${JBOSS_CONFIG_DIR}/conf/props/jmx-console-users.properties. - -2) (OPTIONAL) If you want the Admin Console to expose JVM metrics and operations, add - -Djboss.platform.mbeanserver to your JAVA_OPTS. - -3) (OPTIONAL) Modify ${JBOSS_CONFIG_DIR}/conf/jboss-log4j.xml, and add the following in - the category section to turn off Seam DEBUG logging, which can be very noisy: - - <category name="org.jboss.seam"><priority value="INFO"/></category> - <category name="com.sun"><priority value="INFO"/></category> - -4) Stop your JBAS instance. - -5) Copy jbas4-console.war (JBAS 4.2.x/4.3.x) *or* jbas5-console.war (JBAS 5.x) - to your ${JBOSS_CONFIG_DIR}/deploy/ directory. - -6) (AS5 ONLY) Enable the Profile Service. - *NOTE* These instructions currently work for AS5 CR1, but not for CR2. - a) In the ${JBOSS_CONFIG_DIR}/conf directory, delete the bootstrap.xml file and - rename the bootstrap-repo.xml to bootstrap.xml. - b) In ${JBOSS_CONFIG_DIR}/deployers directory, rename the - profileservice-beans.xml.bak file to profile-service-beans.xml. - -7) Restart your JBAS instance. - -8) Once JBAS fully starts, go to http://localhost:8080/jbas4-console/ (JBAS 4.2.x/4.3.x) - *or* http://localhost:8080/jbas5-console/ (JBAS 5.x). Login with the same credentials - you would use for the JMX console (e.g. admin:admin).