changeset 27:ec5d764b73a3

Move README.
author Mikhail Kryshen <mikhail@kryshen.net>
date Tue, 03 Nov 2009 18:09:31 +0300
parents 9501a363dcbb
children 3349a282943a
files README dist/README
diffstat 2 files changed, 54 insertions(+), 54 deletions(-) [+]
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue Nov 03 18:09:31 2009 +0300
     1.3 @@ -0,0 +1,54 @@
     1.4 += Description =
     1.5 +
     1.6 +Host lifecycle event listener for Apache Tomcat to automatically
     1.7 +deploy update and undeploy applications from user home directories.
     1.8 +
     1.9 +This is a rewrite of org.apache.catalina.startup.UserConfig listener
    1.10 +included in Tomcat which adds the following features:
    1.11 + - multiple web applications for each user,
    1.12 + - automatic application deployment,
    1.13 + - on UNIX read network user database using getent command.
    1.14 +
    1.15 += Installation =
    1.16 +
    1.17 +Copy userconfig.jar to Tomcat lib directory. Add Listener to the Host
    1.18 +element in the Tomcat configuration file (server.xml).
    1.19 +
    1.20 +Listener that uses passwd database to list users:
    1.21 +    <Listener className="kryshen.catalina.userconfig.PasswdUserConfig"/>
    1.22 +
    1.23 +Listener that considers all home directories in the specified base
    1.24 +directory:
    1.25 +    <Listener className="kryshen.catalina.userconfig.HomesUserConfig"/>
    1.26 +
    1.27 += Listener properties =
    1.28 +
    1.29 +Common:
    1.30 +
    1.31 +  directoryName - base directory for web applications inside user's
    1.32 +                  home directory. Default: "public_webapps".
    1.33 +
    1.34 +  appsPerUser - maximum number of application each user is allowed to
    1.35 +                deploy. Default: -1 (unlimited).
    1.36 +
    1.37 +PasswdUserConfig:
    1.38 +
    1.39 +  passwd - path to local passwd file. Default: "/etc/passwd".
    1.40 +
    1.41 +  getent - path to getent program. Local passwd is used if this is not
    1.42 +           set. Default: not set (null).
    1.43 +
    1.44 +HomesUserConfig
    1.45 +
    1.46 +  homeBase - base directory for user homes. Default: "/home".
    1.47 +
    1.48 += Example = 
    1.49 +
    1.50 +<Host name="localhost"  appBase="webapps"
    1.51 +      unpackWARs="true" autoDeploy="true"
    1.52 +      xmlValidation="false" xmlNamespaceAware="false"
    1.53 +      backgroundProcessorDelay="15">
    1.54 +
    1.55 +     <Listener className="kryshen.catalina.userconfig.PasswdUserConfig"
    1.56 +               getent="/usr/bin/getent" appsPerUser="5"/>
    1.57 +</Host>
     2.1 --- a/dist/README	Tue Nov 03 17:20:42 2009 +0300
     2.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.3 @@ -1,54 +0,0 @@
     2.4 -= Description =
     2.5 -
     2.6 -Tomcat event listener to automatically deploy update and undeploy
     2.7 -applications from user home directories.
     2.8 -
     2.9 -This is a rewrite of org.apache.catalina.startup.UserConfig listener
    2.10 -included in Tomcat which adds the following features:
    2.11 - - multiple web applications for each user,
    2.12 - - automatic application deployment,
    2.13 - - on UNIX read network user database using getent command.
    2.14 -
    2.15 -= Installation =
    2.16 -
    2.17 -Copy userconfig.jar to Tomcat lib directory. Add Listener to the Host
    2.18 -element in the Tomcat configuration file (server.xml).
    2.19 -
    2.20 -Listener that uses passwd database to list users:
    2.21 -    <Listener className="kryshen.catalina.userconfig.PasswdUserConfig"/>
    2.22 -
    2.23 -Listener that considers all home directories in the specified base
    2.24 -directory:
    2.25 -    <Listener className="kryshen.catalina.userconfig.HomesUserConfig"/>
    2.26 -
    2.27 -= Listener properties =
    2.28 -
    2.29 -Common:
    2.30 -
    2.31 -  directoryName - base directory for web applications inside user's
    2.32 -                  home directory. Default: "public_webapps".
    2.33 -
    2.34 -  appsPerUser - maximum number of application each user is allowed to
    2.35 -                deploy. Default: -1 (unlimited).
    2.36 -
    2.37 -PasswdUserConfig:
    2.38 -
    2.39 -  passwd - path to local passwd file. Default: "/etc/passwd".
    2.40 -
    2.41 -  getent - path to getent program. Local passwd is used if this is not
    2.42 -           set. Default: not set (null).
    2.43 -
    2.44 -HomesUserConfig
    2.45 -
    2.46 -  homeBase - base directory for user homes. Default: "/home".
    2.47 -
    2.48 -= Example = 
    2.49 -
    2.50 -<Host name="localhost"  appBase="webapps"
    2.51 -      unpackWARs="true" autoDeploy="true"
    2.52 -      xmlValidation="false" xmlNamespaceAware="false"
    2.53 -      backgroundProcessorDelay="15">
    2.54 -
    2.55 -     <Listener className="kryshen.catalina.userconfig.PasswdUserConfig"
    2.56 -               getent="/usr/bin/getent" appsPerUser="5"/>
    2.57 -</Host>