view README @ 28:3349a282943a

Update README.
author Mikhail Kryshen <mikhail@kryshen.net>
date Tue, 03 Nov 2009 18:19:58 +0300
parents ec5d764b73a3
children b8d451897c62
line source
1 = Description =
3 Host lifecycle event listener for Apache Tomcat to automatically
4 deploy update and undeploy applications from user home directories.
6 This is a rewrite of org.apache.catalina.startup.UserConfig listener
7 included in Tomcat which adds the following features:
8 - multiple web applications for each user,
9 - automatic application deployment,
10 - on UNIX read network user database using getent command.
12 = Installation =
14 Copy userconfig.jar to Tomcat lib directory. Add Listener to the Host
15 element in the Tomcat configuration file (server.xml).
17 Listener that uses passwd database to list users:
18 <Listener className="kryshen.catalina.userconfig.PasswdUserConfig"/>
20 Listener that considers all home directories in the specified base
21 directory:
22 <Listener className="kryshen.catalina.userconfig.HomesUserConfig"/>
24 = Listener properties =
26 Common:
28 directoryName - base directory for web applications inside user's
29 home directory. Default: "public_webapps".
31 appsPerUser - maximum number of application each user is allowed to
32 deploy. If greater than 1 (multi-app mode) each user's
33 application subdirectory in the base directory is
34 mapped to "/~username/application", "ROOT" is mapped
35 to "/~username". In single-app mode (appsPerUser = 1)
36 the base directory is mapped to "/~username".
38 PasswdUserConfig:
40 passwd - path to local passwd file. Default: "/etc/passwd".
42 getent - path to getent program. Local passwd is used if this is not
43 set. Default: not set (null).
45 HomesUserConfig
47 homeBase - base directory for user homes. Default: "/home".
49 = Example =
51 <Host name="localhost" appBase="webapps"
52 unpackWARs="true" autoDeploy="true"
53 xmlValidation="false" xmlNamespaceAware="false"
54 backgroundProcessorDelay="15">
56 <Listener className="kryshen.catalina.userconfig.PasswdUserConfig"
57 getent="/usr/bin/getent" appsPerUser="5"/>
58 </Host>