You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by cr...@apache.org on 2001/07/28 00:26:03 UTC
cvs commit: jakarta-tomcat-4.0 BUILDING.txt RUNNING.txt README.txt build.xml INSTALL.txt build.bat build.sh
craigmcc 01/07/27 15:26:03
Modified: . README.txt build.xml
Added: . BUILDING.txt RUNNING.txt
Removed: . INSTALL.txt build.bat build.sh
Log:
Update build and install documentation to current formats, similar to that
used on "jakarta-servletapi-4" and "jakarta-watchdog-4.0". Remove the top
level "build.bat" and "build.sh" scripts, since they are now unnecessary.
TODO: Tweak the build.xml files (and corresponding BUILDING.txt notes)
for configurability of the remaining packages that do not have documented
property names you can override in "build.properties".
Revision Changes Path
1.16 +61 -278 jakarta-tomcat-4.0/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/README.txt,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- README.txt 2001/03/30 21:23:24 1.15
+++ README.txt 2001/07/27 22:26:03 1.16
@@ -1,281 +1,64 @@
- Apache Tomcat 4.0
- =================
+$Id: README.txt,v 1.16 2001/07/27 22:26:03 craigmcc Exp $
+ The Tomcat 4.0 Servlet/JSP Container
+ ====================================
-Introduction
-============
+This subproject contains a server that conforms to the Servlet 2.3 and
+JSP 1.2 specifications from Java Software. It includes the following contents:
-This CVS module contains the code for Tomcat 4.0, and will also be
-used for further development of 4.x versions. It is divided into several
-major components, each of which you can build and use separately, that are
-combined to create Tomcat. The components are:
-
-* Catalina - Servlet container conforming to the Servlet API Specification,
- version 2.3 (currently in Initial Public Draft).
-
-* Jasper - JSP compiler and runtime environment conforming to the
- JavaServer Pages (JSP) Specification, version 1.2 (currently in
- Initial Public Draft).
-
-* Tester - Unit test web application, with tests that are primarily focused
- on Tomcat features rather than spec compliance.
-
-* Webapps - Example and test web applications, and associated documentation,
- that are packaged with Tomcat.
-
-
-Installing Tomcat 4.0 Source Code
-=================================
-
-In order to successfully build Tomcat 4.0, you will need to do the following.
-In the instructions below, $JAKARTA_HOME is assumed to be the directory into
-which you are installing all of the required Jakarta distributions.
-
-* Download and install a version 1.2 or later Java Development Kit
- implementation for your operating system platform. Set a "JAVA_HOME"
- environment variable to point at the directory where your JDK is installed,
- and add "$JAVA_HOME/bin" to your PATH. Configure the CLASSPATH environment
- variable as well, if required.
-
-* Download and install the Java Naming and Directory Interface (JNDI) package,
- version 1.2.1 or later, from <http://java.sun.com/products/jndi>. Set an
- environment variable "JNDI_HOME" pointing at the directory to which you
- installed the distribution. None of the standard JNDI providers are required
- unless you need them in your own applications.
-
-* If you want to have support for the JavaMail object factories, you must
- download the JavaMail (Version 1.2 or later) and Java Activation Framework
- (Version 1.0.1 or later), and make sure that the "mail.jar" and
- "activation.jar" files, respectively, are on your CLASSPATH.
-
-* If you want to build in support for JNDI JDBC DataSources you need to
- download the following packages and put their jar files in your classpath.
-
- Tyrex http://tyrex.exolab.org/
-
- Java Transaction API (JTA) http://java.sun.com/products/jta
-
- Java JDBC 2.0 Optional Extensions http://java.sun.com/products/jdbc/
-
-* If you are running a JDK earlier than 1.3, you will also need to place the
- "jndi.jar" file on your CLASSPATH in order to build Tomcat.
-
-* Download and install the Java Secure Sockets Extension (JSSE) implementation
- (current version number is 1.0.2) from <http://java.sun.com/products/jsse>.
- Set an environment variable "JSSE_HOME" pointing at the directory to which
- you installed this distribution.
-
-* Download and install the Java Management Extensions (JMX) "JMX
- Instrumentation and Agent Reference Implementation" (current version
- number is 1.0) from
- <http://java.sun.com/products/JavaManagement/download.html>.
- Set an environment variable "JMX_HOME" pointing at the directory to which
- you installed this distribution.
-
-* Download and install the Ant distribution (subproject "jakarta-ant") into
- a directory named "$JAKARTA_HOME/jakarta-ant". If you have downloaded the
- source distribution, you will need to build the executable version by
- executing the following commands:
-
- cd $JAKARTA_HOME/jakarta-ant
- ./bootstrap.sh <-- Unix
- bootstrap <-- Windows
-
- This should result in the creation of a file "ant.jar" in the "lib"
- subdirectory, which will be used when building Tomcat.
- If you download a binary distribution, you must get Ant version 1.2 or later.
-
-* Download and install the Regular Expressions distribution (module
- "jakarta-regexp"). Assuming an install directory <install-dir>:
-
- Binary distribution
- Set the REGEXP_HOME env variable to point to <install-dir>
-
- Source distribution
- Build the library by executing the following commands:
- cd <install-dir>/build
- ./build-regexp.sh <-- Unix
- build-regexp <-- Windows
- Set the REGEXP_HOME env variable to point to <install-dir>/bin
-
-* Download and install the Servletapi distribution that includes the
- Servlet 2.3 and JSP 1.2 API classes. A link is available on the Jakarta
- web site at <http://jakarta.apache.org/downloads/binindex.html>. When
- unpacked, this distribution will create a directory named
- "jakarta-servletapi-4". Set an environment variable named
- SERVLETAPI_HOME that points to where you have placed this directory.
-
- If you wish to create this package from the CVS archives, you will need
- to follow these steps:
-
- cd $JAKARTA_HOME
- cvs checkout jakarta-servletapi-4
- cd jakarta-servletapi-4
- ./build.sh dist <-- Unix
- build dist <-- Windows
-
- to create the required servlet.jar file and Javadoc documentation.
-
- If you do this, you should set your SERVLETAPI_HOME environment variable
- to point at "$JAKARTA_HOME/jakarta-servletapi-4/dist".
-
-* Download the Tomcat 4.0 source repository (module
- "jakarta-tomcat-4.0") via anonymous CVS into a directory named
- "$JAKARTA_HOME/jakarta-tomcat-4.0", or download a nightly distribution.
- A link is provided on the Jakarta web site at
- <http://jakarta.apache.org/downloads/binindex.html>.
-
-
-BUILDING TOMCAT 4.0
-===================
-
-* After downloading and installing the required software components,
- described in the previous section, you can build the entire Tomcat 4.0
- suite as follows:
-
- cd $JAKARTA_HOME/jakarta-tomcat-4.0
- ./build.sh <-- Unix
- build <-- Windows
-
- This will create a complete build of Catalina, Jasper, and the example
- web applications in "$JAKARTA_HOME/jakarta-tomcat-4.0/build".
-
-* To create a "distribution" build of Tomcat 4.0, with file contents that
- are equivalent to the nightly distributions, do this:
-
- cd $JAKARTA_HOME/jakarta-tomcat-4.0
- ./build.sh dist <-- Unix
- build dist <-- Windows
-
- This will create a complete distribution build of Catalina, Jasper, and
- the example web applications in
- "$JAKARTA_HOME/jakarta-tomcat-4.0/dist".
-
-* If you are interested in building only the individual components, there
- are separate build scripts for each in the corresponding subdirectories.
- Use the "deploy" task if you want to compile this component into the
- consolidated Tomcat 4.0 "build" directory (this is what the top level
- build scripts do for you), or build the individual pieces like this:
-
- cd $JAKARTA_HOME/catalina
- ./build.sh <-- Unix
- build <-- Windows
-
- cd ../jasper
- ./build.sh <-- Unix
- build <-- Windows
-
- cd ../webapps
- ./build.sh <-- Unix
- build <-- Windows
-
- These steps create compiled versions of the components in the following
- subdirectories:
-
- $JAKARTA_HOME/jakarta-tomcat-4.0/catalina/build
- $JAKARTA_HOME/jakarta-tomcat-4.0/jasper/build
- $JAKARTA_HOME/jakarta-tomcat-4.0/webapps/build
-
-* If you modify source files in any of the component, be sure that you
- run the "deploy" target for that component (once you are satisfied that
- your code compiles with no errors). You can do "deploys" from any of the
- components in any desired sequence, but all of them must have succeeeded
- in order to have a runnable build.
-
-* Each of the component build scripts also has a "dist" target, which
- packages that component under directories "catalina/dist",
- "jasper/dist", and "webapps/dist", respectively. These targets are
- useful if you wish to package the components of Tomcat in combinations
- with other application bundles.
-
-
-Running the Build
-=================
-
-* You can start the unpacked version of Tomcat 4.0 as follows:
-
- cd $JAKARTA_HOME/jakarta-tomcat-4.0/build
- ./bin/catalina.sh start <-- Unix
- bin\catalina start <-- Windows
-
-* To access the default content and examples, access the
- following URL with your browser:
-
- http://localhost:8080
-
-* To shut down the unpacked version of Tomcat 4.0:
-
- cd $JAKARTA_HOME/jakarta-tomcat-4.0/build
- ./bin/catalina.sh stop <-- Unix
- bin\catalina stop <-- Windows
-
-* You can also set an environment variable CATALINA_HOME so that you
- can start and stop Tomcat 4.0 from any directory. For example:
-
- export CATALINA_HOME=$JAKARTA_HOME/jakarta-tomcat-4.0/build
- $CATALINA_HOME/bin/catalina.sh start
-
-
-Reporting Bugs
-==============
-
-If you encounter any bugs in Catalina, or wish to contribute a patch, or
-wish to suggest any functionality improvements, please report them to our
-bug tracking system, at:
-
- http://jakarta.apache.org/bugs
-
-against product categories "Catalina", "Jasper", and "Webapps", depending
-on where the problem you are reporting exists.
-
-
-Before Committing Changes
-=========================
-
-Before committing any changes to the Tomcat 4.0 CVS repository, you MUST do a
-"build clean" followed by a "build deploy.main dist" with the top level build
-scripts, to ensure that the entire build process runs cleanly. Also, ensure
-that all current tests (both internal to Tomcat and those in Watchdog) run
-correctly with your updated code.
-
-XML parsers in Tomcat 4.0
-=========================
-
- In the tomcat-4.0 build procedure, an XML parser is required for three
- different components:
-
- 1. ant
- See ant specific requirements for an XML parser
- 2. catalina
- At least JAXP1.0 compliant XML parser
- 3. jasper
- At least JAXP1.1 compliant XML parser
-
- All of these requirements can be handled globally by setting
- environment variable JAXP_HOME (as described above).
-
- The default jar files used for XML parsing are then:
- JAXP_HOME/jaxp.jar and JAXP_HOME/crimson.jar
-
- * To change the 'XML parser' jar file used:
-
- JAXP_PARSER_JAR [default: crimson.jar]
- (e.g. xerces.jar)
-
- * To set the XML parser of each component individually:
-
- ANT_XML_CLASSPATH [default: JAXP_HOME/JAXP_PARSER_JAR;JAXP_HOME/jaxp.jar]
-
- CATALINA_JAXP_HOME [default: JAXP_HOME]
- CATALINA_JAXP_PARSER_JAR [default: JAXP_PARSER_JAR]
-
- JASPER_JAXP_HOME [default: JAXP_HOME]
- JASPER_JAXP_PARSER_JAR [default: JAXP_PARSER_JAR]
-
- ----> WARNING: The current build process uses a special copy of the
- jaxp.jar and crimson.jar files from JAXP/1.1 (Final)
- that has had the "sealed" attribute removed. This works
- around "sealing violation" errors that occur when Tomcat 4.0
- is run under JDK 1.3. As a result of this, the
- JASPER_JAXP_HOME and JASPER_JAXP_PARSER_JAR environment
- variables are currently ignored.
+ BUILDING.txt Instructions for building from sources
+ LICENSE Apache Software License for this release
+ README.txt This document
+ RELEASE-NOTES-*.txt Release Notes for this (and previous) releases
+ of Tomcat 4.0
+ RUNNING.txt Instructions for installing Tomcat, as well as
+ starting and stopping the server
+ bin/ Binary executables and scripts
+ classes/ Unpacked classes global to web applications
+ common/ Classes available to both Catalina internal
+ classes and web applications:
+ classes/ Unpacked common classes
+ lib/ Common classes in JAR files
+ conf/ Configuration files
+ jasper/ JAR files visible only in the Jasper classloader
+ lib/ Classes in JAR files global to web applications
+ logs/ Destination directory for log files
+ server/ Internal Catalina classes and their dependencies
+ classes/ Unpacked classes (internal only)
+ lib/ Classes packed in JAR files (internal only)
+ webapps/ Base directory containing web applications
+ included with Tomcat 4.0
+ work/ Scratch directory used by Tomcat for holding
+ temporary files and directories
+
+If you wish to build the Tomcat server from a source distribution,
+please consult the documentation in "BUILDING.txt".
+
+If you wish to install and run a binary distribution of the Tomcat server,
+please consult the documentation in "RUNNING.txt".
+
+
+ Acquiring Tomcat 4.0 Releases
+ =============================
+
+Nightly Builds
+--------------
+
+Nightly Builds of Tomcat 4.0 are built from the most recent CVS sources each
+evening (Pacific Time). The filename of the downloadable file includes the
+date it was created (in YYYYMMDD format). These builds are available at:
+
+Binary: http://jakarta.apache.org/builds/jakarta-tomcat-4.0/nightly/
+Source: http://jakarta.apache.org/builds/jakarta-tomcat-4.0/nightly/src/
+
+
+Release Builds
+--------------
+
+Release Builds of Tomcat 4.0 are created and released periodically, and
+announced to the interested mailing lists. Each release build resides in its
+own directories. For example, the Tomcat 4.0-beta-6 release is available at:
+
+Binary: http://jakarta.apache.org/builds/jakarta-tomcat-4.0/release/v4.0-b6/
+Source: http://jakarta.apache.org/builds/jakarta-tomcat-4.0/release/v4.0-b6/src/
+
1.31 +4 -1 jakarta-tomcat-4.0/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/build.xml,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- build.xml 2001/07/20 21:46:32 1.30
+++ build.xml 2001/07/27 22:26:03 1.31
@@ -92,8 +92,11 @@
<copy todir="${tomcat.dist}">
<fileset dir=".">
<include name="LICENSE"/>
- <include name="NEW_SPECS.txt"/>
+ <include name="INSTALLING.txt"/>
+ <include name="BUILDING.txt"/>
+ <include name="README.txt"/>
<include name="RELEASE*"/>
+ <include name="RUNNING*"/>
</fileset>
</copy>
1.1 jakarta-tomcat-4.0/BUILDING.txt
Index: BUILDING.txt
===================================================================
$Id: BUILDING.txt,v 1.1 2001/07/27 22:26:03 craigmcc Exp $
Building The Tomcat 4.0 Servlet/JSP Container
=============================================
This subproject contains the source code Tomcat 4.0, a server that implements
the Servlet 2.3 and JSP 1.2 Specifications from Java Software. In order to
build a binary distribution version of the container from a source
distribution, you must have a Java Development Kit (JDK) for version 1.2 (or
later) downloaded and installed (version 1.3.1 recommended), and do the
following:
(0) Download and Install a Java Development Kit
* Download a Java Development Kit (JDK) release (version 1.2 or later) from:
http://java.sun.com/j2se/
* Install the JDK according to the instructions included with the release.
* Set an environment variable JAVA_HOME to the pathname of the directory
into which you installed the JDK release.
(1) Download and Install the Ant Binary Distribution
NOTE: These instructions assume that you are using the Ant 1.3 release.
Procedures for Ant 1.4 and later versions should be similar, but have not
been tested.
* Download a binary distribution of Ant 1.3 from:
http://jakarta.apache.org/builds/jakarta-ant/release/v1.3/bin/
On a Windows platform, you will need:
jakarta-ant-1.3-bin.zip
jakarta-ant-1.3-optional.jar
On a Unix platform, you will need:
jakarta-ant-1.3-bin.tar.gz
jakarta-ant-1.3-optional.jar
* Unpack the binary distribution into a convenient location so that the
Ant release resides in its own directory (conventionally named
"jakarta-ant-1.3"). For the purposes of the remainder of this document,
the symbolic name "${ant.home}" is used to refer to the full pathname of
the release directory.
* Copy the file "jakarta-ant-1.3-optional.jar", downloaded above, into
the directory "${ant.home}/lib". This makes available several Ant
extension commands that are commonly required when building Jakarta
based projects.
* Modify the PATH environment variable to include directory
"${ant.home}/bin" in its list. This makes the "ant" command line script
available, which will be used to actually perform the build.
(2) Download and Install the JAXP/1.1 Reference Implementation
* Download a binary distribution of JAXP 1.1 (Final Version) from:
http://java.sun.com/xml/download.html
* Unpack the binary distribution into a convenient location so that the
JAXP/1.1 release resides in its own directory (conventionally named
"jaxp-1.1". For the purposes of the remainder of this document, the
symbolic name "${jaxp.home}" is used to refer to the full pathname of
the release directory.
* Make the JAR files of this distribution ("crimson.jar", "jaxp.jar", and
"xalan.jar") available for use by performing ONE of the following options:
- Remove the existing "jaxp.jar" and "parser.jar" files found in the
"${ant.home}/lib" directory, and copy these JAR files into the
"${ant.home}/lib" directory (prefered option).
- Add these files to your CLASSPATH environment variable when you
execute the build process.
(3) Download and Install Subproject Source Code
* Use Anonymous CVS (as described on the Jakarta web site at
<http://jakarta.apache.org/site/cvsindex.html>, or
download a source distribution from:
http://jakarta.apache.org/builds/jakarta-tomcat-4.0/nightly/src/
On a Windows platform, you will need:
jakarta-tomcat-4.0-src-YYYYMMDD.zip
On a Unix platform, you will need:
jakarta-tomcat-4.0-src-YYYYMMDD.zip
(NOTE: Alternatively, you can grab the source distribution from a
formal release, if you wish, by following links on the Jakarta web site).
* Unpack the source distribution into a convenient location so that the
distribution resides in its own directory (conventionally named
"jakarta-tomcat-4.0"). For the purposes of the remainder of this document,
the symbolic name "${tomcat.source}" is used to refer to the full
pathname of the release directory.
(4) Download and Install the Regular Expressions Binary Distribution
NOTE: Alternatively, you can download the sources of the
"jakarta-regexp" subproject, and build a binary distribution yourself.
* Download a binary distribution from:
http://jakarta.apache.org/builds/jakarta-regexp/release/v1.2/
On a Windows platform, you will need:
jakarta-regexp-1.2.zip
On a Unix platform, you will need:
jakarta-regexp-1.2.tar.gz
* Unpack the binary distribution into a convenient location so that the
distribution resides in its own directory (conventionally named
"jakarta-regexp"). For the purposes of the remainder of this document,
the symbolic name "${regexp.home}" is used to refer to the full pathname
of this directory.
FIXME: This step and the associated stuff in build.xml files needs to be
made independent of the actual jakarta-regexp version number.
(5) Download and Install the Servlet API Binary Distribution
NOTE: Alternatively, you can download the sources of the
"jakarta-servletapi-4" subproject, and build a binary distribution yourself.
* Download a binary distribution from:
http://jakarta.apache.org/builds/jakarta-servletapi-4/nightly/
On a Windows platform, you will need:
jakarta-servletapi-4-YYYYMMDD.zip
On a Unix platform, you will need:
jakarta-servletapi-4-YYYYMMDD.zip
* Unpack the binary distribution into a convenient location so that the
distribution resides in its own directory.
(6) Download and Install JDBC Optional Package API (OPTIONAL)
NOTE: This step is only required if you wish to build the Tyrex connection
pool implementation for JNDI-accessed data sources.
* Download the JDBC Optional Pacakge API package (version 2.0) from:
http://java.sun.com/products/jdbc/download.html
* Unpack the package into a convenient location so that it resides
in its own subdirectory.
(7) Download and Install JavaMail and Java Activation Framework (OPTIONAL)
NOTE: This step is required only if you plan to build the resource object
factories for creating mail-related JNDI resources.
* Download the JavaMail Reference Implementation (version 1.2 or later) from:
http://java.sun.com/products/javamail/
* Unpack the reference implementation into a convenient location so that
it resides in its own subdirectory.
* Download the "JavaBeans Activation Framework" (version 1.0.1 or later) from:
http://java.sun.com/products/javabeans/glasgow/jaf.html
* Unpack the framework into a convenient location so that it resides
in its own subdirectory.
(8) Download and Install the JMX 1.0 Reference Implementation
* Download the JMX Instrumentation and Agent Reference Implementation
(version 1.0 or later) from
http://java.sun.com/products/JavaManagement/download.html
* Unpack the reference implementation into a convenient location so that
it resides in its own subdirectory.
(9) Download and Install the JNDI 1.2.1 Reference Implementation
NOTE: This step is required to build Tomcat 4.0, even when you are running
a JDK 1.3 (or later) platform that includes the JNDI classes. This is because
the Tomcat build process includes "jndi.jar" into the binary distribution.
* Download the Java Naming and Directory Interface (JNDI) package,
(version 1.2.1 or later) from
http://java.sun.com/products/jndi/
* Unpack the reference implementation into a convenient location so that
it resides in its own subdirectory.
(10) Download and Install the JSSE 1.0.2 Reference Implementation
* Download the Java Secure Sockets Extension (JSSE) package,
(version 1.0.2 or later) from
http://java.sun.com/products/jsse/
* Unpack the reference implementation into a convenient location so that
it resides in its own subdirectory.
(11) Download and Install the Java Transaction APIs (OPTIONAL)
NOTE: This step is only required if you wish to build the Tyrex connection
pool implementation for JNDI-accessed data sources.
* Download the Java Transaction API (JTA) package (version 1.0.1) from:
http://java.sun.com/products/jta/
* Unpack the package into a convenient location so that it resides in its
own subdirectory.
(12) Download and Install the JUnit Testing Package (OPTIONAL)
NOTE: This step is only required if you wish to build and execute the unit
tests that are part of the Tomcat 4.0 source base.
* Download the JUnit unit test package (version 3.7 or later) from:
http://www.junit.org/
* Unpack the package into a convenient location so that it resides in its
own subdirectory.
(13) Download and Install the Tyrex Data Source Package (OPTIONAL)
NOTE: This step is only required if you wish to build the Tyrex connection
pool implementation for JNDI-accessed data sources.
* Download the Tyrex JAR or release (version 0.9.7) from:
http://tyrex.exolab.org/download.html
* Unpack the package into a convenient location so that it resides in its
own subdirectory.
(13) Customize Build Properties For This Subproject
Most Jakarta subprojects allow you to customize Ant properties (with default
values defined in the "build.xml" file. This is done by creating a text file
named "build.properties" in the source distribution directory (for property
definitions local to this subproject) and/or your user home directory (for
property definitions shared across subprojects). You can use the included
"build.properties.sample" file as a starting point for this.
Tomcat has several external dependencies that are satisfied by configuring
appropriate values in your <code>build.properties</code> file. You must set
the following properties:
Property Name Description
---------------- --------------------------------------------------------
jmx.home Pathname to directory containing the Java Management
Extensions (JMX) Reference Implementation, version 1.0
or later
jndi.home Pathname to directory containing the Java Naming and
Directory Interface (JNDI) Reference Implementation,
version 1.2.1 or later
jsse.home Pathname to directory containing the Java Secure Sockets
Extension (JSSE) Reference Implementation, version 1.0.2
or later
junit.jar Pathname to the "junit.jar" file from JUnit, version 3.7
or later
regexp.home Pathname to directory containing a binary distribution of
the Jakarta Regexp Project, version 1.2
servletapi.home Pathname to directory containing a binary distribution of
the Servlet 2.3/JSP 1.2 API classes
FIXME: Properties for mail.jar, activation.jar, jdbc2_0-stdext.jar,
jta-spec1_0_1.jar, tyrex-0.9.7.0.jar
A short-cut to preparing your "build.properties" file is to make a copy of the
"build.properties.sample" file included in the Tomcat source distribution,
and then customize the paths within it.
(14) Build A Binary Distribution
Open a command line shell, and issue the following commands:
cd ${tomcat.source}
ant -projecthelp
If everything is installed correctly, you should see a list of the Ant
"targets" that represent different commands you might wish to build. By
convention, the "dist" target creates a complete binary distribution. To
execute it, type the following commands:
cd ${tomcat.source}
ant dist
This will create a complete binary distribution of the subproject (equivalent
in structure to the corresponding binary distribution downloadable from the
Jakarta web site), in the "${tomcat.source}/dist" directory. It will have
the contents described in the corresponding "README.txt" file.
See the document RUNNING.txt for instructions on how to start up and shut down
the servlet/JSP container.
1.1 jakarta-tomcat-4.0/RUNNING.txt
Index: RUNNING.txt
===================================================================
$Id: RUNNING.txt,v 1.1 2001/07/27 22:26:03 craigmcc Exp $
Running The Tomcat 4.0 Servlet/JSP Container
============================================
This subproject contains Tomcat 4.0, a server that implements the Servlet 2.3
and JSP 1.2 Specifications from Java Software. In order to install and run
this container, you must do the following:
(0) Download and Install a Java Development Kit
* Download a Java Development Kit (JDK) release (version 1.2 or later) from:
http://java.sun.com/j2se/
* Install the JDK according to the instructions included with the release.
* Set an environment variable JAVA_HOME to the pathname of the directory
into which you installed the JDK release.
(1) Download and Install the Tomcat 4.0 Binary Distribution
NOTE: As an alternative to downloading a binary distribution, you can create
your own from the Tomcat source repository, as described in "BUILDING.txt".
If you do this, the value to use for "${catalina.home}" will be the "dist"
subdirectory of your source distribution.
* Download a binary distribution of Tomcat from:
http://jakarta.apache.org/builds/jakarta-tomcat-4.0/nightly/
On a Windows platform, you will need:
jakarta-tomcat-4.0-YYYYMMDD.zip
On a Unix platform, you will need:
jakarta-tomcat-4.0-YYYYMMDD.zip
* Unpack the binary distribution into a convenient location so that the
distribution resides in its own directory (conventionally named
"jakarta-tomcat-4.0"). For the purposes of the remainder of this document,
the symbolic name "${catalina.home}" is used to refer to the full
pathname of the release directory.
(2) Start Up Tomcat 4.0
There are two techniques by which Tomcat 4.0 can be started:
* Via an environment variable:
- Set an environment variable CATALINA_HOME to the path of the directory
into which you have installed Tomcat 4.0.
- Execute the shell command:
%CATALINA_HOME%\bin\startup (Windows)
$CATALINA_HOME/bin/startup.sh (Unix)
* By modifying your current working directory:
- Execute the following shell commands:
cd %CATALINA_HOME%\bin (Windows)
startup (Windows)
cd $CATALINA_HOME/bin (Unix)
./startup.sh (Unix)
After startup, the default web applications included with Tomcat 4.0 will be
available by browsing:
http://localhost:8080/
Further information about configuring and running Tomcat 4.0 can be found in
the documentation included here, as well as on the Tomcat web site:
http://jakarta.apache.org/tomcat/
(3) Shut Down Tomcat 4.0
There are two techniques by which Tomcat 4.0 can be stopped:
* Via an environment variable:
- Set an environment variable CATALINA_HOME to the path of the directory
into which you have installed Tomcat 4.0.
- Execute the shell command:
%CATALINA_HOME%\bin\shutdown (Windows)
$CATALINA_HOME/bin/shutdown.sh (Unix)
* By modifying your current working directory:
- Execute the following shell commands:
cd %CATALINA_HOME%\bin (Windows)
shutdown (Windows)
cd $CATALINA_HOME/bin (Unix)
./shutdown.sh (Unix)
(4) Troubleshooting:
There are only really 3 things that can go wrong during the stand-alone
Tomcat 4.0 install:
1) The most common hiccup is when another web server (or any process for that
matter) has laid claim to port 8080. This is the default HTTP port that
Tomcat attempts to bind to at startup. To change this, open the file:
$CATALINA_HOME/conf/server.xml
...and search for '8080'. Change it to a port that isn't in use, and is
greater than 1024, as ports less than or equal to 1024 require superuser
access to bind to.
Restart Tomcat and you're in business. Be sure that you replace the "8080"
in the URL you're using to access Tomcat. For example, if you change the
port to 1977, you would request the URL http://localhost:1977/.
2) An "out of environment space" error when running the batch files in
Win9X/ME-based operating systems.
Right-click on the STARTUP.BAT and SHUTDOWN.BAT files. Click on
"Properties" then on the "Memory" tab. For the "Initial environment" field,
enter in something like 4096.
After you click apply, Windows will create shortcuts in the directory with
which you can use to start and stop the container.
3) The 'localhost' machine isn't found. This could happen if you're behing a
proxy. If that's the case, make sure the proxy configuration for your
browser knows that you shouldn't be going through the proxy to access the
"localhost" machine.
In Netscape, this is under Edit/preferences -> Advanced/proxies, and in
Internet Explorer, Tools -> Internet Options -> Connections -> LAN Settings.