annotate README @ 28:3349a282943a

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