Return-Path: Mailing-List: contact tomcat-dev-help@jakarta.apache.org; run by ezmlm Delivered-To: mailing list tomcat-dev@jakarta.apache.org Received: (qmail 40067 invoked from network); 11 Sep 2000 23:27:34 -0000 Received: from unknown (HELO mail1.portera.com) (209.218.200.99) by locus.apache.org with SMTP; 11 Sep 2000 23:27:34 -0000 Received: by mail1.hq.portera.com with Internet Mail Service (5.5.2650.21) id ; Mon, 11 Sep 2000 16:27:32 -0700 Message-ID: <5E5BF8E44723D4119B6D00508BCC219AA412F5@mail1.hq.portera.com> From: Michael Percy To: "'general@jakarta.apache.org'" , "'tomcat-dev@jakarta.apache.org'" Subject: ApJServ directives *must* have been documented by *now*... right? Date: Mon, 11 Sep 2000 16:27:31 -0700 MIME-Version: 1.0 X-Mailer: Internet Mail Service (5.5.2650.21) Content-Type: multipart/mixed; boundary="----_=_NextPart_000_01C01C47.DB781670" X-Spam-Rating: locus.apache.org 1.6.2 0/1000/N ------_=_NextPart_000_01C01C47.DB781670 Content-Type: text/plain; charset="iso-8859-1" I have been looking everywhere, and can barely find a speck of documentation for the Apache directives added by mod_jserv (the ApJServ* directives). The single piece I could find is a README archived in the Apache JServ CVS structure which was removed [Mon Nov 9 23:52:53 1998] which documents them a bit, but it is obsolete. (see http://www.working-dogs.com/cvsweb/index.cgi/jserv/src/c/Attic/README?r1=1.1 0) I have compiled the attached documentation for the mod_jserv directives from bits and pieces wherever I could find them (including the source code), in Apache-style HTML. The thing that gets me is that 90% of people running Tomcat are still using mod_jserv, with no documentation whatsoever, probably because that is what all the examples are written in (and AFAIK mod_jk is not fully developed yet). These are extremely draft docs, and I have no idea how accurate it all is. If anyone has a few moments to correct/enhance/help with this, I would very much appreciate it. Thanks, Michael Percy ------_=_NextPart_000_01C01C47.DB781670 Content-Type: text/html; name="mod_jserv_directives.html" Content-Transfer-Encoding: quoted-printable Content-Disposition: attachment; filename="mod_jserv_directives.html" =0A= =0A= mod_jserv Apache Directives=0A= =0A= =0A= =0A= =0A=

mod_jserv Apache Directives

=0A=

These are written directly into the Apache configuration file = httpd.conf=0A= or included from $TOMCAT_HOME/conf/tomcat.conf via the Apache = Include file=0A= directive.=0A= =0A=

=0A= =0A=

ApJServAction directive

=0A= Syntax: ApJServAction extension = servlet-uri
=0A= Default: NONE
=0A=

Tomcat action mapping extension to servlets.
=0A=

Executes a servlet passing filename with proper extension in = PATH_TRANSLATED=0A= property of servlet request.
=0A= Notes: This is (was?) used for ServerSide = includes, like GSP or JServSSI which=0A= handles the tags.
=0A= From Apache JServ. Obsolete?=0A=

Example:
=0A=

=0A= ApJServAction .jhtml = /servlets/org.apache.jserv.servlets.JServSSI=0A=

=0A=

=0A= =0A=

ApJServBalance directive

=0A= Syntax: ApJServBalance value1 value2 = value3
=0A= Default:

ApJServBalance [?] [?] =
[?]

=0A=

Tomcat load-balancing server set.
=0A= I don't know what these values are, or what this does.=0A=

=0A= =0A=

ApJServDefaultHost directive

=0A= Syntax: ApJServDefaultHost hostname
=0A= Default:

ApJServDefaultHost =
localhost

=0A=

The default host running Tomcat.=0A=

=0A= =0A=

ApJServDefaultProtocol directive

=0A= Syntax: ApJServDefaultProtocol name
=0A= Default:

ApJServDefaultProtocol =
ajpv12

=0A=

The default protocol used for connecting to Tomcat.=0A=

=0A= =0A=

ApJServDefaultPort directive

=0A= Syntax: ApJServDefaultPort number
=0A= Default: ApJServDefaultPort 8007
=0A=

The default port on which Tomcat is running on.=0A=

=0A= =0A=

ApJServHost directive

=0A= Syntax: ApJServHost value1 value2 = value3
=0A= Default: ApJServHost [?] [?] [?]
=0A=

Tomcat host definition.
=0A= I don't know what these values are, or what this does.=0A=

=0A= =0A=

ApJServEnvVar directive

=0A= Syntax: ApJServEnvVar value1 value2
=0A= Default: ApJServEnvVar [?] [?]
=0A=

Tomcat: protocol ajpv12 : env var to send to the server.
=0A= I don't know what these values are, or what this does.=0A=

=0A= =0A=

ApJServLogFile directive

=0A= Syntax: ApJServLogFile filename
=0A= Default:

ApJServLogFile =
./logs/jserv.log

=0A=

Tomcat log file relative to Apache root directory. When "DISABLED" = is=0A= supplied the log will be redirected to Apache error log.=0A=

=0A= =0A=

ApJServLogLevel directive

=0A= Syntax: ApJServLogLevel debug / info / notice / = warn / error / crit / alert / emerg
=0A= Default: ApJServLogLevel ?
=0A=

Tomcat log verbosity.=0A= (Is the above precendence correct?)=0A=

=0A= =0A=

ApJServManual directive

=0A= Syntax: ApJServManual off / on
=0A= Default: ApJServManual off
=0A=

Whether Tomcat is running in manual (user-started) or automatic = (started by Apache) mode.
=0A= Automatically starting Tomcat is not implemented yet.=0A= (on=3DManual / off=3DAutostart)=0A=

=0A= =0A=

ApJServMount directive

=0A= Syntax: ApJServMount name jserv-url = [value3?]
=0A= Default: NONE
=0A=

Where Tomcat servlets will be mounted under Apache.
=0A= name is the name of the Apache virtual path to mount jserv-url = on=0A= jserv-url. Something like "protocol://host:port/zone".=0A=

If protocol, host or port are not specified then the values from=0A= "ApJServDefaultProtocol", "ApJServDefaultHost" or "ApJServDefaultPort" = will=0A= be used. If zone is not specified all zones will be mounted as sub = directories=0A= of name.=0A=

Example:
=0A=

=0A= ApJServMount /servlets ajpv11:localhost:8007
=0A= If user requests "http://host/servlets/kzla/Class"=0A= the servlet "Class" in zone "kzla" will be executed.
=0A=

=0A= Example:
=0A=

=0A= ApJServMount /servlets /kzla
=0A= If user requests "http://host/servlets/Class"=0A= the servlet "Class" in zone "kzla" on default host through default = protocol=0A= on default port will be executed.=0A=

=0A=

=0A= =0A=

ApJServMountCopy directive

=0A= Syntax: ApJServMountCopy on / off
=0A= Default: ApJServMountCopy on
=0A=

Whether <VirtualHost> inherits base host mount points or = not.=0A=

=0A= =0A=

ApJServProperties directive

=0A= Syntax: ApJServProperties filename
=0A= Default:

ApJServProperties =
./conf/jserv.properties

=0A=

The full pathname of jserv.properties file. In Manual mode = this directive is ignored.=0A=

=0A= =0A=

ApJServProtocolParameter directive

=0A= Syntax: ApJServProtocolParameter name parameter = value
=0A= Default: NONE
=0A=

Tomcat protocol-dependant property.
=0A= Passes parameter and value to specified protocol.
=0A= Notes: Currently no protocols handle this. It is kept = for future protocols=0A= compatibility.=0A=

=0A= =0A=

ApJServProtocolProperty directive

=0A= Syntax: ApJServProtocolProperty value1 value2 = value3
=0A= Default:

ApJServProtocolProperty [?] [?] =
[?]

=0A=

I don't know what these values are, or what this does.=0A=

=0A= =0A=

ApJServRetryAttempts directive

=0A= Syntax: ApJServRetryAttempts value
=0A= Default: ApJServRetryAttempts [?]
=0A=

Tomcat retry attempts (1 sec apart) before returning server = error.
=0A= I don't know what this value is, or what this does.=0A=

=0A= =0A=

ApJServRoute directive

=0A= Syntax: ApJServRoute value1 value2
=0A= Default: ApJServRoute [?] [?]
=0A=

Tomcat host routing identifier.
=0A= I don't know what these values are, or what this does.=0A=

=0A= =0A=

ApJServSecretKey directive

=0A= Syntax: ApJServSecretKey filename
=0A= Default:

ApJServSecretKey =
./conf/jserv.secret.key

=0A=

Tomcat secret key file relative to Apache root directory. When=0A= "DISABLED" is supplied the authentication (for secure communication) = will be disabled.=0A= This feature is not yet implemented.=0A=

=0A= =0A=

ApJServShmFile directive

=0A= Syntax: ApJServShmFile value
=0A= Default: ApJServShmFile [?]
=0A=

The full pathname of shared memory file.
=0A= I don't know what this value is, or what this does.=0A=

=0A= =0A=

ApJServVMTimeout directive

=0A= Syntax: ApJServVMTimeout value
=0A= Default: ApJServVMTimeout 10
=0A=

Tomcat: the amount of time given for the JVM to start or = stop.
=0A= I don't know what these values are, or what this does. (for = ApJServManual off ?)=0A=

=0A= =0A=

ApJServVMInterval directive

=0A= Syntax: ApJServVMInterval value
=0A= Default: ApJServVMInterval 10
=0A=

Tomcat: the interval between 2 polls of the JVM.
=0A= I don't know what these values are, or what this does.=0A=

=0A= =0A=

This is very much a first draft of the mod_jserv documentation. = Please=0A= send corrections to mpercy@portera.com=0A= and/or help this document find the right people to include it in the = official=0A= distribution. Thank you.=0A= =0A=

Regards,
=0A= Michael Percy=0A= =0A=

=0A=

=0A= =0A= =0A= =0A= =0A= =0A= =0A= =0A= =0A= ------_=_NextPart_000_01C01C47.DB781670--