head	1.1;
access;
symbols;
locks; strict;
comment	@# @;


1.1
date	98.07.28.16.07.27;	author ianosh;	state Exp;
branches;
next	;


desc
@@


1.1
log
@Readme file explaining Directives/Properties.
@
text
@How to install:
--------------

  Unix 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) Modify Apache "Configuration" file and add this line
        "AddModule modules/jserv/mod_jserv.o"

    4) Run Apache "Configure" script

    5) Run "make"

  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"

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

These are found in Apache configuration files (httpd.conf...)

JServManual [on/off]
    Wether Apache must start JVM or not (On=Manual Off=Autostart)
    Default: "Off"

JServProperties [filename]
    Properties filename for JServ in Automatic Mode. Manual mode ignores this
    Default: "./conf/jserv.properties"

JServDefaultProtocol [name]
    Protocol used by this host to connect to JServ
    Default: "ajpv11"

JServDefaultHost [hostname]
    Host on which JServ is currently running
    Default: "localhost"

JServDefaultPort [number]
    Port used to connect to JServ
    Default: protocol-dependant (for ajpv11 protocol this is "8007")

JServMount [name] [jserv-uri]
    Mount point for JServ zones.
    Default: NONE
    Notes: [name] is the name of the Apache virtual path to mount jserv-uri on
           [jserv-uri] is something like "protocol://host:port/zone"
                    if protocol, host or port are not specified then the values
                    from "JServDefaultProtocol", "JServDefaultHost" or 
                    "JServDefaultPort" will be used.
                    if zone is not specified all zones will be mounted as sub
                    directories of "name"
                        EX: "JServMount /servlets ajpv11:localhost:8007"
                            if user requests "http://host/servlets/kzla/Class"
                            the servlet "Class" in zone "kzla" will be executed
                        EX: "JServMount /servlets /kzla"
                            if user requests "http://host/servlets/Class"
                            the servlet "Class" in zone "kzla" on default host
                            thru default protocol on defaul port will be
                            executed

JServMountCopy [on/off]
    Wether <VirtualHost> inherits base host mount points
    Default: "On"

JServLogFile [filename]
    JServ log file relative to Apache root directory. When "DISABLED" is
    supplied the log will be redirected to Apache error log
    Default: "./logs/jserv.log"

JServSecretKey [filename]
    JServ secret key file relative to Apache root directory. When "DISABLED" is
    supplied the authentication will be disabled.
    Default: "./conf/jserv.secret.key"

JServProtocolParameter [name] [parameter] [value]
    Passes parameter and value to specified protocol.
    Default: NONE
    Notes: Currently no protocols handle this. It is kept for future protocols
           compatibility

JServAction [extension] [servlet-uri]
    Executes a servlet passing filename with proper extension in
    PATH_TRANSLATED property of servlet request.
    Defaults: NONE
    Notes: This is used for ServerSide includes, like GSP or JServSSI wich
           handles the <servlet> tags 
           EX: "JServAction .jhtml /servlets/org.apache.jserv.servlets.JServSSI

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

These are found in JServ properties file (jserv.properties...)

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 wether 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 wether 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 JServ and for signal handling
    Default: 8007

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

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