Author: vishwanathk
Date: Mon Sep 16 12:23:51 2013
New Revision: 1523610
URL: http://svn.apache.org/r1523610
Log:
More formatting changes
Modified:
tomee/site/trunk/content/manual-installation.mdtext
Modified: tomee/site/trunk/content/manual-installation.mdtext
URL:
http://svn.apache.org/viewvc/tomee/site/trunk/content/manual-installation.mdtext?rev=1523610&r1=1523609&r2=1523610&view=diff
==============================================================================
--- tomee/site/trunk/content/manual-installation.mdtext (original)
+++ tomee/site/trunk/content/manual-installation.mdtext Mon Sep 16 12:23:51 2013
@@ -1,8 +1,5 @@
Title: Manual Installation
-{composition-setup}
-{composition-setup}
-<a name="ManualInstallation-Overview"></a>
# Overview
The manual installation process is significantly harder then the [automatic
installation](tomcat.html)
@@ -10,41 +7,39 @@ The manual installation process is signi
following:
1. Install openejb.war
-1. # Download openejb.war from the [OpenEJB download
page](http://people.apache.org/~dain/openejb-temp)
-1. # Make webapps/openejb directory
-1. # Change to new webapps/openejb directory
-1. # Unpack the openejb.war file in the new directory
+1. Download openejb.war from the [download
page](http://tomee.apache.org/downloads.html)
+1. Make webapps/openejb directory
+1. Change to new webapps/openejb directory
+1. Unpack the openejb.war file in the new directory
1. Add the OpenEJB listener the conf/server.xml file
1. Update the non-compliant Tomcat annotations-api.jar
1. Add the OpenEJB JavaAgent to the bin/catalina.bat or bin/catalina.bat
script
-<a name="ManualInstallation-{anchor:install-openejb}Installopenejb.war"></a>
-#{anchor:install-openejb}Install openejb.war
+##Install openejb.war
Once Tomcat has been [installed](tomcat-installation.html)
, the OpenEJB plugin for Tomcat can be installed. The war can be obtained
-from the [OpenEJB download page|http://people.apache.org/~dain/openejb-temp]
-. The commands in this example are executed from within the Tomcat
+from the [download page](http://tomee.apache.org/downloads.html)
+
+The commands in this example are executed from within the Tomcat
installation directory.
<a
name="ManualInstallation-UnpackOpenEJBTomcatplugininTomcatwebappsdirectory"></a>
## Unpack OpenEJB Tomcat plugin in Tomcat webapps directory
-{warning:title=Be Careful}This is the most error prone step. A web
+Be careful, this is the most error prone step. A web
application does not contain a root directory, so if you unpack it in the
wrong directory, it is difficult to undo. Please, follow this step
-closely, and most importantly *make sure you execute the unpack command
-from within the new webapps/openejb directory*.{warning}
+closely, and most importantly make sure you execute the unpack command
+from within the new webapps/openejb directory
Due to the structure of war files, you must create a new directory for
OpenEJB, change to the new directory and execute the unpack command from
within the new directory. If you get this wrong, it is difficult to undo,
so follow the steps closely.
-{deck:id=unpack tomcat}
-{card:label=Windows}{noformat:nopanel=true}
-
+<pre><code>
C:\apache-tomcat-6.0.14>mkdir webapps\openejb
C:\apache-tomcat-6.0.14>cd webapps\openejb
@@ -102,7 +97,7 @@ so follow the steps closely.
apache-tomcat-6.0.14$
-{deck}
+</code></pre>
<a name="ManualInstallation-AddtheOpenEJBlistenertoTomcat"></a>
## Add the OpenEJB listener to Tomcat
@@ -111,35 +106,32 @@ All Tomcat listener classes must be avai
loader, so the openejb-loader jar must be copied into the Tomcat lib
directory.
-{deck:id=copy openejb loader}
- {card:label=Windows}
C:\apache-tomcat-6.0.14>copy
webapps\openejb\lib\openejb-loader-3.0.0-SNAPSHOT.jar lib\openejb-loader.jar
1 file(s) copied.
- {card:label=Unix}
apache-tomcat-6.0.14$ cp webapps/openejb/lib/openejb-loader-*.jar
lib/openejb-loader.jar
-{deck}
-Add the following {highlight}highlighted lines{highlight} to your
conf/server.xml file to load the OpenEJB listener:
+Add the following `<Listener
+className="org.apache.openejb.loader.OpenEJBListener" />` to your
conf/server.xml file to load the OpenEJB listener:
+
+The snippet is shown below
-{panel:title=conf/server.xml}
-<!-- Note: A "Server" is not itself a "Container", so you may not
- define subcomponents such as "Valves" at this
-level.
- Documentation at /docs/config/server.html
- -->
-<Server port="8005" shutdown="SHUTDOWN">
- {highlight}<!-- OpenEJB plugin for tomcat -->{highlight}
- {highlight}<Listener
-className="org.apache.openejb.loader.OpenEJBListener" />{highlight}
-
- <!--APR library loader. Documentation at /docs/apr.html -->
- <Listener
-className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
-...snip...
-{panel}
+ <!-- Note: A "Server" is not itself a "Container", so you may not
+ define subcomponents such as "Valves" at this
+ level.
+ Documentation at /docs/config/server.html
+ -->
+
+ <Server port="8005" shutdown="SHUTDOWN">
+ <!-- OpenEJB plugin for tomcat -->
+ <Listener
+ className="org.apache.openejb.loader.OpenEJBListener" />
+
+ <!--APR library loader. Documentation at /docs/apr.html -->
+ <Listener
+ className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
<a name="ManualInstallation-UpdatetheTomcatannotations-api.jarfile"></a>
## Update the Tomcat annotations-api.jar file
@@ -149,21 +141,20 @@ classes and these invalid classes must b
annotations. Simply, replace the annotations-api.jar in the Tomcat lib
directory with the updated annotations-api.jar in the OpenEJB war.
-{deck:id=update annotations-api.jar}
-{card:label=Windows}{noformat:nopanel=true}
+<pre><code>
+
C:\apache-tomcat-6.0.14>copy webapps\openejb\tomcat\annotations-api.jar
lib\annotations-api.jar
Overwrite lib\annotations-api.jar? (Yes/No/All): y
1 file(s) copied.
- {card:label=Unix}{noformat:nopanel=true}
- apache-tomcat-6.0.14$ cp webapps/openejb/tomcat/annotations-api.jar
+apache-tomcat-6.0.14$ cp webapps/openejb/tomcat/annotations-api.jar
lib/annotations-api.jar
-{deck}
+</code></pre>
<a
name="ManualInstallation-{anchor:javaagent}AddOpenEJBjavaagenttoTomcatstartup"></a>
-## {anchor:javaagent} Add OpenEJB javaagent to Tomcat startup
+## Add OpenEJB javaagent to Tomcat startup
OpenJPA, the Java Persistence implementation used by OpenEJB, currently
must enhanced persistence classes to function properly, and this requires
@@ -171,80 +162,58 @@ the installation of a javaagent into the
First, copy the OpenEJB JavaAgent jar into the lib directory.
-{deck:id=unpack tomcat}
+<pre><code>
- {card:label=Windows}
C:\apache-tomcat-6.0.14>copy
webapps\openejb\lib\openejb-javaagent-3.0.0-SNAPSHOT.jar
lib\openejb-javaagent.jar
1 file(s) copied.
- {card:label=Unix}
apache-tomcat-6.0.14$ cp webapps/openejb/lib/openejb-javaagent-*.jar
lib/openejb-javaagent.jar
-{deck}
+</code></pre>
-Simply, add the following {highlight}highlighted lines{highlight} to the
+Simply, add the following text in bold to the
bin/catalina.bat (Windows) or bin/catalina.sh (Unix) file to enable the
OpenEJB javaagent:
-{deck:id=update script}
-{card:label=Windows}
-{panel:title=bin/catalina.bat}
-...snip...
if not exist "%CATALINA_BASE%\conf\logging.properties" goto noJuli
set JAVA_OPTS=%JAVA_OPTS%
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
-Djava.util.logging.config.file="%CATALINA_BASE%\conf\logging.properties"
:noJuli
-{highlight}rem Add OpenEJB javaagent
-if not exist "%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar"
-goto noOpenEJBJavaagent
-set
-JAVA_OPTS="-javaagent:%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar"
-%JAVA_OPTS%
-:noOpenEJBJavaagent{highlight}
-
-rem ----- Execute The Requested Command
----------------------------------------
-
-echo Using CATALINA_BASE: %CATALINA_BASE%
-echo Using CATALINA_HOME: %CATALINA_HOME%
-...snip...
-{panel}
-{card}
-{card:label=Unix}
-{panel:title=bin/catalina.sh}
-...snip...
-\# Set juli LogManager if it is present
-if [OPENEJB: -r "$CATALINA_BASE"/conf/logging.properties
](openejb:--r-"$catalina_base"/conf/logging.properties-.html)
-; then
- JAVA_OPTS="$JAVA_OPTS
-"-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager"
-"-Djava.util.logging.config.file="$CATALINA_BASE/conf/logging.properties"
-fi
+ ***rem Add OpenEJB javaagent if not exist
+ "%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar" goto
+ noOpenEJBJavaagent set
+
JAVA_OPTS="-javaagent:%CATALINA_BASE%\webapps\openejb\lib\openejb-javaagent.jar"
+ %JAVA_OPTS% :noOpenEJBJavaagent***
+
-{highlight}\# Add OpenEJB javaagent
-if [OPENEJB: -r "$CATALINA_BASE"/webapps/lib/openejb-javaagent.jar
](openejb:--r-"$catalina_base"/webapps/lib/openejb-javaagent.jar-.html)
+
+ rem ----- Execute The Requested Command
+ ---------------------------------------
+ echo Using CATALINA_BASE: %CATALINA_BASE%
+ echo Using CATALINA_HOME: %CATALINA_HOME%
+
+
+
+ # Set juli LogManager if it is present
+ if [OPENEJB: -r "$CATALINA_BASE"/conf/logging.properties
](openejb:--r-"$catalina_base"/conf/logging.properties-.html)
+ ; then
+ JAVA_OPTS="$JAVA_OPTS
+ "-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager"
+ "-Djava.util.logging.config.file="$CATALINA_BASE/conf/logging.properties"
+ fi
+
+ ***if [OPENEJB: -r "$CATALINA_BASE"/webapps/lib/openejb-javaagent.jar
](openejb:--r-"$catalina_base"/webapps/lib/openejb-javaagent.jar-.html)
; then
JAVA_OPTS=""-javaagent:$CATALINA_BASE/lib/openejb-javaagent.jar"
$JAVA_OPTS"
-fi{highlight}
+fi***
-\# ----- Execute The Requested Command
------------------------------------------
-\# Bugzilla 37848: only output this if we have a TTY
-if [OPENEJB: $have_tty -eq 1 ](openejb:-$have_tty--eq-1-.html)
-; then
- echo "Using CATALINA_BASE: $CATALINA_BASE"
-...snip...
-{panel}
-{card}
-{deck}
-
-*NOTE:* The example above is an excerpt from the middle of the
-bin/catalina.sh file. Search for "Execute" in the file to locate the
-correct position in the file to add the new lines.
+##Note:
+ The example above is an excerpt from the middle of the
+bin/catalina.sh file. Search for the this section and add section text shown
in bold
