Sorcerer's IsleCode Lucee on Jetty / files

     1# Lucee on Jetty lucee-base directory.
     2
     3For the primary Lucee on Jetty readme, see README.TXT in the parent directory.
     4
     5This lucee-base directory uses the split jetty-home/jetty-base functionality
     6available in Jetty 9, to allow configuration of Lucee against an unmodified
     7Jetty instance. For more information on jetty-base see the Jetty documentation
     8at http://www.eclipse.org/jetty/documentation/current/startup-base-and-home.html
     9
    10This file contains information about the following:
    11* The structure and purpose of the files and directories here.
    12* Jetty and Lucee configurations which have been made.
    13
    14For more specific information, check for a readme in the relevant directory.
    15(If there is no readme, check the Jetty documentation for further details.)
    16
    17
    18## Directories and files
    19
    20	readme.md    - this file.
    21	start.ini    - Jetty startup modules & configuration.
    22	logs         - Jetty's log files are created here.
    23	lucee-server - Lucee's server context and patches go here.
    24	modules      - Additional Jetty module files.
    25	 ~ lucee.mod - Lucee module for Jetty.
    26	 ~ lucee/    - Configuration files for Lucee module.
    27	   ~ lib     - Lucee's JAR file.
    28	   ~ etc     - Jetty configuration overrides.
    29	     ~ lucee-servlets.xml - Lucee CFML Servlet configuration.
    30	     ~ rewrite-rules.xml - Jetty URL rewrite rules.
    31	resources    - Jetty resource files.
    32	 ~ jetty-logging.properties - Jetty logging configuration
    33	webapps      - Jetty looks for webapp contexts here.
    34	 ~ ROOT.xml - the XML config file for the default webapp context.
    35	webinfs      - Lucee's webapp context configuration and log files.
    36
    37
    38## Jetty configuration
    39
    40* The `start.ini` file lists the relevant built-in modules plus `modules/lucee.mod`
    41* The `modules/lucee/etc/rewrite-rules.xml` file is loaded by start.ini and rewrites *.cfm to enable path info.
    42* The `modules/lucee/etc/lucee-servlets.xml` file is loaded via the overrideDescriptor setting
    43in a webapp XML config file, and maps *.cfm and *.cfc to Lucee's CFMLServlet.
    44
    45
    46## Lucee configuration
    47
    48* The `lucee-server-directory` parameter is set to use `lucee-base/lucee-server`
    49instead of the `lucee-base/lib/ext/lucee-server` default.
    50* The `lucee-web-directory` parameter is set to use `lucee-base/webinfs/{web-context-label}`
    51instead of `lucee-base/webapps/{context}/WEB-INF/lucee`