Bug 58474 - Clarity in documentation for CATALINA_HOME and CATALINA_BASE
Clarity in documentation for CATALINA_HOME and CATALINA_BASE
Status: RESOLVED FIXED
Product: Tomcat 8
Classification: Unclassified
Component: Catalina
8.0.x-trunk
PC Linux
: P2 normal (vote)
: ----
Assigned To: Tomcat Developers Mailing List
:
Depends on:
Blocks:
  Show dependency tree
 
Reported: 2015-10-02 20:52 UTC by Dennis Sheil
Modified: 2015-10-05 20:27 UTC (History)
0 users



Attachments
More clarity in sample documentation (826 bytes, patch)
2015-10-02 20:52 UTC, Dennis Sheil
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Dennis Sheil 2015-10-02 20:52:42 UTC
Created attachment 33156 [details]
More clarity in sample documentation

If we look at this file -

http://svn.apache.org/repos/asf/tomcat/trunk/webapps/docs/appdev/sample/index.html

It says:

"The easiest way to run this application is simply to move the war file to your <b>CATALINA_HOME/webapps</b> directory."

However, when tomcat is running multiple instances, this directory is actually CATALINA_BASE/webapps .  On Debian recent stable jessie release, by default tomcat8's CATALINA_HOME has no webapps directory, whereas CATALINA_BASE does, and moving the sample war file to CATALINA_BASE will deploy it.

I have attached a patch where I change the documentation to read:

"The easiest way to run this application is simply to move the war file to your <b>CATALINA_HOME/webapps</b> directory (or if you are running multiple instances, move the war file to your <b>CATALINA_BASE/webapps</b> directory)."

One reason for extra explanation here is this is one of the first things someone new to Tomcat will see, and that note will probably save them from some confusion.
Comment 1 Mark Thomas 2015-10-05 20:27:50 UTC
Thanks for the report.

Fixed in trunk and 8.0.x for 8.0.28 onwards.

I used a slightly different form of words to provide a pointer to more information since I wanted to keep this page as simple as possible.