You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by hg...@apache.org on 2003/04/10 17:37:51 UTC

cvs commit: jakarta-tomcat-connectors/jk/xdocs/jk2 vhosthowto.xml virtualhosthowto.xml

hgomez      2003/04/10 08:37:51

  Modified:    jk/xdocs menu.jk2.idx
  Added:       jk/xdocs/jk2 vhosthowto.xml
  Removed:     jk/xdocs/jk2 virtualhosthowto.xml
  Log:
  Reduce name ;)
  
  Revision  Changes    Path
  1.7       +1 -1      jakarta-tomcat-connectors/jk/xdocs/menu.jk2.idx
  
  Index: menu.jk2.idx
  ===================================================================
  RCS file: /home/cvs/jakarta-tomcat-connectors/jk/xdocs/menu.jk2.idx,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- menu.jk2.idx	10 Apr 2003 15:32:45 -0000	1.6
  +++ menu.jk2.idx	10 Apr 2003 15:37:50 -0000	1.7
  @@ -17,5 +17,5 @@
   </section>
   <section name="Howto">
       <document href="jk2/confighowto.xml"/>
  -    <document href="jk2/virtualhosthowto.xml"/>
  +    <document href="jk2/vhosthowto.xml"/>
   </section>
  
  
  
  1.1                  jakarta-tomcat-connectors/jk/xdocs/jk2/vhosthowto.xml
  
  Index: vhosthowto.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  <properties>
  <title>Apache 2.0.43 - Tomcat 4.1.12 - jk2 - virtual host HOWTO</title>
  <author email="unicoletti at prometeo.it">Umberto Nicoletti</author>
  <date>Tue 22 Oct 2002 11:58:28 AM GMT-5</date>
  </properties>
  <section name="Scenario">
  <ul>
  <li>RedHat Linux 7.2</li>
  <li>Latest 1.4.x Sun JDK</li>
  <li>Tomcat 4.1.12 binary</li>
  <li>Apache 2.0.43 built from source</li>
  <li>jk2 connector binary from jakarta.apache.org</li>
  </ul>
  </section>
  
  <section name="Requirements">
  <p>
  Deploy three (in my case) web applications under three different virtual hosts,
  making the default vhost
  respond to any name and to the bare IP address.
  </p>
  </section>
  
  <section name="Installing JDK">
  	<p>Note: download the jdk, not just the jre!</p>
  <screen>
  <note>
  Uncompress the jdk somewhere in the filesystem.
  I chose /usr/local/:
  </note>
  <type>
  ll /usr/local/
  </type>
  <read>
  drwxr-xr-x    9 root     root         4096 Oct 18 16:37 j2sdk1.4.1_01
  </read>
  <read>
  lrwxrwxrwx    1 root     root           14 Oct 18 16:38 java -> j2sdk1.4.1_01/
  </read>
  </screen>
  <p>
  make a symlink named java to j2sdk1.4.1_01/ so that you can
  easily switch back and forth
  between different jvms. We will use the same trick for apache and tomcat afterwards.
  </p>
  <p>
  Now tell your bash shell where to find java binaries: create a file named java.sh in
  /etc/profile.d with the following content:
  </p>
  <screen>
  <type>
  cat /etc/profile.d/java.sh 
  </type>type>
  <read># set java environment</read>
  <read></read>
  <read>export JAVA_HOME=/usr/local/java</read>
  <read>export PATH=$PATH:$JAVA_HOME/bin</read>
  <read></read>
  <read>export CLASSPATH=$JAVA_HOME/lib</read>
  </screen>
  <p>
  do a chmod:
  </p>
  <screen>
  <note>
  Make java.sh readable and executable by anyone:
  </note>
  <type>
  #chmod 755 /etc/profile.d/java.sh
  </type>
  </screen>
  Now open a new shell and try this:
  <screen>
  <type>
  which java
  </type>
  <read>
  /usr/local/java/bin/java
  </read>
  </screen>
  <p>
  You should get the answer given above. If not chek your environment and make
  sure that java.sh is executed
  when opening a new shell.
  Try to run a java program or the following: java -version.
  </p>
  <p>
  If you don't like this way of installing java please ignore it.
  
  Make sure everything is ok and then jump to the next step.
  </p>
  </section>
  
  <section name="Installing Apache">
  <p>
  Download the latest release, uncompress it, cd into the newly created directory
  and run the following:
  </p>
  <screen>
  <type>
  ./configure -prefix=/usr/local/apache2.0.43 --sysconfdir=/etc/apache --localstatedir=/var --enable-so
  </type>
  </screen>
  <p>
  Of course you can customize the installation specifying other modules to enable
  or whatever you like.
  Just don't forget to ENABLE-SO, because that's what you need to load the
  apache-tomcat connector.
  </p>
  <p>
  Run make and make install. Create the log directories and others (you can skip
  this if you know how
  to configure where apache puts its log files -> edit httpd.conf):
  </p>
  <screen>
  <type>
  #mkdir /var/logs
  </type>
  <type>
  #mkdir /usr/local/apache2.0.43/conf
  </type>
  <type>
  #mkdir /usr/local/apache2.0.43/logs
  </type>
  </screen>
  <p>
  Create the symlink /usr/local/apache to /usr/local/apache2.0.43 and test your
  installation
  by executing:
  </p>
  <screen>
  <type>
  #/usr/local/apache/bin/apachectl start
  </type>
  </screen>
  <p>
  Open a browser and point it to the linux box: you should get a page telling you
  that the apache installation
  was successful.
  If that doesn't happen check the logs and troubleshoot: common errors in this configuration
  are that some directory holding log or configuration files is missing or maybe you have another web
  server listening on port 80.
  </p>
  </section>
  
  <section name="Installing Tomcat">
  <p>
  Uncompress the tomcat binaries in a directory of your choice. In this howto we
  will use /opt.
  Create a symlink named jakarta to the newly created directory so that you have
  something like the following:
  </p>
  <screen>
  <type>
  ll /opt/
  </type>
  <read>total 4</read>
  <read>lrwxrwxrwx    1 root     root           31 Oct 18 16:38 jakarta ->jakarta-tomcat-4.1.12-LE-jdk14/</read>
  <read>drwxr-xr-x   12 root     root         4096 Oct 18 18:10 jakarta-tomcat-4.1.12-LE-jdk14</read>
  <note>
  Start tomcat by running:
  </note>
  <type>
  /opt/jakarta/bin/startup.sh
  </type>
  </screen>
  <p>After a
  few seconds point your browser at the IP of
  the linux box on port 8080 and you should see the tomcat welcome page.
  If not check the catalina.out log file in /opt/jakarta/logs and fix all errors
  until Tomcat comes up.
  </p>
  </section>
  
  <section name="Configuring Tomcat to listen to Apache ajp13 requests">
  <p>
  Here is a sample server.xml file. Please note that the location of directories
  and log files is absolutely
  arbitrary and you have to edit it to make it suit your needs.
  <source>
  &lt;!-- Umberto Server Configuration File --&gt;
  
  &lt;Server port="8005" shutdown="SHUTDOWN" debug="0"&gt;
    &lt;!-- Define an Apache-Connector Service --&gt;
  
    &lt;Service name="Tomcat-Apache"&gt;
   
     &lt;!-- Define a Coyote/JK2 AJP 1.3 Connector on port 8009 --&gt;
      &lt;Connector className="org.apache.coyote.tomcat4.CoyoteConnector"
                 port="8009" minProcessors="5" maxProcessors="75"
                 enableLookups="true" redirectPort="8443"
                 acceptCount="10" debug="0" connectionTimeout="20000"
                 useURIValidationHack="false"
                 protocolHandlerClassName="org.apache.jk.server.JkCoyoteHandler"/&gt;
  
  	&lt;Engine name="Apache" defaultHost="www.home.net" debug="0"&gt;
  
        &lt;Logger className="org.apache.catalina.logger.FileLogger"
                prefix="apache_log." suffix=".txt"
                timestamp="true"/&gt;
  	  &lt;!-- Access log processes all requests for this virtual host. --&gt;
        &lt;Valve className="org.apache.catalina.valves.AccessLogValve"
                   directory="logs"  prefix="localhost_access_log." suffix=".txt"
                   pattern="common" resolveHosts="false"/&gt;
  
  	&lt;Host name="www.home.net" debug="0"
  appBase="/opt/jakarta-tomcat-4.1.12-LE-jdk14/webapps/struts-example" 
         unpackWARs="true" autoDeploy="true"&gt;
  		&lt;Alias&gt;localhost&lt;/Alias&gt;
  		&lt;Alias&gt;www&lt;/Alias&gt;
  		&lt;Alias&gt;10.0.0.10&lt;/Alias&gt;
  
  
  		&lt;Context path="" docBase="" debug="1"/&gt;
  
  		&lt;Valve className="org.apache.catalina.valves.AccessLogValve"
                   directory="logs"  prefix="home_access_log." suffix=".txt"
                   pattern="common" resolveHosts="false"/&gt;
  	&lt;/Host&gt;
  
  	&lt;Host name="www.customer1.it" debug="0"
  appBase="/opt/jakarta-tomcat-4.1.12-LE-jdk14/webapps/struts-blank" 
         unpackWARs="true" autoDeploy="true"&gt;
  
  		&lt;Context path="" docBase="" debug="1"/&gt;
  
  		&lt;Valve className="org.apache.catalina.valves.AccessLogValve"
                   directory="logs"  prefix="cust1_access_log." suffix=".txt"
                   pattern="common" resolveHosts="false"/&gt;
  	&lt;/Host&gt;
  
  	&lt;Host name="www.customer2.net" debug="0"
  appBase="/opt/jakarta-tomcat-4.1.12-LE-jdk14/webapps/root" 
         unpackWARs="true" autoDeploy="true"&gt;
  
  		&lt;Context path="" docBase="" debug="1"/&gt;
  
  		&lt;Valve className="org.apache.catalina.valves.AccessLogValve"
                   directory="logs"  prefix="cust2_log." suffix=".txt"
                   pattern="common" resolveHosts="false"/&gt;
  	&lt;/Host&gt;
  
      &lt;/Engine&gt;
  
    &lt;/Service&gt;
  
  &lt;/Server&gt;
  </source>
  
  This is a very minimalistic conf file, because we have taken away the HTTP1.1
  connector that allows us to talk directly to Tomcat.
  It might not be good for development, but it should be good for production.
  If you feel like you need also the Tomcat Standalone service then copy and paste
  it from your original server.xml file
  (you did back it up, didn't you?).
  <br/>
  Try to start tomcat again and check catalina.out to see if everything is up and
  running. If it complains about
  missing apr stuff try to edit /opt/jakarta/conf/jk2.properties and make it look so:
  
  <source>
  # list of needed handlers.
  handler.list=channelSocket,request
  # Override the default port for the channelSocket
  channelSocket.port=8009
  </source>
  
  If everything is ok move on to next section.
  </p>
  </section>
  
  <section name="Configuring Apache virtual hosting">
  <p>
  rtfm at <a
  href="http://httpd.apache.org/docs-2.0/vhosts/">http://httpd.apache.org/docs-2.0/vhosts/</a>
  In the appendix you can find the httpd.conf file I used to write and test this
  HOWTO.
  </p>
  </section>
  
  <section name="Configuring Apache to talk to Tomcat">
  <p>
  Download the jk2 shared library for you version of apache and copy it in
  /usr/local/apache/modules
  (create the  directory if necessary). If you can't find a suitable version of
  jk2 ask it to the tomcat-user mailing list
  or download the source and build it yourself (this is another HOWTO).
  </p>
  <p>
  Create, if you haven't already, the /usr/local/apache/conf directory and create
  a file named
  workers2.properties with this content in it:
  
  <source>
  # only at beginnin. In production uncomment it out
  [logger.apache2]
  level=DEBUG
  
  [shm]
  file=/usr/local/apache/logs/shm.file
  size=1048576
  
  # Example socket channel, override port and host.
  [channel.socket:localhost:8009]
  port=8009
  host=127.0.0.1
  
  # define the worker
  [ajp13:localhost:8009]
  channel=channel.socket:localhost:8009
  
  # Uri mapping
  [uri:10.0.0.10/*.jsp]
  worker=ajp13:localhost:8009
  
  [uri:www.home.net/*.jsp]
  worker=ajp13:localhost:8009
  
  [uri:www.customer1.it/*.jsp]
  worker=ajp13:localhost:8009
  
  [uri:www.customer2.net/*.jsp]
  worker=ajp13:localhost:8009
  </source>
  
  Edit the file, change ip addresses and names to suit your needs and save it.
  </p>
  <p>
  Edit http.conf and add the following line in the Modules section:
  
  <source>
  LoadModule jk2_module modules/mod_jk2.so
  </source>
  
  Save http.conf and try to start apache. It should now load the jk2 connector and
  the configuration
  from workers2.properties.
  Check the error log to make sure everything is ok.
  </p>
  <p>
  Start tomcat and try to load a HTML page in your browser: apache should return
  the page
  without problems.
  Now try with a jsp page: it should display after a little.
  <br/>
  If you get errors check that the path and host names (double check also the
  configuration of DNS
  with your network administrator) are ok, the directories are readable by both
  Tomcat and Apache.
  Again look into the log files.
  </p>
  <p>
  If everything works go to next section.
  </p>
  </section>
  
  <section name="The last trick">
  <p>
  Now ask your network administrator to set up an alias for your brand new server
  (use jspsrc if
  you like to stick to this howto).
  If you don't have easy access to dns try to edit your hosts file (on the client
  where you open the browser)
  and add a line as follows:
  
  <source>
  10.0.0.10		jspsrc
  </source>
  
  where 10.0.0.10 is the ip of your server. Open your browser and type this in
  your location bar:
  
  <source>
  http://jspsrc
  </source>
  
  and navigate to a jsp page. You should get the source of the jsp page into your
  browser!
  </p>
  <p>
  This is clearly a security problem, if not a major annoyance.
  </p>
  <p>
  What's wrong with the setup we came up so far? The problem is (or should be)
  that the ajp13
  connector can't find a virtual host that matches the jspsrc uri.
  What we need to do is set up the default virtual host so that ALL *.jsp requests
  get handled by tomcat.
  </p>
  <p>
  How do we do it?
  </p>
  <p>
  Read on if you want to know how.
  </p>
  </section>
  
  <section name="JK directives in httpd.conf">
  <p>
  In addition to the workers2.properties you can put Jk diretives directly into
  the httpd.conf file (just as you did
  with jk and webapp).
  Edit the default virtual host section in httpd.conf and add the following lines
  in the end, before
  <code>&lt;/VirtualHost&gt;</code>:
  
  <source>
      &lt;Location "/*.jsp"&gt;
          JkUriSet worker ajp13:localhost:8009 
      &lt;/Location&gt;
  </source>
  
  Restart Apache and test the jspsrc url again.
  </p>
  <p>
  The jsp source should not be displayed anymore.
  </p>
  </section>
  
  <section name="Notes">
  <p>
  I think a better approach would be to remove all uri directives from
  workers2.properties
  and to put them in http.conf as we did in the previous section for the defualt
  virtual host.
  Experiment and let me know.
  </p>
  </section>
  
  <section name="APPENDIX A: httpd.conf">
  <p>
  <source>
  #
  # Umberto Nicoletti, 18/10/2002
  #
  
  ### Section 1: Global Environment
  
  ServerRoot "/usr/local/apache"
  ErrorLog logs/error_log
  
  &lt;IfModule !mpm_winnt.c&gt;
  &lt;IfModule !mpm_netware.c&gt;
  #LockFile logs/accept.lock
  &lt;/IfModule&gt;
  &lt;/IfModule&gt;
  
  # ScoreBoardFile: File used to store internal server process information.
  &lt;IfModule !mpm_netware.c&gt;
  &lt;IfModule !perchild.c&gt;
  #ScoreBoardFile logs/apache_runtime_status
  &lt;/IfModule&gt;
  &lt;/IfModule&gt;
  
  &lt;IfModule !mpm_netware.c&gt;
  PidFile logs/httpd.pid
  &lt;/IfModule&gt;
  
  Timeout 300
  
  KeepAlive On
  MaxKeepAliveRequests 100
  KeepAliveTimeout 15
  
  &lt;IfModule prefork.c&gt;
  StartServers         5
  MinSpareServers      5
  MaxSpareServers     10
  MaxClients         150
  MaxRequestsPerChild  0
  &lt;/IfModule&gt;
  
  &lt;IfModule worker.c&gt;
  StartServers         2
  MaxClients         150
  MinSpareThreads     25
  MaxSpareThreads     75 
  ThreadsPerChild     25
  MaxRequestsPerChild  0
  &lt;/IfModule&gt;
  
  &lt;IfModule perchild.c&gt;
  NumServers           5
  StartThreads         5
  MinSpareThreads      5
  MaxSpareThreads     10
  MaxThreadsPerChild  20
  MaxRequestsPerChild  0
  &lt;/IfModule&gt;
  
  # listen on all ports
  Listen 80
  
  #
  # Dynamic Shared Object (DSO) Support
  #
  LoadModule jk2_module modules/mod_jk2.so
  
  ### Section 2: 'Main' server configuration
  
  &lt;IfModule !mpm_winnt.c&gt;
  &lt;IfModule !mpm_netware.c&gt;
  #
  # If you wish httpd to run as a different user or group, you must run
  # httpd as root initially and it will switch.  
  #
  # User/Group: The name (or #number) of the user/group to run httpd as.
  #  . On SCO (ODT 3) use "User nouser" and "Group nogroup".
  #  . On HPUX you may not be able to use shared memory as nobody, and the
  #    suggested workaround is to create a user www and use that user.
  #  NOTE that some kernels refuse to setgid(Group) or semctl(IPC_SET)
  #  when the value of (unsigned)Group is above 60000; 
  #  don't use Group #-1 on these systems!
  #
  User nobody
  Group #-1
  &lt;/IfModule&gt;
  &lt;/IfModule&gt;
  
  ServerAdmin whatever@you.want
  ServerName www.home.net
  UseCanonicalName Off
  
  #
  # The following directives define some format nicknames for use with
  # a CustomLog directive (see below).
  #
  LogFormat "%h %l %u %t \"%r\" %&gt;s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
  LogFormat "%h %l %u %t \"%r\" %&gt;s %b" common
  LogFormat "%{Referer}i -&gt; %U" referer
  LogFormat "%{User-agent}i" agent
  
  LogLevel debug
  CustomLog logs/access.log common
  
  DocumentRoot "/opt/jakarta-tomcat-4.1.12-LE-jdk14/webapps/struts-example"
  
  &lt;Directory /opt/jakarta-tomcat-4.1.12-LE-jdk14/webapps/struts-example&gt;
      Options None
      AllowOverride None
  &lt;/Directory&gt;
  
  DirectoryIndex index.html index.jsp
  
  &lt;Directory /&gt;
      Options None
      AllowOverride None
  &lt;/Directory&gt;
  
  &lt;Files ~ "^\.ht"&gt;
      Order allow,deny
      Deny from all
  &lt;/Files&gt;
  
  &lt;Location /WEB-INF/&gt;
      Order Allow,Deny
  &lt;/Location&gt;
  
  NameVirtualHost *
  
  &lt;VirtualHost *&gt;
      ServerName www.home.net
  	ServerAlias www
  	ServerAlias localhost
      ServerAdmin sysmaster@arpa.veneto.it
      DocumentRoot /opt/jakarta-tomcat-4.1.12-LE-jdk14/webapps/struts-example
  
      ErrorLog logs/home.net-errorlog
  	CustomLog logs/home.net-access.log common
  
      &lt;Location "/*.jsp"&gt;
          JkUriSet worker ajp13:localhost:8009 
      &lt;/Location&gt;
  &lt;/VirtualHost&gt;
  
  &lt;VirtualHost *&gt;
      ServerName www.customer1.it
      ServerAdmin sysmaster@arpa.veneto.it
      DocumentRoot /opt/jakarta-tomcat-4.1.12-LE-jdk14/webapps/struts-blank
      ErrorLog logs/cust1-errorlog
  &lt;/VirtualHost&gt;
  
  &lt;VirtualHost *&gt;
      ServerName www.customer2.net
      ServerAdmin sysmaster@arpa.veneto.it
      DocumentRoot /opt/jakarta-tomcat-4.1.12-LE-jdk14/webapps/root
      ErrorLog logs/cust2-errorlog
  &lt;/VirtualHost&gt;
  </source>
  </p>
  
  </section>
  </document>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org