vgritsenko 2004/01/01 13:34:32
Modified: src/documentation/content/xdocs/community/howto/installation
tomcat.xml
Log:
Update installation doc
Revision Changes Path
1.5 +164 -105
xml-xindice/src/documentation/content/xdocs/community/howto/installation/tomcat.xml
Index: tomcat.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/community/howto/installation/tomcat.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- tomcat.xml 7 Aug 2003 17:51:48 -0000 1.4
+++ tomcat.xml 1 Jan 2004 21:34:32 -0000 1.5
@@ -1,89 +1,129 @@
<?xml version="1.0" encoding="UTF-8"?>
-
<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "howto-v10.dtd">
+
<!--
- Version: $Revision$ $Date$
-->
<howto>
- <header>
- <title>Xindice Tomcat How-To</title>
- <version>1.0</version>
- <authors>
- <person name="Dave Viner" email="[EMAIL PROTECTED]"/>
- </authors>
- <last-modified-content-date date="2002-11-25"/>
- </header>
- <audience title="Intended audience">
- <p>This How-to is aimed at developers or administrators who want to
install Xindice with Tomcat.</p>
- </audience>
- <prerequisites title="Prerequisites">
- <p>The most important prerequisite is patience. Take lots of deep
breaths. It will work. It just might take some time.</p>
- <ul>
- <li>You should have already compiled <link
href="../compilation/index.html">Xindice</link>.</li>
- <li>You must have an existing installation of Tomcat. You
should use version 4.1.12 or higher. You can install <fork
href="http://jakarta.apache.org/tomcat/";>Tomcat</fork> from the Jakarta website.
- </li>
- <li>Be sure to set the CATALINA_HOME environmental variable to
point to the location of your Tomcat installation.</li>
- </ul>
- </prerequisites>
- <steps title="Steps">
- <section>
- <title>Copy the war file</title>
- <p>If you've followed the prerequisites, then you will have a
working version of Tomcat installed, and the sources of Xindice compiled. Now,
copy the xindice*.war file from dist to %CATALINA_HOME%/webapps</p>
- <p>Here's what that looks like in Windows</p>
- <source>
+ <header>
+ <title>Xindice Tomcat How-To</title>
+ <version>$Revision$</version>
+ <authors>
+ <person name="Dave Viner" email="[EMAIL PROTECTED]"/>
+ <person name="Vadim Gritsenko" email="[EMAIL PROTECTED]"/>
+ </authors>
+ <last-modified-content-date date="2004-01-01"/>
+ </header>
+
+ <audience title="Intended audience">
+ <p>
+ This How-to is aimed at developers or administrators who want to
install
+ Xindice with Tomcat.
+ </p>
+ </audience>
+
+ <prerequisites title="Prerequisites">
+ <p>
+ The most important prerequisite is patience. Take lots of deep breaths.
+ It will work. It just might take some time.
+ </p>
+ <ul>
+ <li>
+ You should have already compiled <link
href="../compilation/index.html">Xindice</link>.
+ </li>
+ <li>
+ You must have an existing installation of Tomcat. You should use
version
+ 4.1.12 or higher. You can download
+ <fork href="http://jakarta.apache.org/tomcat/";>Tomcat</fork> from the
+ Jakarta website.
+ </li>
+ <li>
+ Be sure to set the <code>CATALINA_HOME</code> environmental variable
to point
+ to the location of your Tomcat installation.
+ </li>
+ </ul>
+ </prerequisites>
+
+ <steps title="Steps">
+ <section>
+ <title>Copy the WAR file</title>
+ <p>
+ If you've followed the prerequisites, then you will have a working
version
+ of Tomcat installed, and the sources of Xindice compiled. Now, copy
the
+ <code>xindice-*.war</code> file from dist to the
+ <code>%CATALINA_HOME%/webapps</code>.
+ </p>
+ <warning>
+ It is important to rename the file while copying to the
<code>xindice.war</code>,
+ as name of the file defines context name, and Xindice clients and
tools use
+ <code>xindice</code> context name by default.
+ </warning>
+ <p>Here's what that looks like in Windows:</p>
+ <source>
D:\xindice\current\xml-xindice>dir dist
Volume in drive D is Data
Volume Serial Number is A3EB-9689
Directory of D:\xindice\current\xml-xindice\dist
-11/18/2002 01:55p <DIR> .
-11/18/2002 01:55p <DIR> ..
-11/18/2002 01:55p 9,467 xindice-1.1b-examples.jar
-11/20/2002 03:57p 392,842 xindice-1.1b.jar
-11/20/2002 03:57p 2,421,719 xindice-1.1b.war
- 3 File(s) 2,824,028 bytes
- 2 Dir(s) 6,087,331,840 bytes free
+01/01/2004 03:34 PM <DIR> .
+01/01/2004 03:34 PM <DIR> ..
+01/01/2004 03:34 PM 464,594 xindice-1.1b3.jar
+01/01/2004 03:35 PM 4,313,587 xindice-1.1b3.war
+01/01/2004 03:34 PM 253 xindice-1.1b3.xml
+ 3 File(s) 4,778,434 bytes
+ 2 Dir(s) 42,307,837,952 bytes free
-D:\xindice\current\xml-xindice>copy dist\xindice-1.1b.war
%CATALINA_HOME%\webapp
-s\
+D:\xindice\current\xml-xindice>copy dist\xindice-1.1b3.war
%CATALINA_HOME%\webapp
+s\xindice.war
1 file(s) copied.
D:\xindice\current\xml-xindice>
- </source>
- <note>In this example, I have built Xindice in
D:\xindice\current. If you compile the source in another location, just
substitute that path for D:\xindice\current.</note>
- <p> </p>
- <p>If you are using Linux, your session might resemble:</p>
- <source>
[EMAIL PROTECTED]:/local/xml-xindice# ls -oat dist
-total 2760
+ </source>
+ <note>
+ In this example, I have built Xindice in
<code>D:\xindice\current</code>.
+ If you compile the source in another location, just substitute that
path for
+ <code>D:\xindice\current</code>.
+ </note>
+ <p> </p>
+ <p>If you are using Linux, your session might resemble:</p>
+ <source>
[EMAIL PROTECTED]:/local/xml-xindice# ls -oa dist
+total 4668
drwxr-xr-x 2 root 4096 Nov 25 20:10 .
--rw-r--r-- 1 root 247 Nov 25 20:10 xindice-1.1b.xml
drwxr-xr-x 13 root 4096 Nov 25 00:01 ..
--rw-r--r-- 1 root 9504 Nov 23 15:27 xindice-1.1b-examples.jar
--rw-r--r-- 1 root 2408531 Nov 23 15:27 xindice-1.1b.war
--rw-r--r-- 1 root 379794 Nov 23 15:27 xindice-1.1b.jar
[EMAIL PROTECTED]:/local/xml-xindice# cp dist/xindice-1.1b.war
$CATALINA_HOME/webapps
+-rw-r--r-- 1 root 464594 Jan 1 15:34 xindice-1.1b3.jar
+-rw-r--r-- 1 root 4313587 Jan 1 15:35 xindice-1.1b3.war
+-rw-r--r-- 1 root 253 Jan 1 15:34 xindice-1.1b3.xml
[EMAIL PROTECTED]:/local/xml-xindice# cp dist/xindice-1.1b3.war
$CATALINA_HOME/webapps/xindice.war
[EMAIL PROTECTED]:/local/xml-xindice#
- </source>
- <note>In this Linux session, the Xindice root directory
- is in <code>/local/xml-xindice</code>. You should
- substitute your actual <code>XINDICE_HOME</code>
- path for <code>/local/xml-xindice</code>.
- </note>
- </section>
- <section>
- <title>Edit the Tomcat <code>server.xml</code> File</title>
- <fixme author="jcarroll">Need section on inserting
- XINDICE_HOME/dist/xindice-1.1b.xml entry into the
- CATALINA_HOME/conf/server.xml file here.
- </fixme>
- </section>
- <section>
- <title>Restart Tomcat</title>
- <p>Restart your Tomcat server to be certain that it picks up the
Xindice servlet.</p>
- <p>Here's what that looks like in Windows</p>
- <source>
+ </source>
+ <note>
+ In this Linux session, the Xindice root directory is in
+ <code>/local/xml-xindice</code>. You should substitute your actual
+ <code>XINDICE_HOME</code> path for <code>/local/xml-xindice</code>.
+ </note>
+ </section>
+
+ <section>
+ <title>Edit the Tomcat's server.xml File (Optional)</title>
+ <p>
+ Tomcat will automatically deploy copied war file with the default
settings.
+ To modify those defaults, <code>CATALINA_HOME/conf/server.xml</code>
file
+ should be edited. Suggested changes for the server.xml file are
contained
+ in the <code>XINDICE_HOME/dist/xindice-1.1b3.xml</code> file.
+ </p>
+ </section>
+
+ <section>
+ <title>Restart Tomcat</title>
+ <p>
+ Restart your Tomcat server to be certain that it picks up the
Xindice servlet.
+ This step is required if you have edited
<code>CATALINA_HOME/conf/server.xml</code>
+ file. In other cases, it is usually not required.
+ </p>
+ <p>Here's what that looks like in Windows</p>
+ <source>
D:\xindice\current\xml-xindice>cd %CATALINA_HOME%\bin
D:\jakarta-tomcat-4.1.12\bin>startup
@@ -92,37 +132,47 @@
Using CATALINA_TMPDIR: D:\jakarta-tomcat-4.1.12\temp
Using JAVA_HOME: C:\j2sdk1.4.1_01
D:\jakarta-tomcat-4.1.12\bin>
- </source>
- <note>In this example, I have installed Tomcat in
D:\jakarta-tomcat-4.1.12. If you've installed it in another location, just
ensure that the CATALINA_HOME environmental variable points to your Tomcat
installation directory, or substitute that path for
D:\jakarta-tomcat-4.1.12.</note>
- <p> </p>
- <p>Here's what that might look like on Linux</p>
- <source>
+ </source>
+ <note>
+ In this example, I have installed Tomcat in
<code>D:\jakarta-tomcat-4.1.12</code>.
+ If you've installed it in another location, just ensure that the
+ <code>CATALINA_HOME</code> environmental variable points to your
Tomcat
+ installation directory, or substitute that path for
+ <code>D:\jakarta-tomcat-4.1.12.</code>
+ </note>
+ <p> </p>
+ <p>Here's what that might look like on Linux</p>
+ <source>
[EMAIL PROTECTED]:/var/tomcat4/bin# ./catalina.sh start
Using CATALINA_BASE: /var/tomcat4
Using CATALINA_HOME: /var/tomcat4
Using CATALINA_TMPDIR: /var/tomcat4/temp
Using JAVA_HOME: /usr/java/jdk1.3.1_06
[EMAIL PROTECTED]:/var/tomcat4/bin#
- </source>
- <note>The name of the Tomcat installation directory may
- differ for your Linux platform. The default
- location is <code>/var/tomcat4</code>. If you
- are unsure of the location, check the
- <code>tomcat4.conf</code> file in your
- <code>/etc/tomcat4</code> directory.
- </note>
- <p> </p>
- <warning>If you installed the RPM version of Tomcat v4.x,
- you may need to enter "<code>tomcat4 start</code>"
- to invoke the Tomcat server. The FreeBSD version
- of Tomcat may be using <code>tomcat41ctl</code>.
- </warning>
- <p> </p>
- </section>
- <section>
- <title>Verify the installation</title>
- <p>When Tomcat restarts on Windows, you should see a new window
open entitled 'Tomcat', and it should look something like this. (Note the
xindice classes loading.)</p>
- <source>
+ </source>
+ <note>
+ The name of the Tomcat installation directory may differ for your
Linux
+ platform. The default location is <code>/var/tomcat4</code>. If you
+ are unsure of the location, check the <code>tomcat4.conf</code> file
in your
+ <code>/etc/tomcat4</code> directory.
+ </note>
+ <p> </p>
+ <warning>
+ If you installed the RPM version of Tomcat v4.x, you may need to
enter
+ "<code>tomcat4 start</code>" to invoke the Tomcat server. The
FreeBSD
+ version of Tomcat may be using <code>tomcat41ctl</code>.
+ </warning>
+ <p> </p>
+ </section>
+
+ <section>
+ <title>Verify the installation</title>
+ <p>
+ When Tomcat restarts on Windows, you should see a new window open
entitled
+ 'Tomcat', and it should look something like this. (Note the xindice
classes
+ loading.)
+ </p>
+ <source>
Nov 21, 2002 1:42:07 PM org.apache.commons.modeler.Registry loadRegistry
INFO: Loading registry information
Nov 21, 2002 1:42:07 PM org.apache.commons.modeler.Registry getRegistry
@@ -143,11 +193,13 @@
INFO: JK2: ajp13 listening on tcp port 8009
Nov 21, 2002 1:42:24 PM org.apache.jk.server.JkMain start
INFO: Jk running ID=0 time=20/70
config=D:\jakarta-tomcat-4.1.12\conf\jk2.properties
- </source>
- <p> </p>
- <p>Here's what the <code>$CATALINA_HOME/logs/catalina.out</code>
- output looks like on Linux</p>
- <source>
+ </source>
+ <p> </p>
+ <p>
+ Here's what the <code>$CATALINA_HOME/logs/catalina.out</code> output
looks
+ like on Linux
+ </p>
+ <source>
[INFO] Registry - -Loading registry information
[INFO] Registry - -Creating new Registry instance
[INFO] Registry - -Creating MBeanServer
@@ -160,11 +212,18 @@
[INFO] ChannelSocket - -JK2: ajp13 listening on tcp port 8009
[INFO] JkMain - -Jk running ID=0 time=4/168
config=/var/tomcat4/conf/jk2.properties
- </source>
- <p>In addition, you should be able to verify that xindice is
running by loading this URL in your browser http://localhost:8080/xindice-1.1b
- If it works, you should see something that says "THIS
IS AN UGLY DEBUG TOOL!".
- </p>
- </section>
- <p>If you run into problems, don't worry. Be sure to send <link
href="../../../mail.html">feedback</link> so that we can improve these
documents for the next person.</p>
- </steps>
+ </source>
+ <p>
+ In addition, you should be able to verify that xindice is running by
+ loading this URL in your browser
<code>http://localhost:8080/xindice</code>.
+ If it works, you should see something that says
+ "<code>THIS IS AN UGLY DEBUG TOOL!</code>".
+ </p>
+ </section>
+ <p>
+ If you run into problems, don't worry. Be sure to send
+ <link href="../../../mail.html">feedback</link> so that we can improve
these
+ documents for the next person.
+ </p>
+ </steps>
</howto>
