alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Tomcat example source code file (virtual-hosting-howto.xml)

This example Tomcat source code file (virtual-hosting-howto.xml) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Tomcat tags/keywords

apache, catalina_home/conf/catalina, context, context, create, engine, engine, license, license, note, see, tomcat, tomcat, you

The Tomcat virtual-hosting-howto.xml source code

<?xml version="1.0"?>
<!--
  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->
<!DOCTYPE document [
  <!ENTITY project SYSTEM "project.xml">
]>
<document url="virtual-hosting-howto.html">

    &project;

  <properties>
    <title>Virtual Hosting and Tomcat
  </properties>

<body>

  <section name="Assumptions">
    <p>
      For the sake of this how-to, assume you have a development host with two
      host names, <code>ren and stimpy. Let's also assume
      one instance of Tomcat running, so <code>$CATALINA_HOME refers to
      wherever it's installed, perhaps <code>/usr/local/tomcat.
    </p>
    <p>
      Also, this how-to uses Unix-style path separators and commands; if you're
      on Windows modify accordingly. 
    </p>
  </section>

  <section name="server.xml">
    <p>
      At the simplest, edit the <a href="config/engine.html">Engine portion
      of your <code>server.xml file to look like this:
    </p>
    <source>
<Engine name="Catalina" defaultHost="ren">
    <Host name="ren"    appBase="renapps"/>
    <Host name="stimpy" appBase="stimpyapps"/>
</Engine>
    </source>
    <p>
      Note that the directory structures under the appBase for each host should
      not overlap each other.
    </p>
    <p>
      Consult the configuration documentation for other attributes of the
      <a href="config/engine.html">Engine and 
      Host</a> elements.
    </p>
  </section>

  <section name="Webapps Directory">
    <p>
      Create directories for each of the virtual hosts:
    </p>
    <source>
mkdir $CATALINA_HOME/renapps
mkdir $CATALINA_HOME/stimpyapps
    </source>
  </section>

  <section name="Configuring Your Contexts">
    <subsection name="General">
      <p>Contexts are normally located underneath the appBase directory. For
       example, to deploy the <code>foobar context as a war file in
       the <code>ren host, use
       <code>$CATALINA_HOME/renapps/foobar.war. Note that the
       default or ROOT context for <code>ren would be deployed as
       <code>$CATALINA_HOME/renapps/ROOT.war (WAR) or
       <code>$CATALINA_HOME/renapps/ROOR (directory).
      </p>
      <p>NOTE: The docBase for a context should never be
        the same as the <code>appBase for a host.
      </p>
    </subsection>
    <subsection name="context.xml - approach #1">
      <p>
        Within your Context, create a <code>META-INF directory and then
        place your Context definition in it in a file named
        <code>context.xml. i.e.
        <code>$CATALINA_HOME/renapps/ROOT/META-INF/context.xml
        This makes deployment easier, particularly if you're distributing a WAR
        file.
      </p>
    </subsection>
    <subsection name="context.xml - approach #2">
      <p>
        Create a structure under <code>$CATALINA_HOME/conf/Catalina
        corresponding to your virtual hosts, e.g.:
      </p>
      <source>
mkdir $CATALINA_HOME/conf/Catalina/ren
mkdir $CATALINA_HOME/conf/Catalina/stimpy
      </source>
      <p>
        Note that the ending directory name "Catalina" represents the
        <code>name attribute of the
        <a href="config/engine.html">Engine element as shown above.
      </p>
      <p>
        Now, for your default webapps, add:
      </p>
      <source>
$CATALINA_HOME/conf/Catalina/ren/ROOT.xml
$CATALINA_HOME/conf/Catalina/stimpy/ROOT.xml
      </source>
      <p>
        If you want to use the Tomcat manager webapp for each host, you'll also
        need to add it here:
      </p>
      <source>
cd $CATALINA_HOME/conf/Catalina
cp localhost/manager.xml ren/
cp localhost/manager.xml stimpy/
      </source>
    </subsection>
    <subsection name="Further Information">
      <p>
        Consult the configuration documentation for other attributes of the
        <a href="config/context.html">Context element.
      </p>
    </subsection>
  </section>
</body>
</document>

Other Tomcat examples (source code examples)

Here is a short list of links related to this Tomcat virtual-hosting-howto.xml source code file:
... this post is sponsored by my books ...

#1 New Release!
FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.