You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by kk...@apache.org on 2011/11/02 19:31:50 UTC
svn commit: r1196746 - in /tomcat/tc7.0.x/trunk: ./ RUNNING.txt
webapps/docs/changelog.xml
Author: kkolinko
Date: Wed Nov 2 18:31:50 2011
New Revision: 1196746
URL: http://svn.apache.org/viewvc?rev=1196746&view=rev
Log:
Merged revisions r1175798 r1196735 from tomcat/trunk:
Improve RUNNING.txt:
- Better describe environment variables.
- Document setenv scripts.
- Mention "catalina start"/"catalina stop" as well as "startup"/"shutdown" scripts.
- Better document running with separate CATALINA_BASE and CATALINA_HOME.
- Provide example of setenv files and example of using a context that points to ${catalina.home}.
- Replace Netscape browser instructions with Firefox ones.
- Add several references to User Guide and Configuration Reference.
Modified:
tomcat/tc7.0.x/trunk/ (props changed)
tomcat/tc7.0.x/trunk/RUNNING.txt
tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml
Propchange: tomcat/tc7.0.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Wed Nov 2 18:31:50 2011
@@ -1 +1 @@
-/tomcat/trunk:1156115,1156171,1156276,1156304,1156519,1156530,1156602,1157015,1157018,1157151,1157198,1157204,1157810,1157832,1157834,1157847,1157908,1157939,1158155,1158160,1158176,1158195,1158198-1158199,1158227,1158331,1158334-1158335,1158426,1160347,1160592,1160611,1160619,1160626,1160639,1160652,1160720-1160721,1160772,1160774,1160776,1161303,1161310,1161322,1161339,1161486,1161540,1161549,1161584,1162082,1162149,1162169,1162721,1162769,1162836,1162932,1163630,1164419,1164438,1164469,1164480,1164567,1165234,1165247-1165248,1165253,1165273,1165282,1165309,1165331,1165338,1165347,1165360-1165361,1165367-1165368,1165602,1165608,1165677,1165693,1165721,1165723,1165728,1165730,1165738,1165746,1165765,1165777,1165918,1165921,1166077,1166150-1166151,1166290,1166366,1166620,1166686,1166693,1166752,1166757,1167368,1167394,1169447,1170647,1171692,1172233-1172234,1172236,1172269,1172278,1172282,1172556,1172610,1172664,1172689,1172711,1173020-1173021,1173082,1173088,1173090,1173096
,1173241,1173256,1173288,1173333,1173342,1173461,1173614,1173630,1173659,1173722,1174061,1174239,1174322,1174325,1174329-1174330,1174337-1174339,1174343,1174353,1174799,1174882,1174884,1174983,1175155,1175158,1175167,1175182,1175190,1175201,1175272,1175275,1175283,1175582,1175589-1175590,1175594,1175602,1175613,1175633,1175690,1175713,1175889,1175896,1175907,1176584,1176590,1176799,1177050,1177060,1177125,1177152,1177160,1177245,1177850,1177862,1177978,1178209,1178228,1178233,1178449,1178542,1178681,1178684,1178721,1179268,1179274,1180261,1180865,1180891,1180894,1180907,1181028,1181123,1181125,1181136,1181291,1181743,1182796,1183078,1183105,1183142,1183328,1183339-1183340,1183492-1183494,1183605,1184917,1184919,1185018,1185020,1185200,1185588,1185626,1185756,1185758,1186011,1186042-1186045,1186104,1186123,1186137,1186153,1186254,1186257,1186377-1186379,1186479-1186480,1186712,1186743,1186750,1186763,1186890-1186892,1186894,1186949,1187018,1187027-1187028,1187381,1187755,1187
775,1187827,1188301,1188303-1188305,1188399,1188822,1188930-1188931,1189116,1189129,1189183,1189240,1189256,1189386,1189413-1189414,1189477,1189685,1189805,1189857,1189864,1189882,1190034,1190185,1190279,1190339,1190371,1190388-1190389,1190474,1190481,1194915,1195222-1195223,1195531,1195899,1195905,1195943,1195949,1195953,1195955,1195965,1195968,1196175,1196212,1196223,1196304-1196305
+/tomcat/trunk:1156115,1156171,1156276,1156304,1156519,1156530,1156602,1157015,1157018,1157151,1157198,1157204,1157810,1157832,1157834,1157847,1157908,1157939,1158155,1158160,1158176,1158195,1158198-1158199,1158227,1158331,1158334-1158335,1158426,1160347,1160592,1160611,1160619,1160626,1160639,1160652,1160720-1160721,1160772,1160774,1160776,1161303,1161310,1161322,1161339,1161486,1161540,1161549,1161584,1162082,1162149,1162169,1162721,1162769,1162836,1162932,1163630,1164419,1164438,1164469,1164480,1164567,1165234,1165247-1165248,1165253,1165273,1165282,1165309,1165331,1165338,1165347,1165360-1165361,1165367-1165368,1165602,1165608,1165677,1165693,1165721,1165723,1165728,1165730,1165738,1165746,1165765,1165777,1165918,1165921,1166077,1166150-1166151,1166290,1166366,1166620,1166686,1166693,1166752,1166757,1167368,1167394,1169447,1170647,1171692,1172233-1172234,1172236,1172269,1172278,1172282,1172556,1172610,1172664,1172689,1172711,1173020-1173021,1173082,1173088,1173090,1173096
,1173241,1173256,1173288,1173333,1173342,1173461,1173614,1173630,1173659,1173722,1174061,1174239,1174322,1174325,1174329-1174330,1174337-1174339,1174343,1174353,1174799,1174882,1174884,1174983,1175155,1175158,1175167,1175182,1175190,1175201,1175272,1175275,1175283,1175582,1175589-1175590,1175594,1175602,1175613,1175633,1175690,1175713,1175798,1175889,1175896,1175907,1176584,1176590,1176799,1177050,1177060,1177125,1177152,1177160,1177245,1177850,1177862,1177978,1178209,1178228,1178233,1178449,1178542,1178681,1178684,1178721,1179268,1179274,1180261,1180865,1180891,1180894,1180907,1181028,1181123,1181125,1181136,1181291,1181743,1182796,1183078,1183105,1183142,1183328,1183339-1183340,1183492-1183494,1183605,1184917,1184919,1185018,1185020,1185200,1185588,1185626,1185756,1185758,1186011,1186042-1186045,1186104,1186123,1186137,1186153,1186254,1186257,1186377-1186379,1186479-1186480,1186712,1186743,1186750,1186763,1186890-1186892,1186894,1186949,1187018,1187027-1187028,1187381,1187
755,1187775,1187827,1188301,1188303-1188305,1188399,1188822,1188930-1188931,1189116,1189129,1189183,1189240,1189256,1189386,1189413-1189414,1189477,1189685,1189805,1189857,1189864,1189882,1190034,1190185,1190279,1190339,1190371,1190388-1190389,1190474,1190481,1194915,1195222-1195223,1195531,1195899,1195905,1195943,1195949,1195953,1195955,1195965,1195968,1196175,1196212,1196223,1196304-1196305,1196735
Modified: tomcat/tc7.0.x/trunk/RUNNING.txt
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/RUNNING.txt?rev=1196746&r1=1196745&r2=1196746&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/RUNNING.txt (original)
+++ tomcat/tc7.0.x/trunk/RUNNING.txt Wed Nov 2 18:31:50 2011
@@ -37,61 +37,125 @@ Running With JRE 6.0 Or Later
(1.2) Install the JRE according to the instructions included with the
release.
-(1.3) Set an environment variable named JRE_HOME to the pathname of
- the directory into which you installed the JRE, e.g. c:\jre6.0
- or /usr/local/java/jre6.0.
-
-NOTE: You may also use the full JDK rather than just the JRE. In this
- case set your JAVA_HOME environment variable to the pathname of
- the directory into which you installed the JDK, e.g. c:\jdk6.0
- or /usr/local/java/jdk6.0.
+ You may also use the full JDK rather than just the JRE. In this
+ case set you have to configure your environment variables
+ differently - see below.
(2) Download and Install the Tomcat 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.
-
(2.1) Download a binary distribution of Tomcat from:
- http://tomcat.apache.org
+ http://tomcat.apache.org/
(2.2) Unpack the binary distribution into a convenient location so that the
distribution resides in its own directory (conventionally named
- "apache-tomcat-[version]"). 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.
+ "apache-tomcat-[version]").
+
+ For the purposes of the remainder of this document, the name
+ "CATALINA_HOME" is used to refer to the full pathname of the release
+ directory.
+
+NOTE: As an alternative to downloading a binary distribution, you can
+create your own from the Tomcat source code, as described in
+"BUILDING.txt". You can either
+
+ a) Do the full "release" build and find the created distributive in the
+ "output/release" directory and then proceed with unpacking as above, or
+
+ b) Do a simple build and use the "output/build" directory as
+ "CATALINA_HOME". Be warned that there are some differences between
+ contents of "output/build" and the official "release" distributive.
+
+
+(3) Configure Environment Variables
+
+Tomcat itself is a Java application and does not use environment variables,
+but the startup scripts use them to prepare the command that starts Tomcat.
+The full list of supported environment variables is provided as a comment
+at the top of catalina.bat (Windows) and catalina.sh (Unix) files.
+
+(3.1) CATALINA_HOME and CATALINA_BASE
+
+The CATALINA_HOME and CATALINA_BASE environment variables are used to
+specify location of Tomcat itself and of its active configuration
+respectively.
+
+The CATALINA_HOME environment variable should be set as defined in (2.2)
+above. The startup scripts have some logic to set this variable
+automatically if it is absent (based on the location of the script in
+Unixes and on the current directory in Windows), but it might be not
+perfect.
+
+The CATALINA_BASE environment variable is optional and is further described
+in "Multiple Tomcat Instances" section below. If it is not set it defaults
+to be equal to CATALINA_HOME.
+(3.2) JRE_HOME and other variables
-(3) Start Up Tomcat
+The third and the last environment variable that is needed to start Tomcat
+specifies location of JRE or JDK that should be used to start Tomcat.
-(3.1) Tomcat can be started by executing the following commands:
+There are two different names of this variable, depending on whether JRE or
+JDK is used. Use the JRE_HOME variable to specify location of a JRE and
+JAVA_HOME variable to specify location of a JDK.
- $CATALINA_HOME\bin\startup.bat (Windows)
+All variables except CATALINA_HOME and CATALINA_BASE can be configured in a
+setenv.bat (Windows) or setenv.sh (Unix) file. The setenv file can be either
+in CATALINA_BASE/bin or in CATALINA_HOME/bin. If both are present, only the
+one in CATALINA_BASE is used.
+
+So, either set JRE_HOME variable by yourselves or create the file. For
+example,
+
+On Windows, %CATALINA_BASE%\bin\setenv.bat:
+
+ set "JRE_HOME=%ProgramFiles%\Java\jre6"
+ exit /b 0
+
+On Unix, $CATALINA_BASE/bin/setenv.sh:
+
+ JRE_HOME=/usr/java/latest
+
+
+(4) Start Up Tomcat
+
+(4.1) Tomcat can be started by executing one of the following commands:
+
+ %CATALINA_HOME%\bin\startup.bat (Windows)
$CATALINA_HOME/bin/startup.sh (Unix)
-(3.2) After startup, the default web applications included with Tomcat will be
+ or
+
+ %CATALINA_HOME%\bin\catalina.bat start (Windows)
+
+ $CATALINA_HOME/bin/catalina.sh start (Unix)
+
+(4.2) After startup, the default web applications included with Tomcat will be
available by visiting:
http://localhost:8080/
-(3.3) Further information about configuring and running Tomcat can be found in
+(4.3) Further information about configuring and running Tomcat can be found in
the documentation included here, as well as on the Tomcat web site:
- http://tomcat.apache.org
+ http://tomcat.apache.org/
-(4) Shut Down Tomcat
+(5) Shut Down Tomcat
-(4.1) Tomcat can be shut down by executing the following command:
+(5.1) Tomcat can be shut down by executing one of the following commands:
- $CATALINA_HOME\bin\shutdown (Windows)
+ %CATALINA_HOME%\bin\shutdown.bat (Windows)
$CATALINA_HOME/bin/shutdown.sh (Unix)
+ or
+
+ %CATALINA_HOME%\bin\catalina.bat stop (Windows)
+
+ $CATALINA_HOME/bin/catalina.sh stop (Unix)
==================================================
Advanced Configuration - Multiple Tomcat Instances
@@ -99,33 +163,89 @@ Advanced Configuration - Multiple Tomcat
In many circumstances, it is desirable to have a single copy of a Tomcat
binary distribution shared among multiple users on the same server. To make
-this possible, you can set the $CATALINA_BASE environment variable to the
+this possible, you can set the CATALINA_BASE environment variable to the
directory that contains the files for your 'personal' Tomcat instance.
-When you use $CATALINA_BASE, Tomcat will calculate all relative references for
-files in the following directories based on the value of $CATALINA_BASE instead
-of $CATALINA_HOME:
+When running with separate CATALINA_HOME and CATALINA_BASE, the files
+and directories are split as following:
+
+In CATALINA_BASE:
+
+ * bin - Only the following files:
+
+ * setenv.sh (*nix) or setenv.bat (Windows),
+ * tomcat-juli.jar
+
+ The setenv scripts were described above. The tomcat-juli library
+ is documented in the Logging chapter in the User Guide.
+
+ * conf - Server configuration files (including server.xml)
+
+ * lib - Libraries and classes
+
+ * logs - Log and output files
+
+ * webapps - Automatically loaded web applications
+
+ * work - Temporary working directories for web applications
+
+ * temp - Directory used by the JVM for temporary files (java.io.tmpdir)
+
+
+In CATALINA_HOME:
+
+ * bin - Startup and shutdown scripts
+
+ The following files will be used only if they are absent in
+ CATALINA_BASE/bin:
+
+ setenv.sh (*nix), setenv.bat (Windows), tomcat-juli.jar
+
+ * lib - Libraries and classes, as explained below
+
+ * endorsed - Libraries that override standard "Endorsed Standards"
+ libraries provided by JRE. See Classloading documentation
+ in the User Guide for details.
+
+ By default this "endorsed" directory is absent.
+
+In the default configuration the JAR libraries and classes both in
+CATALINA_BASE/lib and in CATALINA_HOME/lib will be added to the common
+classpath, but the ones in CATALINA_BASE will be added first and thus will
+be searched first.
+
+The idea is that you may leave the standard Tomcat libraries in
+CATALINA_HOME/lib and add other ones such as database drivers into
+CATALINA_BASE/lib.
+
+In general it is advised to never share libraries between web applications,
+but put them into WEB-INF/lib directories inside the applications. See
+Classloading documentation in the User Guide for details.
-* bin - Only setenv.sh (*nix), setenv.bat (windows) and tomcat-juli.jar
-* conf - Server configuration files (including server.xml)
+It might be useful to note that the values of CATALINA_HOME and
+CATALINA_BASE can be referenced in the XML configuration files processed
+by Tomcat as ${catalina.home} and ${catalina.base} respectively.
-* logs - Log and output files
+For example, the standard manager web application can be kept in
+CATALINA_HOME/webapps/manager and loaded into CATALINA_BASE by using
+the following trick:
-* webapps - Automatically loaded web applications
+ * Copy the CATALINA_HOME/webapps/manager/META-INF/context.xml
+ file as CATALINA_BASE/conf/Catalina/localhost/manager.xml
-* work - Temporary working directories for web applications
+ * Add docBase attribute as shown below.
-* temp - Directory used by the JVM for temporary files (java.io.tmpdir)
+The file will look like the following:
-Note that by default Tomcat will first try to load classes and JARs from
-$CATALINA_BASE/lib and then $CATALINA_HOME/lib. You can place instance specific
-JARs and classes (eg JDBC drivers) in $CATALINA_BASE/lib whilst keeping the
-standard Tomcat JARs in $CATALINA_HOME/lib.
+ <?xml version="1.0" encoding="UTF-8"?>
+ <Context docBase="${catalina.home}/webapps/manager"
+ antiResourceLocking="false" privileged="true" >
+ </Context>
-If you do not set $CATALINA_BASE, $CATALINA_BASE will default to the same value
-as $CATALINA_HOME, which means that the same directory is used for all relative
-path resolutions.
+See Deployer chapter in User Guide and Context and Host chapters in the
+Configuration Reference for more information on contexts and web
+application deployment.
================
@@ -145,9 +265,9 @@ Tomcat install:
greater than 1024, as ports less than or equal to 1024 require superuser
access to bind under UNIX.
- 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/ in your browser.
+ 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/ in your browser.
(2) An "out of environment space" error when running the batch files in
Windows 95, 98, or ME operating systems.
@@ -164,5 +284,6 @@ Tomcat install:
browser knows that you shouldn't be going through the proxy to access the
"localhost".
- In Netscape, this is under Edit/Preferences -> Advanced/Proxies, and in
- Internet Explorer, Tools -> Internet Options -> Connections -> LAN Settings.
+ In Firefox, this is under Tools/Preferences -> Advanced/Network ->
+ Connection -> Settings..., and in Internet Explorer it is Tools ->
+ Internet Options -> Connections -> LAN Settings.
Modified: tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml?rev=1196746&r1=1196745&r2=1196746&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml Wed Nov 2 18:31:50 2011
@@ -304,6 +304,9 @@
Remove trailing whitespace from the default configuration files.
(kkolinko)
</update>
+ <update>
+ Improve <code>RUNNING.txt</code>. (kkolinko)
+ </update>
</changelog>
</subsection>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org