Simple Apache 2 Tomcat 5 mod_jk integration
Simple Apache 2 Tomcat 5 mod_jk Integration
The whole tutorial is based on many tutorials, but I made a very simple one, with no virtual hosts. THIS HAS ONLY BEEN TESTED ON DEBIAN 3.1!!!! It might not work on other distros ...
The main source of info can be found here:
I followed this link: http://www.howtoforge.com/perfect_setup_debian_sarge_p5
apt-get install apache2 apache2-doc
Edit /etc/apache2/apache2.conf. Change
Edit /etc/mime.types and comment out the following lines:
Edit /etc/apache2/mods-enabled/php4.conf and comment out the following lines:
Edit /etc/apache2/ports.conf and add Listen 443:
Now we have to enable some Apache modules (SSL, rewrite and suexec):
A new user www-data will be automatically created in the system.
Installing JDK (Java Development Kit)
In order to run Tomcat, you will need to install JDK and set the JAVA_HOME environment variable to identify the location of the JDK environment on your system. I have chosen to use JDK 5.0.
1. You can download JDK 5.0 at http://java.sun.com/j2se/1.5.0/download.jsp.
chmod +x jdk-1_5_0_06-linux-i586.bin
Now execute the file:
You should now have a new directory called jdk1.5.0_06. Now move this directory to the location where it should be run. I chose /usr/lib/.
mv jdk1.5.0_06 /usr/lib
Now create a symbolic link called jdk to JAVA_HOME by the following command. This allows you to easily switch back and forth between different jvms should you ever need to.
Now we need to set the JAVA_HOME environment variable. Add the following at the end of /etc/profile just after export PATH.
/etc/profile is executed at startup and when a user logs into the system. In order to update the environment you will need to log out and log back in to the system.
Check to make sure JAVA_HOME is defined correctly by executing the command below. This should report the location of the Java SDK which should be /usr/lib/jdk.
In this section you will download and install Apache Tomcat 5.5.16. For this particular setup, there is no need to build the package from source, we will download the binary version.
1. Download the binary version to your preferred download directory from here: http://tomcat.apache.org/download-55.cgi. Choose the tar.gz from the core section for 5.5.16.
cd /mydownloads #(be sure to change to your download directory)
You should now have a new directory called apache-tomcat-5.5.16. Now move this directory to the location where it should be installed. Again, I chose /usr/lib/. Note that this location will be referred to as CATALINA_HOME in the Tomcat documentation.
mv apache-tomcat-5.5.16 /usr/lib
4. Next change to the /usr/lib/ directory.
5. Now create a symbolic link called apache-tomcat to the CATALINA_HOME by the following command.
ln -s apache-tomcat-5.5.16 apache-tomcat
This will save you from having to make changes to startup and shutdown scripts each time you upgrade Tomcat and if you so desire, it also allows you to keep several versions of Tomcat on your system and easily switch amongst them.
You should now be able to start and stop Tomcat from the CATALINA_HOME/bin directory. If you are using another shell other than the bash shell you will nee to add sh to the beginning of the command. You should now be able to test that Tomcat is installed by starting it and opening your browser and entering http://localhost:8080 into your browser. Port 8080 is the default port for Tomcat and can be easily changed in the /usr/lib/apache-tomcat/conf/server.xml file. (We will work with this file later on.) If you plan to access this page remotely, be sure to forward the respective port to your server's IP address within your router. You should now see the Tomcat welcome page that contains links to Tomcat documentation as well as sample JSP/Servlet scripts. Verify that Tomcat is running by executing some of the examples found on the welcome page.
To shutdown the server, you will need to execute the following command. Feel free to try it, but for now we will leave Tomcat running.
Installing and configuring mod_jk
In order to make the connection between Tomcat and Apache, we will need to download and install mod_jk connector. You will find that the Apache documentation recommends that you install the packaged version of mod_jk if it is available for your particular Linux distribution. Many outdated resources recommend installing the mod_jk2 connector, but I have found that it has been deprecated and although mod_jk was developed before mod_jk2, it is still fully supported and is very stable.
Mike Millson gave some good reasoning behind using mod_jk for connecting Tomcat to Apache for Red Hat here: Integrating Tomcat and Apache on Red Hat Linux.
1. I chose to download the current source from the Apache archives: http://archive.apache.org/dist/jakarta/tomcat-connectors/jk/source/jk-1.2.15/. Download the jakarta-tomcat-connectors-1.2.15-src.tar.gz file to your /usr/src/ directory.
2. Change to the /usr/src directory.
3. Next, extract the contents to create the /usr/src/jakarta-tomcat-connectors-1.2.15-src directory.
tar xvzf jakarta-tomcat-connectors-1.2.15-src.tar.gz
4. Change to the /usr/src/jakarta-tomcat-connectors-1.2.15-src/jk/native directory.
5. Now you are ready to create the custom configure file for your system. Execute the following:
This will create a configure file in the /usr/src/jakarta-tomcat-connectors-1.2.15-src/jk/native directory.
6. Execute the following command in order to configure mod_jk for your system.
7. Now build the mod_jk with the following:
8. Finally, if you were successful with the previous commands, copy the newly created mod_jk.so to your Apache2 modules directory. My modules were located at /usr/lib/apache2/modules.
You now are ready to move to the next stage which is to begin configuring Apache and Tomcat. You can find more information about the mod_jk connector at http://tomcat.apache.org/connectors-doc/howto/apache.html.
Configuring Tomcat and Apache
Create the workers.properties file.
1. First create the workers.properties file in your Apache2 root directory.
2. Next, open the workers.properties file and add the following. You can find many other examples of the workers.properties file on the internet, but this is the one that I created and it seems to work fine with the other portions that have already been configured in this tutorial.
3. Save and close the file.
4. Now we need to open the /etc/apache2/apache2.conf file and add the following lines at the bottom. (httpd.conf is just for backward compatibility):
Save and close the file.
Now a final security point.
We will create a group and user tomcat tomcat like that:
Then change the user and group of the Tomcat path:
chown -R tomcat:tomcat /usr/lib/apache-tomcat-5.5.16
To change the password of tomcat user, with root type:
and follow the instructions.
Then to start and stop the Tomcat server you should use the tomcat user.
su - tomcat
Now stop and start Tomcat:
And restart Apache:
You are done.
In this test, we are directing all URLs that begin with "/jsp-examples" to Tomcat.
Make sure no other server is running on the default Tomcat ports of 8005, 8009 and 8080.
Start Tomcat first: Always start Tomcat first and then start Apache.
Point your browser to http://localhost:8080 and verify that you get the default Tomcat page.
Point your browser to http://localhost/jsp-examples/ and verify that you get the index page for the Tomcat examples.
This will be served by Apache and will indicate that you have completed your integration of Apache and Tomcat successfully.
References and paths:
Tomcat stop and start:
For those who need help with this tutorial please post your questions in here:
Or even if you find any errors in the tutorial, please let me know about them in the forum.