1 | ================================================================================ |
---|
2 | Licensed to the Apache Software Foundation (ASF) under one or more |
---|
3 | contributor license agreements. See the NOTICE file distributed with |
---|
4 | this work for additional information regarding copyright ownership. |
---|
5 | The ASF licenses this file to You under the Apache License, Version 2.0 |
---|
6 | (the "License"); you may not use this file except in compliance with |
---|
7 | the License. You may obtain a copy of the License at |
---|
8 | |
---|
9 | http://www.apache.org/licenses/LICENSE-2.0 |
---|
10 | |
---|
11 | Unless required by applicable law or agreed to in writing, software |
---|
12 | distributed under the License is distributed on an "AS IS" BASIS, |
---|
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
14 | See the License for the specific language governing permissions and |
---|
15 | limitations under the License. |
---|
16 | ================================================================================ |
---|
17 | |
---|
18 | $Id: RUNNING.txt 354430 2005-12-06 13:44:26Z yoavs $ |
---|
19 | |
---|
20 | =================================================== |
---|
21 | Running The Apache Tomcat 6.0 Servlet/JSP Container |
---|
22 | =================================================== |
---|
23 | |
---|
24 | Apache Tomcat 6.0 requires the Java 2 Standard Edition Runtime |
---|
25 | Environment (JRE) version 5.0 or later. |
---|
26 | |
---|
27 | ============================= |
---|
28 | Running With JRE 5.0 Or Later |
---|
29 | ============================= |
---|
30 | |
---|
31 | (1) Download and Install the J2SE Runtime Environment (JRE) |
---|
32 | |
---|
33 | (1.1) Download the Java 2 Standard Edition Runtime Environment (JRE), |
---|
34 | release version 5.0 or later, from http://java.sun.com/j2se. |
---|
35 | |
---|
36 | (1.2) Install the JRE according to the instructions included with the |
---|
37 | release. |
---|
38 | (1.3) Set an environment variable named JRE_HOME to the pathname of |
---|
39 | the directory into which you installed the JRE, e.g. c:\jre5.0 |
---|
40 | or /usr/local/java/jre5.0. |
---|
41 | |
---|
42 | NOTE: You may also use the full JDK rather than just the JRE. In this |
---|
43 | case set your JAVA_HOME environment variable to the pathname of |
---|
44 | the directory into which you installed the JDK, e.g. c:\j2sdk5.0 |
---|
45 | or /usr/local/java/j2sdk5.0. |
---|
46 | |
---|
47 | |
---|
48 | (2) Download and Install the Tomcat Binary Distribution |
---|
49 | |
---|
50 | NOTE: As an alternative to downloading a binary distribution, you can create |
---|
51 | your own from the Tomcat source repository, as described in "BUILDING.txt". |
---|
52 | If you do this, the value to use for "${catalina.home}" will be the "dist" |
---|
53 | subdirectory of your source distribution. |
---|
54 | |
---|
55 | (2.1) Download a binary distribution of Tomcat from: |
---|
56 | |
---|
57 | http://tomcat.apache.org |
---|
58 | |
---|
59 | (2.2) Unpack the binary distribution into a convenient location so that the |
---|
60 | distribution resides in its own directory (conventionally named |
---|
61 | "apache-tomcat-[version]"). For the purposes of the remainder of this document, |
---|
62 | the symbolic name "$CATALINA_HOME" is used to refer to the full |
---|
63 | pathname of the release directory. |
---|
64 | |
---|
65 | |
---|
66 | (3) Start Up Tomcat |
---|
67 | |
---|
68 | (3.1) Tomcat can be started by executing the following commands: |
---|
69 | |
---|
70 | $CATALINA_HOME\bin\startup.bat (Windows) |
---|
71 | |
---|
72 | $CATALINA_HOME/bin/startup.sh (Unix) |
---|
73 | |
---|
74 | (3.2) After startup, the default web applications included with Tomcat will be |
---|
75 | available by visiting: |
---|
76 | |
---|
77 | http://localhost:8080/ |
---|
78 | |
---|
79 | (3.3) Further information about configuring and running Tomcat can be found in |
---|
80 | the documentation included here, as well as on the Tomcat web site: |
---|
81 | |
---|
82 | http://tomcat.apache.org |
---|
83 | |
---|
84 | |
---|
85 | (4) Shut Down Tomcat |
---|
86 | |
---|
87 | (4.1) Tomcat can be shut down by executing the following command: |
---|
88 | |
---|
89 | $CATALINA_HOME\bin\shutdown (Windows) |
---|
90 | |
---|
91 | $CATALINA_HOME/bin/shutdown.sh (Unix) |
---|
92 | |
---|
93 | |
---|
94 | ================================================== |
---|
95 | Advanced Configuration - Multiple Tomcat Instances |
---|
96 | ================================================== |
---|
97 | |
---|
98 | In many circumstances, it is desirable to have a single copy of a Tomcat |
---|
99 | binary distribution shared among multiple users on the same server. To make |
---|
100 | this possible, you can pass a "-Dcatalina.base=$CATALINA_BASE" argument when |
---|
101 | executing the startup command (see (2)). In this |
---|
102 | "-Dcatalina.base=$CATALINA_BASE" argument, replace $CATALINA_BASE with the |
---|
103 | directory that contains the files for your 'personal' Tomcat instance. |
---|
104 | |
---|
105 | When you use this "-Dcatalina.base=$CATALINA_BASE" argument, Tomcat will |
---|
106 | calculate all relative references for files in the following directories based |
---|
107 | on the value of $CATALINA_BASE instead of $CATALINA_HOME: |
---|
108 | |
---|
109 | * bin - Only setenv.sh (*nix) and setenv.bat (windows) |
---|
110 | |
---|
111 | * conf - Server configuration files (including server.xml) |
---|
112 | |
---|
113 | * logs - Log and output files |
---|
114 | |
---|
115 | * webapps - Automatically loaded web applications |
---|
116 | |
---|
117 | * work - Temporary working directories for web applications |
---|
118 | |
---|
119 | * temp - Directory used by the JVM for temporary files (java.io.tmpdir) |
---|
120 | |
---|
121 | If you do not pass the "-Dcatalina.base=$CATALINA_BASE" argument to the |
---|
122 | startup command, $CATALINA_BASE will default to the same value as $CATALINA_HOME, |
---|
123 | which means that the same directory is used for all relative path resolutions. |
---|
124 | |
---|
125 | |
---|
126 | ================ |
---|
127 | Troubleshooting |
---|
128 | ================ |
---|
129 | |
---|
130 | There are only really 3 things likely to go wrong during the stand-alone |
---|
131 | Tomcat install: |
---|
132 | |
---|
133 | (1) The most common hiccup is when another web server (or any process for that |
---|
134 | matter) has laid claim to port 8080. This is the default HTTP port that |
---|
135 | Tomcat attempts to bind to at startup. To change this, open the file: |
---|
136 | |
---|
137 | $CATALINA_HOME/conf/server.xml |
---|
138 | |
---|
139 | and search for '8080'. Change it to a port that isn't in use, and is |
---|
140 | greater than 1024, as ports less than or equal to 1024 require superuser |
---|
141 | access to bind under UNIX. |
---|
142 | |
---|
143 | Restart Tomcat and you're in business. Be sure that you replace the "8080" |
---|
144 | in the URL you're using to access Tomcat. For example, if you change the |
---|
145 | port to 1977, you would request the URL http://localhost:1977/ in your browser. |
---|
146 | |
---|
147 | (2) An "out of environment space" error when running the batch files in |
---|
148 | Windows 95, 98, or ME operating systems. |
---|
149 | |
---|
150 | Right-click on the STARTUP.BAT and SHUTDOWN.BAT files. Click on |
---|
151 | "Properties", then on the "Memory" tab. For the "Initial environment" field, |
---|
152 | enter in something like 4096. |
---|
153 | |
---|
154 | After you click apply, Windows will create shortcuts which you can use |
---|
155 | to start and stop the container. |
---|
156 | |
---|
157 | (3) The 'localhost' machine isn't found. This could happen if you're behind a |
---|
158 | proxy. If that's the case, make sure the proxy configuration for your |
---|
159 | browser knows that you shouldn't be going through the proxy to access the |
---|
160 | "localhost". |
---|
161 | |
---|
162 | In Netscape, this is under Edit/Preferences -> Advanced/Proxies, and in |
---|
163 | Internet Explorer, Tools -> Internet Options -> Connections -> LAN Settings. |
---|