head	1.30;
access;
symbols
	JSERV_1_1_2:1.30
	JSERV_1_1_1:1.30
	JSERV_1_1_1b1:1.29
	JSERV_1_1:1.29
	V1_1b3:1.26
	V1_1b2:1.26
	V1_1b1:1.24
	CONFIG:1.18.0.2
	JSERV1_0:1.17
	JSERV1_0FC1:1.17
	JSERV1_0B5:1.16
	JSERV1_0B4:1.16
	JSERV1_0B3:1.15
	JSERV1_1DEV:1.15.0.2
	JSERV1_0B2:1.12
	JSERV1_0B1:1.12;
locks; strict;
comment	@# @;


1.30
date	2000.04.14.00.21.18;	author admin;	state Exp;
branches;
next	1.29;

1.29
date	99.12.10.23.26.01;	author admin;	state Exp;
branches;
next	1.28;

1.28
date	99.11.16.20.26.38;	author admin;	state Exp;
branches;
next	1.27;

1.27
date	99.11.08.22.46.49;	author admin;	state Exp;
branches;
next	1.26;

1.26
date	99.10.05.20.28.02;	author admin;	state Exp;
branches;
next	1.25;

1.25
date	99.10.04.17.07.45;	author admin;	state Exp;
branches;
next	1.24;

1.24
date	99.09.29.03.23.49;	author admin;	state Exp;
branches;
next	1.23;

1.23
date	99.09.27.23.13.30;	author admin;	state Exp;
branches;
next	1.22;

1.22
date	99.09.24.01.37.54;	author admin;	state Exp;
branches;
next	1.21;

1.21
date	99.09.22.02.34.03;	author admin;	state Exp;
branches;
next	1.20;

1.20
date	99.09.22.01.42.47;	author admin;	state Exp;
branches;
next	1.19;

1.19
date	99.09.19.20.58.51;	author jonbolt;	state Exp;
branches;
next	1.18;

1.18
date	99.06.18.20.23.45;	author admin;	state Exp;
branches;
next	1.17;

1.17
date	99.06.09.05.21.20;	author jonbolt;	state Exp;
branches;
next	1.16;

1.16
date	99.04.05.20.24.49;	author admin;	state Exp;
branches;
next	1.15;

1.15
date	99.01.15.04.02.20;	author jonbolt;	state Exp;
branches;
next	1.14;

1.14
date	99.01.14.00.16.45;	author jonbolt;	state Exp;
branches;
next	1.13;

1.13
date	99.01.13.23.00.22;	author jonbolt;	state Exp;
branches;
next	1.12;

1.12
date	98.12.27.22.18.52;	author ed;	state Exp;
branches;
next	1.11;

1.11
date	98.12.10.13.47.13;	author hzeller;	state Exp;
branches;
next	1.10;

1.10
date	98.12.09.04.41.10;	author jon;	state Exp;
branches;
next	1.9;

1.9
date	98.12.09.03.44.31;	author jon;	state Exp;
branches;
next	1.8;

1.8
date	98.12.09.03.40.36;	author jon;	state Exp;
branches;
next	1.7;

1.7
date	98.12.03.20.07.15;	author stefano;	state Exp;
branches;
next	1.6;

1.6
date	98.12.02.23.56.45;	author stefano;	state Exp;
branches;
next	1.5;

1.5
date	98.11.26.14.44.07;	author tommy;	state Exp;
branches;
next	1.4;

1.4
date	98.11.25.21.23.43;	author stefano;	state dead;
branches;
next	1.3;

1.3
date	98.11.12.00.16.28;	author stefano;	state Exp;
branches;
next	1.2;

1.2
date	98.10.13.06.23.39;	author vadim;	state Exp;
branches;
next	1.1;

1.1
date	98.09.16.04.42.23;	author ed;	state Exp;
branches;
next	;


desc
@@


1.30
log
@change the logic for building DSO's to copy what PHP does.

manoj things there might have been issues one some systems (AIX/HP) using
the methodology used before.

-jon
@
text
@
   +-------------------------------------------------------------------+
   | A P A C H E   J S E R V   I N S T A L L A T I O N   O N   U N I X |
   +-------------------------------------------------------------------+


  Introduction
  ============

  This file guides you through the installation process for UNIX systems.

  NOTE: Win32 users are highly recommended to use the self-installing 
  distribution (the "exe" distribution) or read the instructions 
  in the docs/install/ directory.


  Installing the Apache JServ servlet engine
  ==========================================

  1. Requirements
     ------------

     The following requirements exist for building Apache JServ:

     o  Disk Space: 
     
        The complete Apache JServ installation requires less than 2Mb of 
        hard disk space. The compiled, not-compressed jar archive is more or
        less 100Kb.

     o  Apache HTTP Server:
    
        We have removed all support for Apache 1.2.x. Apache 1.3.9 and 
        higher is the current supported version. Apache 1.3.9 has 
        been out for quite some time now and we feel that it is best that 
        you always upgrade to the latest version of Apache. We also had 
        several bugs as a result of bugs in Apache 1.2.x that have been 
        resolved in Apache 1.3.9.

     o  Java Runtime Environment:
  
        A fully compliant Java 1.1 Runtime Environment is required for Apache 
        JServ to execute. 
  
        The official list of compatible ports is found on the Sun Java 
        web site:

        <http://java.sun.com/cgi-bin/java-ports.cgi>
  
        The list of supported platforms and Java ports may be found in the 
        documentation (docs/support.html).
  
        NOTE: since Apache JServ uses _only_ standard Java APIs (java.*),       
        please, do not submit a bug report if your Java virtual machine fails 
        to execute Apache JServ because of broken compliance. Send the 
        bug report to your Java virtual machine implementors instead.
  
     o  Java Servlet Development Kit 2.0:
  
        The Sun Java JSDK 2.0 is required by Apache JServ for proper servlet 
        execution.  This package is freely available from the Sun Java web 
        site: 

        <http://java.sun.com/products/servlet/index.html>
        <http://java.sun.com/products/servlet/download.html>

        NOTE: this version of Apache JServ requires _EXACTLY_ the 2.0
        version of the JSDK in order to operate properly. Any other version
        (past, present or future and including the version that comes 
        with the Java Server Pages (JSP) jar file) is not supported.
        
     o  Java Compiler:
  
        Since most distributions include the precompiled Java binary archive,
        compilation of the Java source is optional.
        
        A list of supported Java compilers and virtual machines may be found 
        in the documentation (docs/support.html)
        
        NOTE: to build servlets, a Java compiler is needed. The Jikes compiler
        from IBM is a fast and easy to use replacement for Sun's slower javac 
        compiler. <http://www.alphaworks.ibm.com/tech/jikes>

     o  ANSI-C Compiler: 

        Make sure you have an ANSI-C compiler installed and relative Make 
        tools. The GNU C compiler (GCC version 2.7.2 is fine) or the EGCS C 
        compiler (the future of the GCC compiler) and GNU Make 
        (make preferably version 3.75) from the Free Software Foundation (FSF) 
        is recommended. If you don't have GCC then at least make sure your
        vendors compiler is ANSI compliant. You can find the homepage of GNU
        at <http://www.gnu.org/> and the GCC distribution under
        <http://www.gnu.org/order/ftp.html>. EGCS is available from 
        <http://egcs.cygnus.com/>.

     o  Dynamic Shared Object (DSO) support [OPTIONAL]:

        See your Apache documentation for more information on how to add
        DSO support and if your system is supported. You will need to make 
        sure that Perl 5.004 or later is installed in order to build DSO 
        modules because of the dependency on the Apache apxs module. 
        <http://www.perl.com/>


  2. Choose how to add the Apache JServ module to Apache
     ---------------------------------------------------

  There are two choices:
    
     o  Compile it in -  This requires that you have a source distribution 
        of the Apache server handy as it adds our source to that tree and 
        lets Apache build the Apache JServ module into itself statically.    
 
     o  DSO - This requires that you have an installation of Apache 1.3.9 
        or higher that was configured to have DSO support when it was 
        built.  If you are not sure whether your server has DSO support, 
        follow the instructions on configuring Apache JServ for DSO and the 
        configure script will tell you.


  3. Configure Apache First - IMPORTANT
     ----------------------------------

  If you are using a source distribution then you have to configure Apache
  first (some generated header files are needed for Apache JServ to pass its
  configure checks).  You do not need to worry about specifying the 
  Apache JServ module for this first run.

  Thus, a first time configure line to build a static version of Apache
  would look like this:

  ./configure \
       --prefix=/usr/local/apache
  make
  make install

  If you are using DSO then you can ignore this step.  If you have a source
  distribution and would like to build it with DSO support and install it
  for use by Apache JServ then use the following options when configuring
  Apache:

     --enable-shared=max
     
  Thus, a first time configure line to build a DSO version of Apache
  would look like this:

  ./configure \
       --prefix=/usr/local/apache \
       --enable-shared=max
  make
  make install


  4. Configure Apache JServ
     ----------------------

  Now you are ready to configure Apache JServ.  To do this you may (or may not)
  need to specify quite a few arguments to configure.  The options to 
  pass to Apache JServ's configure are described below with complete 
  examples at the very bottom of this section.

  o  Apache Directory

     For DSO use:

       --with-apxs=/path/to/apache/installation/bin/apxs

     NOTE: The configure script will check a the default installation
     directory, /usr/local/apache. If you have Apache already installed 
     in there, you may leave this argument out.

     For a static compile use:

       --with-apache-src=/path/to/apache/source

     This is the path to the top level Apache directory from the source  
     distribution. In other words, this should point to the directory 
     that *contains* the src directory.

     NOTE: Do not try to use both --with-apxs and --with-apache-src 
     options at the same time. Also, Apache JServ 1.0, used 
     --with-apache-install. This has been deprecated and you should now use 
     --with-apxs instead.

  o  Prefix Path

     'make install' will copy the documentation and Apache JServ .jar file 
     into the directory that you specify with this option:

       --prefix=/usr/local/jserv

     The default value for this option is /usr/local/jserv

  o  JDK programs (java, javac, javadoc and jar)

     By default configure will first look at the JDK_HOME and JAVA_HOME 
     environment variables, if they aren't set then configure will check 
     your PATH environment variable. The results from using the PATH can 
     be overriden by:

       --with-jdk-home=/path/to/jdk

     If they are not found, configure will tell you and default back to 
     whatever is in your PATH.

     It is also possible to specify the locations of the java binaries 
     and force Java 2 usage with the following options:

       --with-java-platform=1 or 2 (generally no need to specify this)
       --with-java=/path/to/binary/java
       --with-javac=/path/to/binary/javac
       --with-javadoc=/path/to/binary/javadoc
       --with-jar=/path/to/binary/jar

     NOTE: By default, debugging symbols are left out of the Apache JServ 
     classes, you can put them back in by using this option:

       --enable-debugging

     NOTE: By default the jar file is not compressed, this can be 
     changed like so:
 
       --enable-compressed-jar

  o  JSDK classes

     Apache JServ needs to know where your servlet classes are.
     You will need to specify them like so:

       --with-JSDK=/path/to/jsdk.jar
          or
       --with-JSDK=/path/to/unpacked/jsdk

  o  Support for EAPI (mod_ssl)

     If you are using mod_ssl, then you should enable EAPI support by 
     adding:

       --enable-EAPI


  An example configure line for STATIC compilation is:
  
        ./configure \
                --prefix=/usr/local/jserv \
                --with-apache-src=/usr/local/apache/source \
                --with-jdk-home=/path/to/jdk \
                --with-JSDK=/path/to/jsdk.jar \
                --disable-debugging

  An example configure line for DSO compilation is:
  
        ./configure \
                --prefix=/usr/local/jserv \
                --with-apxs=/usr/local/apache/bin/apxs \
                --with-jdk-home=/path/to/jdk \
                --with-JSDK=/path/to/jsdk.jar \
                --disable-debugging


  5. Build Apache and Apache JServ
     -----------------------------

  Once you have configured Apache JServ you can run make. 

  Run 'make install' to make a .jar file, and copy it and the docs into 
  the directory you specified as --prefix. If you are building the DSO 
  version, this will compile the shared object. If you are building the 
  static version, this will just build the Java classes.

  If you are using an Apache source distribution then you also have 
  to run 'make install' in the Apache source directory to build Apache 
  with Apache JServ support in it. To do this, you will need to add the 
  following line to the static configure line in section 3 above:

    --activate-module=src/modules/jserv/libjserv.a

  This is an example of building a default Apache installation with 
  Apache JServ support added:

    ./configure \
        --prefix=/usr/local/apache
        --activate-module=src/modules/jserv/libjserv.a
    make
    make install

  You can see if Apache has loaded the mod_jserv module by executing 
  '/path/to/apache/installation/bin/httpd -l'.
  

  6. Configuration Files
     -------------------

  At this point, you must configure the Apache JServ directives for Apache. 
  There are example configuration files in the conf and example directories 
  that come with the Apache JServ package that help with this process. The 
  files in the example directory will help you configure a default zone 
  named "example" so that your URL's will look like this:
  
  <http://www.yourserver.com/example/Hello>

  There are three different types of configuration files for Apache JServ, 
  the first one should be included in your httpd.conf file with the Apache 
  "Include" directive. For example, in your httpd.conf file, you should have 
  a line like this: "Include /path/to/jserv.conf". 
  
  Within your "jserv.conf" file, there is a line that gives the path to the 
  second type of configuration file, the "jserv.properties" file. The line 
  in the jserv.conf file looks like this: "ApJServProperties 
  /path/to/jserv.properties".
  
  Lastly, within the "jserv.properties" file is a line that points to your 
  zone configuration file. If you have a zone called "example", then you 
  will need to have an "example.properties" file and the location to this 
  file is then defined with this line in your "jserv.properties" file: 
  "example.properties=/path/to/file/example.properties"

  Thus, the configuration file path looks like this:

  "->" sounds like "points to"

  httpd.conf -> jserv.conf -> jserv.properties -> example.properties
  
  You should make sure to edit all of these files and fill in the 
  appropriate information according to the comments provided in each of the 
  files. If you have questions about the definitions, you should consult 
  section 8 below, the documentation in the docs directory, on the 
  website, FAQ-O-Matic and/or the Java Apache Users mailing list.

  <http://java.apache.org/jserv/>
  <http://java.apache.org/faq/>
  <http://java.apache.org/main/mail.html>

  7. Problems
     --------

  First, look in the various log files for errors. If you are not getting 
  log files created, then this is generally a result of incorrect 
  permissions on the log files. Make sure that the user (ie: nobody) that 
  the Apache httpd is running as can write to the log files.

  Next, read the FAQ-O-Matic and documentation to see if your issues  
  have already been covered (there is a good chance that they have been). 
  
  <http://java.apache.org/faq/>
  
  Configuration errors and questions are not considered bugs and those 
  should be directed to the Java Apache Users mailing list.

  <http://java.apache.org/main/mail.html>

  If think that you have found a bug, please report it to the Apache Bug 
  Database at: 

  <http://bugs.apache.org/>


  Enjoy!

  -The Apache JServ Project
@


1.29
log
@added EAPI
@
text
@d134 1
d142 1
a142 1
     --enable-rule=SHARED_CORE --enable-module=so
d149 2
a150 2
       --enable-rule=SHARED_CORE \
       --enable-module=so
@


1.28
log
@help for the clueless
@
text
@d208 1
a208 1
       --with-java-platform=1 or 2
d232 8
@


1.27
log
@1.3.9 and higher
@
text
@d65 2
a66 1
        
@


1.26
log
@text to clarify where --with-apache-src points to
@
text
@d33 2
a34 1
        We have removed all support for Apache 1.2.x. Apache 1.3.x has 
d36 4
a39 4
        you upgrade to the latest version. We also had several bugs as a 
        result of bugs in Apache 1.2.x that have been resolved in Apache 
        1.3.x.
        
d113 5
a117 5
     o  DSO - This requires that you have an installation of Apache 1.3.*
        that was configured to have DSO support when it was built.  If you're 
        not sure whether your has DSO support, follow the instructions on 
        configuring Apache JServ for DSO and the configure script will 
        tell you.
@


1.25
log
@fixed bug 5093

Aart de Vries
advries@@iae.nl
@
text
@d173 4
@


1.24
log
@updated documentation
@
text
@d33 5
a37 2
        Apache JServ 1.0.x works only with the Apache HTTP Server (both
        versions 1.2 and 1.3 are supported).
d269 1
@


1.23
log
@removed outdated manual installation section

changed mod_jserv to libjserv.a because that is how php3 and others do it.
@
text
@d96 1
a96 1
        modules because of the dependancy on the Apache apxs module. 
a199 5

         NOTE: Do not force java-platform to be 2 if you are using the 
               Jikes compiler or any other compiler that needs to have the 
               rt.jar or classes.zip in the CLASSPATH.

d218 1
a218 1
     If they are not in your CLASSPATH then you need to specify them like so:
@


1.22
log
@reflects change from --with-java2 to --with-java-platform
@
text
@d263 1
a263 1
    --activate-module=src/modules/jserv/mod_jserv
d270 1
a270 1
        --activate-module=src/modules/jserv/mod_jserv
d320 1
a320 29

  7. Manual Installation
     -------------------

  If you want to install Apache JServ manually, you'll need to compile the 
  Java classes by hand.  Make sure you have the JSDK classes in your 
  classpath, and compile src/java/org/apache/java/*/*.java and 
  src/java/org/apache/jserv/*.java.  Make a jar file from these, or copy 
  them into your classpath, or list this directory in your classpath.

  Next, you'll need to setup Apache.  First, create a subdirectory in 
  $apache_dir/src/modules called 'jserv'.  Then copy Makefile.tmpl, *.gif 
  and *.[ch] from src/c to $apache_dir/src/modules/jserv.  Then either edit 
  Configuration, adding 'AddModule modules/jserv/mod_jserv.o' (if you use 
  'Configure'), or run 'configure' with (in addition to whatever options are 
  appropriate for you) '--activate-module=src/modules/jserv/mod_jserv.c'. 
  Then build Apache as you normally do.

  This will create mod_jserv.o and link it in (statically); docs for 
  creating mod_jserv.so (a DSO) will be added later.  For the mean time, you 
  can use Apache JServ's 'configure' to create this.

  Last, you'll need to create a jserv.properties file; 
  example/jserv.properties provides a sample.  You'll also need to add 
  certain directives to your Apache configuration files (or include another 
  file via 'Include'); example/jserv.conf provides a sample for this.
   

  8. Problems
@


1.21
log
@--with-JSDK
@
text
@d199 6
a204 1
       --with-java2
@


1.20
log
@lots and lots of changes, mostly reflecting the new installation
procedures. i also tested a DSO installation and it actually worked for
the most part. ;-)

vadim, one issue is that the @@VAR@@ replacements worked fine with DSO, but
they are not working with static...i hope that helps you narrow down the
bugs a bit easier.
@
text
@d220 1
a220 1
       --with-jsdk=/path/to/jsdk.jar
d222 1
a222 1
       --with-jsdk=/path/to/unpacked/jsdk
d230 1
a230 1
                --with-jsdk=/path/to/jsdk.jar \
d239 1
a239 1
                --with-jsdk=/path/to/jsdk.jar \
@


1.19
log
@minor changes to formatting as well as clarifications
@
text
@d116 2
a117 2
  3. Configure Apache
     ----------------
d124 7
d138 9
d152 3
a154 1
  need to specify quite a few arguments to configure.  These are:
d160 1
a160 1
       --with-apache-install=/path/to/apache/installation
d170 4
a173 6
     NOTE: Do not try to use both --with-apache-install and --with-apache-src 
     options at the same time.

     For those using a source distribution Apache JServ will configure 
     Apache for you (taking care to preserve your previous configuration) 
     if you use this option:
a174 2
       --enable-apache-conf
       
d182 2
d196 9
d224 1
a224 1
  An example configure line for static compilation is:
d237 1
a237 1
                --with-apache-install=/usr/local/apache \
d242 3
a244 2
  5. Build
     -----
d249 3
a251 1
  the directory you specified as --prefix.
d253 1
a253 1
  NOTE: If you are using an Apache source distribution then you also have 
d255 12
a266 1
  with Apache JServ support in it.
d269 2
a270 1
  'httpd -l'.
a271 1
  
d274 1
a274 1
       
d298 6
d307 3
a309 3
  files. If you have questions about the definitions, you should consult the 
  documentation in the docs directory, on the website, FAQ-O-Matic and/or 
  the Users mailing list.
d342 2
a343 1
  7. Problems
d346 7
a352 2
  First read the FAQ-O-Matic and documentation to see if your issues have already 
  been covered. 
d357 1
a357 1
  should be directed to the Users mailing list.
@


1.18
log
@fixed typo reported by Martin Kuzela <kuzela@@adela.sk>
@
text
@d33 1
a33 1
        Apache JServ 1.0 works only with the Apache HTTP Server (both
d51 2
a52 2
        to execute Apache JServ because of broken compliance. Send it to your
        Java virtual machine implementors.
d72 2
a73 2
        A list of supported Java compilers may be found in the documentation 
        (docs/support.html)
d75 3
a77 2
        NOTE: a Java compiler is needed to build servlets if you plan to write 
        your own.
d82 2
a83 1
        tools. The GNU C compiler (GCC version 2.7.2 is fine) and GNU Make 
d88 3
a90 2
        <http://www.gnu.org/order/ftp.html>.
        
d94 4
a97 1
        DSO support and if your system is supported.
d111 3
a113 2
        not sure whether yours does follow the instructions on configuring 
        Apache JServ for DSO and the configure script will tell you.
d119 1
a119 1
  If you are using a source distribution then you have to configure apache
d122 1
a122 1
  Apache JServ module.
d138 1
a138 1
  o  Apache Dir
d144 3
a146 2
     NOTE: The configure script will check the default installation dir
     so if you have it there you may leave this argument out.	
d205 1
a205 1
                --with-jsdk=/path/to/jsdk \
d214 1
a214 1
                --with-jsdk=/path/to/jsdk \
d225 3
a227 3
  If you are using an Apache source distribution then you also have to run 
  'make install' in the Apache source directory to build Apache with Apache 
  JServ support in it.
@


1.17
log
@documentation changes:

 i added more documentation
regarding unix installation, i moved the entire FAQ over to the
online FAQ-O-Matic and i fixed the java apache project image
at the top of the page to link back to the main website.
@
text
@d196 1
a196 1
                --with-jdk=home=/path/to/jdk \
d205 1
a205 1
                --with-jdk=home=/path/to/jdk \
@


1.16
log
@make things clearer
@
text
@d13 1
a13 1
  distribution (the "exe" distribution) or read the proper instructions 
d62 1
a62 1
        NOTE: this version of Apache JServ requires _exactly_ the 2.0
d144 5
a148 2
     NOTE: For those using a source distribution Apache JServ will configure 
     apache for you (taking care to preserve your previous configuration) 
d151 2
a152 2
       --enable-apache-conf	

d172 1
a172 1
     NOTE: By default, debugging symbols are left out of the JServ 
d191 17
a223 1
  See the HTML docs for info on setting up and running servlets.
d225 10
d236 28
a263 1
  6. Manual Installation
d266 4
a269 4
  If you want to install Apache JServ manually, you'll need to compile
  the Java classes by hand.  Make sure you have the JSDK classes in your
  classpath, and compile src/java/org/apache/java/*/*.java and
  src/java/org/apache/jserv/*.java.  Make a jar file from these, or copy
d272 6
a277 6
  Next, you'll need to setup Apache.  First, create a subdirectory in
  $apache_dir/src/modules called 'jserv'.  Then copy Makefile.tmpl, 
  *.gif and *.[ch] from src/c to $apache_dir/src/modules/jserv.  Then either 
  edit Configuration, adding 'AddModule modules/jserv/mod_jserv.o' (if you 
  use 'Configure'), or run 'configure' with (in addition to whatever options
  are appropriate for you) '--activate-module=src/modules/jserv/mod_jserv.c'.
d280 8
a287 8
  This will create mod_jserv.o and link it in (statically); docs for creating
  mod_jserv.so (a DSO) will be added later.  For the mean time, you can use
  Apache JServ's 'configure' to create this.

  Last, you'll need to create a jserv.properties file;
  example/jserv.properties provides a sample.  You'll also need to add certain
  directives to your Apache configuration files (or include another file via
  'Include'); example/jserv.conf provides a sample for this.
d292 12
a303 3
  First read the Frequently Asked Questions and documentation to see if 
  your issues have already been covered. If think that you have found a 
  bug, please report it to the Apache Bug Database at: 
a306 6
  Note that manual mode operation is not supported in this beta release;
  it will be in a future release.

  If you just have a question, please join the Apache JServ Users mailing 
  list and ask there. Please do not mail project group members directly 
  because this is a 100% volunteer project and most of us have day jobs. :)
@


1.15
log
@added more comments about re-building Apache cause people seem to be
forgetting to do this for some reason.
@
text
@d198 2
a199 2
  'make' in the Apache source directory to build Apache with Apache JServ 
  support in it.
@


1.14
log
@added some comments about setting --prefix
@
text
@d192 1
a192 3
  Once you have configured Apache JServ you can run make. If you are
  using a source distribution then you also have to run make in the
  Apache source directory.
d196 7
@


1.13
log
@added *.gif to manual install requirements 
suggestion by akuchlin@@cnri.reston.va.us
@
text
@d150 7
d196 3
d246 1
a246 1
  -The Apache JServ Project@


1.12
log
@basic manual instructions
@
text
@d202 4
a205 4
  $apache_dir/src/modules called 'jserv'.  Then copy Makefile.tmpl, and
  *.[ch] from src/c to $apache_dir/src/modules/jserv.  Then either edit
  Configuration, adding 'AddModule modules/jserv/mod_jserv.o' (if you use
  'Configure'), or run 'configure' with (in addition to whatever options
d236 1
a236 1
  -The Apache JServ Project
@


1.11
log
@o make the usage of --with-jsdk clear
@
text
@d185 1
a185 1
  Once you have configured JServ Apache you can run make. If you are
d192 27
a218 1
  6. Problems
d226 3
@


1.10
log
@we are a project and not a group...i'm taking this idea from the apache.org
site because i have a feeling it will protect us better legally if needed
@
text
@d177 3
a179 1
       --with-jsdk=/path/to/jsdk
@


1.9
log
@a couple more fixes that i mised
@
text
@d205 1
a205 1
  -The Apache JServ Group
@


1.8
log
@updated the install file by fixing some grammer and added a help section
at the bottom of the file...this is for people who never read past the
INSTALL file...
@
text
@d43 1
d59 1
a124 1

d144 3
a146 3
     NOTE: For those using a source distribution we will configure apache
     for you (taking care to preserve your previous configuration) if you
     use this option:
d150 1
a150 3
  o  JDK programs

     In order to find java, javac, and jar you can use the following options:
d152 4
a155 4
     By default we will first look at the JDK_HOME and JAVA_HOME environment
     variables, if they aren't set then configure will check your PATH
     environment variable.  The results from using the PATH can be overriden
     by:
@


1.7
log
@Some more cleanups
@
text
@d11 1
d41 3
a43 2
        The official list of compatible ports is found on the JavaSoft web site       
        (http://java.sun.com/cgi-bin/java-ports.cgi)
d55 4
a58 3
        The JavaSoft JSDK 2.0 is required by Apache JServ for proper servlet 
        execution.  This package is freely available from the JavaSoft web site 
        (http://java.sun.com/products/servlet/index.html)
d60 1
a60 1
        NOTE: this version of Apache JServ requires _exactly_ the specified
d62 2
a63 1
        (past, present or future) is not supported.
d75 1
a75 1
          
d83 2
a84 2
        at http://www.gnu.org/ and the GCC distribution under
        http://www.gnu.org/order/ftp.html.
a91 1

a106 1

d151 2
a152 1
     In order to find java, javac, and jar you can use the following options.
d154 1
a154 1
     variables, if they aren't set then will check your PATH
d160 2
a161 2
     And we will use these then.  If they aren't found here we will tell you
     and default back to whatever is in your PATH.
d163 2
a164 2
     NOTE: By default debugging symbols are left of the JServ classes, you
     can put them back in by using this:
d168 2
a169 1
     NOTE: By default the jar file is not compressed, this can be changed like so:
d175 1
a175 1
     Being a servlet engine we need to know where your servlet classes are.
a180 1

d190 17
a206 2
  
  Enjoy!@


1.6
log
@Cleaned up a little. Tommy, Ed, tell me what you think!
@
text
@d26 3
a28 1
        [PENDING]
d96 1
a96 1
        lets Apache build the Apache JServ  module into itself statically.    
d109 1
a109 1
  first (some generated header files are needed for JServ Apache to pass its
@


1.5
log
@Made some more configure improvements.

Added updated INSTALL doc, would like some feedback before I
start writing the HTML version.

Removed JServSSI from makefiles and regenerated .deps

Made src/c not actually put the mod_jserv.so in the apache tree
until you do a make install.
@
text
@d2 19
a20 5
                         A P A C H E   J S E R V
                              Version 1.0b1
         Installation instructions for Apache JServ on Unix systems.
     
NOTE:  This file contains the same instructions as /docs/install/howto.unix_install.html
d22 1
a22 2
  What About Win32?
  -----------------
d24 3
a26 1
  For NT/9* see docs/install/howto.win32_install.html
d28 53
a80 2
  Requirements
  ------------
d82 2
a83 1
  See the README file for requirements.
a84 2
  The   easy steps to building Apache JServ
  -----------------------------------------
d87 2
a88 2
  Step 1 - Choose how to add the Apache JServ module to Apache
  ------------------------------------------------------------
d92 3
a94 4
     o  Compile it in -  This requires that you have a source 
        distribution of the Apache server handy as it adds our
	source to that tree and lets Apache build the Apache JServ
        module into itself statically.    
d97 2
a98 2
        that was configured to have DSO support when it was built.  If you're
	not sure whether yours does follow the instructions on configuring 
d102 3
a104 2
  Step 2 - Configure Apache
  -------------------------
d108 2
a109 2
  configure checks).  You do not need to worry about specifying the Apache JServ
  module.
d116 3
a118 1
  --enable-rule=SHARED_CORE --enable-module=so
d120 2
a121 2
  Step 3 - Configure Apache JServ
  -------------------------------
d130 1
a130 1
     --with-apache-install=/path/to/apache/installation
d137 1
a137 1
     --with-apache-src=/path/to/apache/source
d143 1
a143 1
     --enable-apache-conf	
d153 1
a153 1
     --with-jdk-home=/path/to/jdk
d161 1
a161 1
     --enable-debugging
d165 1
a165 1
     --enable-compressed-jar
d172 2
a173 1
     --with-jsdk=/path/to/jsdk
d175 3
a177 2
  Step 4 - Build
  --------------
d185 2
@


1.4
log
@Removed because obsoleted by install docs
@
text
@d1 114
a114 29
This file is intended to provide a bare-bones introduction, enough to
get your system running using Apache JServ at a basic level.  After that,
you will probably want to refer to the HTML documentation in the docs
subdirectory.

How to install:
--------------

  Unix Systems:
    1) In this directory, run the configure script.  You may need to
       specify the location of the Apache installation, using
       the --with-apache-dir={directory} option.

       You may want to use the Apache configure/Configure tool
       (for 1.3/1.2, respectively) -- in that case, you should also
       supply a --enable-apache-conf argument, and possibly
       --prefix={directory} to be given to the Apache configure
       script; examples are shown below:

       ./configure --with-apache-dir=/usr/local/src/apache_1.3.1
                   --enable-apache-conf --prefix=/usr/local/etc/httpd

       ./configure --with-apache-dir=/usr/local/src/apache_1.2.6
                   --enable-apache-conf

       You may want to specify the [alternative] location for the Java
       runtime support with --with-jdk-home={directory} option. Please note
       that this option overrides the $JAVA_HOME environment variable value
       (it used to be the other way around).
a115 201
    2) If you specified --enable-apache-conf, then almost
       everything is taken care of, other than actually running
       make in the Apache directory.  If not, you will need to do
       the following by hand:

       Add mod_jserv to your Apache Configuration file; Apache
       provides documentation on how to do this, but here are
       some hints.
       a) If you're using 1.3, this can be done by running
          the top-level configure script with the line:
          --activate-module=src/modules/jserv/mod_jserv
       b) For either 1.2 or 1.3, if you're modifying the
          Configuration file (in the src directory) directly,
          you can add one of the following lines to that file,
          and (in the src directory) run ./Configure:
		Apache 1.3:
		    AddModule modules/jserv/mod_jserv.o
		--------------
		Apache 1.2:
		    Module jserv_module modules/jserv/mod_jserv.o

          *NOTE*: You must add the following to the EXTRA_LIBS
          line in the configuration: "-L./modules/jserv -ljserv"

    3) Compile Apache, and once you've configured JServ, it should
       run.  Information on how to configure JServ is shown at the
       after the next section, as it's the same for Unix and Windows.


  Win32 Systems:

    1) Create a directory under the Apache modules source tree called "jserv"
        ex. "apache/src/modules/jserv"

    2) Copy all files from this tree into that directory.

    3) In this new-created dir issue "nmake -f Makefile.nt"

    4) Copy "ApacheModuleJServ.dll" into your modules directory

    5) Add to Apache "httpd.conf" file this line
        "LoadModule jserv_module modules/ApacheModuleJServ.dll"

    6) Note that you will need to compile Apache, since JServ uses
       libraries which are not distributed with the Apache executable.

  Standalone wrapper 
	The steps for making these, for Unix and Win32, are described in
	more depth in the HTML documentation which can be found in the
	docs subdirectory of the Apache JServ tree.

Apache Directives:
------------------

There are many other options available, but the following directives
are enough to get Apache JServ working:

ApJServProperties [filename]
    Properties filename for Apache-JServ in "Automatic" Mode (which
    is what these instructions document)

    In the conf subdirectory, there is a file called jserv.properties
    which is a good framework; edit it, and provide the full pathname
    to it, as in the following examples:
	ApJServProperties /usr/local/jserv/conf/jserv.properties
	ApJServProperties C:\Program Files\Apache JServ\conf\jserv.properties

ApJServMount [name] [jserv-url]
    This directive offers quite a bit of flexibility and configurability
    in how servlets map to class files.  To get Apache JServ working, however,
    all you need is the following:

	ApJServMount /servlets /root

    Note: it is necessary to set up a root zone in the jserv.properties
    file for this to work; the sample jserv.properties file mentioned
    above does this.

    Here is a more complete explanation of what this directive does:

    This creates a mount point for an Apache-JServ "zone".  Multiple
    ApJServMount directives are allowed.
    Default: NONE
           [name] is the name of the Apache virtual path to mount jserv-url on
           [jserv-url] is something like "protocol://host:port/zone"
                    if protocol, host or port are not specified then the values
                    from "ApJServDefaultProtocol", "ApJServDefaultHost" or 
                    "ApJServDefaultPort" (other Apache directives) will be used.
                    if zone is not specified all zones will be mounted as sub
                    directories of "name"
                        EX: "ApJServMount /servlets ajpv11:localhost:8007"
                            if user requests "http://host/servlets/kzla/Class"
                            the servlet "Class" in zone "kzla" will be executed
                        EX: "ApJServMount /servlets /kzla"
                            if user requests "http://host/servlets/Class"
                            the servlet "Class" in zone "kzla" on default host
                            thru default protocol on default port will be
                            executed

ApJServSecretKey [filename]
    Apache-JServ secret key file relative to Apache root directory.  This
    defaults to "DISABLED", which disables authentication, and it is not
    strictly necessary to configure this directive; however, it this may
    present certain security issue.  We advise either using
    authentication or restricting access to the machine and the port on which
    Apache JServ listens.

    The contents of this file aren't important (so long as the file contains
    a small amount of text or binary data), but protecting it from potential
    intruders is.

    The authentication Apache JServ provides merely verifies the identities
    of the client and server; it provides no encryption, which means that
    if sensitive data is being transmitted, other measures (such as securing
    the machine) will be necessary to protect it.

    Changing the port (with ApJServPort) may also improve security.

    At present, no exploits are known which would allow a user to gain
    access to a machine through the Apache JServ engine; but it is possible
    that an attacker with direct access to Apache JServ and sufficient
    knowledge of the servlets in use could gain authorized access through
    them, depending on the servlets in use.
    
ApJServAction [extension] [servlet-uri]
    Executes a servlet passing filename with proper extension in
    PATH_TRANSLATED property of servlet request.
    This is not necessary, unless you want to use JServSSI, GNU Server Pages
    (GSP), GnuJSP or other, similar template/page-compilation systems.

    Defaults: NONE

       EX: ApJServAction .jhtml /servlets/org.apache.jserv.servlets.JServSSI

Properties:
-----------

These are found in Apache JServ properties file, and are also explained
(with examples) in the sample jserv.properties file which is provided
with the Apache JServ distribution.

wrapper.bin=[filename]
    The JAVA Virtual Machine binary
    Default: "/usr/bin/java" for Unix systems
             "c:\jdk\bin\java.exe" for Win32 systems

wrapper.bin.parameters=[string]
    Optional arguments passed to java binary
    Default: NONE

wrapper.class=[classname]
    Class executed by JAVA Virtual Machine
    Default: "org.apache.jserv.JServ"

wrapper.class.parameters=[string]
    Optional arguments passed to java class after this properties filename
    Default: NONE

wrapper.path=[path]
    PATH environment value passed to JAVA Virtual Machine
    Default: "/bin:/usr/bin:/usr/local/bin" for Unix systems
             "c:\(windows-dir);c:\(windows-system-dir)" for Win32 systems
    Notes: if more than one line is supplied these will be concatenated using
           ":" or ";" (depending whether Unix or Win32) characters
           Under Win32 (windows-dir) and (windows-system-dir) will be
           automatically evaluated to match your system requirements

wrapper.classpath=[path]
    CLASSPATH environment value passed to JAVA Virtual Machine
    Default: NONE (Sun's JDK/JRE already have a default classpath)
    Notes: if more than one line is supplied these will be concatenated using
           ":" or ";" (depending whether Unix or Win32) characters

wrapper.env=[name]=[value]
    An environment name with value passed to JAVA Virtual Machine
    Default: NONE on Unix Systems
             SystemDrive and SystemRoot wit appropriate values on Win32 systems

wrapper.env.copy=[name]
    An environment name with value copied from caller to JAVA Virtual Machine
    Default: NONE

wrapper.env.copyall=[true/false]
    Copies all environment from caller to JAVA Virtual Machine
    Default: "false"

wrapper.protocol=[name]
    Protocol used for signal handling
    Default: "ajpv11"

port=[number]
    Port used by Apache-JServ and for signal handling
    Default: 8007

security.authentication=[true/false]
    Whether Apache-JServ uses or not security (also signal handling uses this)
    Default: "true"

security.secretKey=[filename]
    File used by Apache-JServ and signal handling as a secret password
    Default: NONE
@


1.3
log
@Fixed Typo
@
text
@@


1.2
log
@Documented the --with-jdk-home option.
@
text
@d21 1
a21 1
                   --enable-apache-conf -prefix=/usr/local/etc/httpd
@


1.1
log
@a basic walk through of the installation procedure (this assumes
a few changes which haven't been made yet)
@
text
@d25 5
@

