Author: rjung
Date: Sun Mar 18 15:49:24 2012
New Revision: 1302145
URL: http://svn.apache.org/viewvc?rev=1302145&view=rev
Log:
Reformulate introductory docs files.
Modified:
tomcat/jk/trunk/native/BUILDING.txt
tomcat/jk/trunk/native/README.txt
Modified: tomcat/jk/trunk/native/BUILDING.txt
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/native/BUILDING.txt?rev=1302145&r1=1302144&r2=1302145&view=diff
==============================================================================
--- tomcat/jk/trunk/native/BUILDING.txt (original)
+++ tomcat/jk/trunk/native/BUILDING.txt Sun Mar 18 15:49:24 2012
@@ -13,150 +13,113 @@
See the License for the specific language governing permissions and
limitations under the License.
-
- Building from the subversion tree: (for developers only).
- -----------------------------------
- When using a subversion tree buildconf.sh must be run before configure.
- The today version of buildconf.sh build the following files:
- libtool files in scripts/build/unix (should copy them?).
- Makefile.in from Makefile.am
- aclocal.m4 from different m4 files located in the local machine.
- configure from configure.in and aclocal.m4.
- If you see error message from automake, don't care about them.
+ General Build Instructions
+ ==========================
- Building using configure
- ------------------------
-
- It is possible to use autoconf for configuration and installation.
- To create tomcat-connectors's autoconf script, you will need libtool
- 1.5.2, automake 1.10 and autoconf 2.59 or newer. The use of more recent
- versions is strongly encouraged, e.g. for reliable detection of the
- features of recent version of operating systems (e.g. AIX 6.1).
+ To build tomcat-connectors you need to run "configure" and "make":
- Those tools will not be required if you are just
- using a package downloaded from apache.org, they are only required for
- developers.
-
- To configure tomcat-connectors run the following commands.
-
- ./buildconf.sh (not required unless you are a developer)
./configure [autoconf arguments] [tomcat-connectors arguments]
make
It is possible to set CFLAGS and LDFLAGS to add some platform specifics:
+
LDFLAGS=-lc \
./configure -with-apxs=/home2/local/apache/bin/apxs
-
- Build for both Apache HTTP Server 1.3 and 2.x
- ---------------------------------------------
-
- If you want to build mod_jk for Apache HTTP Server
- 1.3 and 2.x, you should :
-
- use configure and indicate Apache HTTP Server 1.3
- apxs location (--with-apxs)
- use make
- copy the mod_jk binary to the apache modules location
-
- make clean (to remove all previously compiled modules)
- use configure and indicate Apache HTTP Server 2.x
- apxs location,
- then make.
+ To find out about all available configure flags use
+
+ ./configure --help
+
+
+ Build for the Apache HTTP Server
+ ================================
+
+ If you want to build mod_jk for the Apache HTTP Server
+ you need to locate the apxs tool coming with the Apache
+ HTTP server. If apxs is located in /usr/sbin/apxs, run:
./configure --with-apxs=/usr/sbin/apxs
make
- cp ./apache-1.3/mod_jk.so /usr/lib/apache
- make clean
- ./configure --with-apxs=/usr/sbin/apxs2
- make
- cp ./apache-2.0/mod_jk.so /usr/lib/apache2
-
- Examples
- --------
+ The resulting module file mod_jk.so of mod_jk will be
+ located in the directory apache-2.0 (for any version
+ of Apache 2.x) respectively apache-1.3 (for Apache 1.3).
- Apache HTTP Server 2.x:
+ Simply copy the file to your web server modules or libexec
+ directory.
- ./configure --with-apxs=/opt/apache2/bin/apxs
- Apache HTTP Server 1.3:
+ Apache related configure arguments for tomcat-connectors
+ --------------------------------------------------------
- ./configure --with-apxs=/usr/sbin/apxs
-
- tomcat-connectors arguments
- -----------------------------------
- Apache related parameters:
--with-apxs[=FILE]
+
FILE is the location of the apxs tool. Default is finding apxs in PATH.
- It builds a shared Apache module. It detects automaticly the Apache version.
- (2.x and 1.3)
-* --with-apache=DIR
+ It builds a shared Apache module. It detects automatically the Apache
+ version. (2.x and 1.3)
+
+ --with-apache=DIR
+
DIR is the path where apache sources are located.
The apache sources should have been configured before configuring mod_jk.
DIR is something like: /home/apache/apache_1.3.19
It builds a static Apache module.
+
--enable-EAPI
- This parameter is needed when using Apache-1.3 and mod_ssl, otherwise you
+ This parameter is needed when using Apache 1.3 and mod_ssl, otherwise you
will get the error message: "this module might crash under EAPI!" when
loading libjk.so in httpd.
-* Static build need more tests, and we strongly recommand dynamic build
+ Static build need more tests, and we strongly recommend dynamic build
using DSO/APXS.
- Installation
- ------------
-
- The mod_jk binary will be in :
-
- ./apache-1.3/mod_jk.so if you select to build mod_jk for apache 1.3
-
- ./apache-2.0/mod_jk.so if you select to build mod_jk for apache 2.x
-
-
-
Building for Netscape/iPlanet/SunONE WebServer
- ----------------------------------------------
- make clean (to remove all previously compiled modules)
- use configure and indicate that you will be building the
- netscape nsapi redirector, then make the redirector plugin:
+ ==============================================
+
+ Building uses the following command sequence:
./configure --enable-netscape
cd netscape
make -f Makefile.solaris
This assumes that IPLANET_HOME is defined and points to
- your iPlanet install path (eg: /opt/SUNWwbsvr)
- and that JAVA_HOME is defined (eg: /opt/SUNWwbsvr/bin/https/jdk).
+ your iPlanet install path (eg: /opt/SUNWwbsvr).
- By default GCC will be used. You can use SunCC by providing
+ By default GCC will be used. You can use Sun CC by providing
CC=cc on the make command line:
make -f Makefile.solaris CC=cc IPLANET_HOME=/opt/SUNWwbsrv70
EXTRA_CFLAGS=-m64
- Misc notes
- ----------
+ Misc Notes
+ ==========
+
+ Build for Multiple Web Servers
+ ------------------------------
+
+ If you want to build for multiple web servers, you need
+ to call "make clean" between the individual builds.
- HP-UX build notes :
+ HP-UX build notes
+ -----------------
- If you plan to use GCC on HP-UX to build mod_jk, be sure to
+ If you plan to use GCC on HP-UX to build mod_jk, be sure to
have -DHPUX11GCC defined (usually by setting CLAGS before configure)
Reports are that the stripped down cc version that ships with
- HP-UX won't be able to works, you should habe the HP add-on ANSI C
+ HP-UX won't be able to works, you should habe the HP add-on ANSI C
Compiler package.
- A good repository for HP-UX gnu tools is :
+ A good repository for HP-UX gnu tools is:
http://gatekeep.cs.utah.edu/
+ Solaris build notes
+ -------------------
- Solaris build notes :
-
- the build should works with the GNU gcc compiler, on both
+ The build should work with the GNU gcc compiler, on both
SPARC and x86 architecture systems.
A good repository for Solaris gnu tools is :
@@ -167,3 +130,28 @@
ensure that apache and mod_jk will be compiled and linked with
the same tools (ie full Solaris or full GNU)
+
+ Building from the subversion tree
+ =================================
+
+ This is only necessary if you want to build a not yet
+ released versions. When using a subversion tree,
+ "buildconf.sh" must be run before configure. This script uses
+ the auto tools to provide the following files:
+
+ - libtool files in scripts/build/unix (should copy them?)
+ - Makefile.in from Makefile.am
+ - aclocal.m4 from different m4 files located on the local machine
+ - configure from configure.in and aclocal.m4
+
+ buildconf.sh is known to work with libtool 1.5.2, automake 1.10
+ and autoconf 2.59 or newer. The use of more recent versions is
+ strongly encouraged, e.g. for reliable detection of the
+ features of recent version of operating systems (e.g. AIX 6.1).
+ The script is run without arguments:
+
+ ./buildconf.sh
+
+ If you see error message from automake, don't care about them.
+ After running buildconf you can build as usual using configure
+ and make.
Modified: tomcat/jk/trunk/native/README.txt
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/native/README.txt?rev=1302145&r1=1302144&r2=1302145&view=diff
==============================================================================
--- tomcat/jk/trunk/native/README.txt (original)
+++ tomcat/jk/trunk/native/README.txt Sun Mar 18 15:49:24 2012
@@ -13,31 +13,35 @@
See the License for the specific language governing permissions and
limitations under the License.
-README for tomcat-connector
-
$Id$
-Please see doc/mod_jk-howto.html for more verbose instructions
+README for tomcat-connectors
+============================
+
+What is tomcat-connector?
+-------------------------
-* What is tomcat-connector ?
+tomcat-connectors is a project that provides web server connectors
+for the Tomcat servlet engine. The supported web servers are the
+Apache HTTP Server 1.3 and 2.x, Microsoft IIS and the Netscape/IPlanet
+web server. The AJP protocol used by the connector is supported in
+all Tomcat versions starting with Tomcat 3.2. Some other back end servers
+also support the AJP protocol.
-tomcat-connector is a new project to release web-servers connector
-for the Tomcat servlet engine.
+Main features of the tomcat-connectors are fault tolerance, load balancing,
+dynamic configuration, flexibility and robustness.
-This project didn't start from null since it reuse the latest code from
-mod_jk for the native parts and tomcat 3.3 for the java side of the
-force.
+The project was based on the original mod_jk code and keeps maintaining it.
+Originally the project also provided the Java parts of the connectors
+used inside Tomcat. These parts have since then been moved directly
+into the Tomcat source.
-From mod_jk we gain :
+How do i build it?
+------------------
-* A connector (plugin) for many Web Server, including
- Apache HTTP Server, Netscape/IPLanet NES and Microsoft IIS.
-
-* Fault-tolerance and load-balancing. mod_jk use the concept of
- workers which handle a particular request, and a special worker
- , the lb worker, is a group (cluster ?) of physical workers.
+Just take a look at BUILDING.txt
-* Direct access to Tomcat 3.2/3.3/4.0/4.1 servlet engine via ajp13
- protocol.
+Where are the docs?
+-------------------
-* OK, then how do I build web-connector ? Just take a look at BUILDING.txt
+In the docs directory.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
