botlist_testserver/jetty/README.txt

   1
   2 This is the Jetty 6 HTTP server and servlet container.
   3
   4 For more information about Jetty, please see the Jetty wiki:
   5
   6    http://docs.codehaus.org/display/JETTY/
   7
   8 DIRECTORY LAYOUT
   9 ================
  10 bin                   utility scripts and executables
  11 contexts              Deployment directory for context descriptors
  12 contrib               Source modules for optional jetty packages in the jetty-contrib repository, which has a larger more open group of committers
  13 etc                   Configuration files
  14 examples              Example projects
  15 extras                Source modules for optional jetty packages in the main jetty repository.
  16 javadoc               Generated javadoc
  17 lib                   Generated libraries
  18 LICENSES              License
  19 logs                  Request log and server log files
  20 modules               Source modules for core jetty packages
  21 patches               Optional patches for source modules
  22 pom.xml               Build configuration for maven
  23 project-website       Project Website
  24 README.txt            This file
  25 resources             Directory for resources to include on classpath
  26 start.jar             Start jar for jetty
  27 VERSION.txt           Version history
  28 webapps               Deployment directory for standard webapps
  29
  30
  31 RUNNING JETTY
  32 =============
  33 From the release, you can run the server with:
  34
  35    java -jar start.jar
  36
  37 and then point your browser at
  38
  39    http://localhost:8080
  40
  41 and click to the test webapp, where there are some demos and more
  42 information.
  43
  44 The start command above is equivalent to
  45
  46    java -jar start.jar etc/jetty.xml
  47
  48 which gives a configuration file on the commandline. An explicit
  49 configuration file (or multiple configuration files) may be
  50 given to select specific configurations.
  51
  52 There is also a unix start script in bin/jetty.sh that can be used
  53 in /etc/init.d
  54
  55 JETTY DEPENDENCIES
  56 ==================
  57
  58 The Jetty build is rather large, because it bundles many optional
  59 packages.
  60
  61 Jetty depends ONLY on a jre 1.4 runtime and the three jars found in
  62 the top level of the $JETTY_HOME/lib directory:
  63
  64   servlet-api-2.5-$VERSION.jar
  65   jetty-$VERSION.jar
  66   jetty-util-$VERSION.jar
  67
  68 For small foot print applications, these three jars can be
  69 trimmed of excess classes - we will soon automate generation
  70 of such minimal assemblies.
  71
  72 The jars found in the subdirectories are all optional:
  73
  74   jsp-2.0/*.jar   (depends on java 2 (jre 1.4))
  75   jsp-2.1/*.jar   (depends on java 5 (jre 1.5))
  76   management/*.jar
  77   naming/*.jar
  78   plus/*.jar
  79   xbean/*.jar
  80
  81 The start.jar includes all these options if they are
  82 left in the lib subdirectories.
  83
  84 The start.jar will also select the version of JSP to
  85 use based on the version of the jre available.
  86
  87
  88 RUNNING WITH JMX
  89 ================
  90
  91 The server can be run with JMX management with the command:
  92
  93    java -jar start.jar etc/jetty-jmx.xml etc/jetty.xml
  94
  95 This command adds the jmx configuration file before the server
  96 configuration.
  97
  98 RUNNING WITH JETTY PLUS
  99 =======================
 100
 101 The server can be run as JettyPlus (JNDI, JAAS etc.) with the
 102 command:
 103
 104    java -jar start.jar etc/jetty.xml etc/jetty-plus.xml
 105
 106 This command adds the plus configuration file after the server configuration file,
 107 although you will first need to follow the instructions inside the etc/jetty-plus.xml
 108 file.
 109
 110 RUNNING WITH OTHER CONTAINERS
 111 =============================
 112 If you wish to use Continuations in other containers, the jetty-util.jar
 113 can be included in WEB-INF/lib and will provide waiting continuations
 114
 115
 116 BUILDING JETTY
 117 ==============
 118
 119 Jetty uses maven 2 as its build system.  Maven will fetch
 120 the dependancies, build the server and assemble a runnable
 121 version:
 122
 123   mvn install
 124
 125 Jetty itself only needs java 1.4, however to build JSP 2.1
 126 support you need to use java5 AND you will need to have
 127 cvs installed.    If you want to use java1.4,
 128 then you can use the jsp-2.0 modules instead of the
 129 jsp-api-2.1 and  jsp-2.1 modules.
 130
 131
 132 DEPENDENCIES
 133 ============
 134 The only real dependancy is the servlet api, so only
 135 the jars in the top level of the lib directory are needed
 136 to run Jetty (and they can be trimmed from many applications).
 137
 138 The jars in the subdirectories of lib are all optional, but
 139 are included on the classpath by the standard start.jar
 140 mechanism
 141