Sorcerer's IsleCode Lucee on Jetty / files 

 1Lucee on Jetty
 2
 3* Version:       0.7
 4* License:       LGPLv3
 5* Homepage:      https://www.sorcerersisle.com/software/luje
 6* Documentation: https://docs.sorcerersisle.com/luje
 7* Repository:    https://code.sorcerersisle.com/luje.git
 8* Issues:        https://codeberg.org/boughtonp/lucee-on-jetty/issues
 9
10
11Description
12-----------
13
14Lucee on Jetty is a project to provide:
15* a Jetty module for running the Lucee CFML engine
16* sensible defaults configured for Lucee and Jetty
17* documentation of what has been configured and why
18* a reference guide for how to perform common tasks
19
20This repository contains the template for bundling Lucee with Jetty. It uses
21Jetty's home/base functionality to simplify the process and avoid the need to
22modify the Jetty files, and uses a module to keep Lucee configuration discrete.
23
24
25Requirements
26------------
27
28Lucee on Jetty bundles are built with a Bash script.
29Whilst the resulting bundle requires a JVM to run, the build process does not.
30
31Thus, the minimum requirements are GNU Bash and GNU Coreutils (or compatible).
32
33Git is the easiest way to obtain the lucee.jetty-module submodule.
34
35If not already installed, these are available via your package manager.
36
37(Windows users can install Git for Windows to obtain all of these.)
38
39
40Getting Started
41---------------
42
43It is not required to build Lucee on Jetty yourself - if all you want 
44is to run Lucee on Jetty, you can download a pre-built package from
45https://www.sorcerersisle.com/software/luje
46
47If `lucee.jetty-module` directory is empty, either run `git submodule update`
48to have Git download the files; or manually download and copy them from
49https://code.sorcerersisle.com/lucee.jetty-module 
50
51Run `build/build.sh --help` to see the various options and example usage.
52
53
54Licensing & Credits
55-------------------
56
57This project is available under the terms of the LGPLv3 license.
58See license.txt to understand your rights and obligations.
59
60Lucee on Jetty is created and maintained by Peter Boughton.
61
62This repository does not contain Lucee or Jetty themselves; these have their
63own licenses (Lucee: LGPLv2; Jetty: Apache License 2.0 or EPLv2).
64
65
66Contributing
67------------
68
69This project was created to provide a ready-to-run Lucee package for 
70anyone who prefers Jetty to Tomcat
71
72Contributions are welcome, but please discuss first (either by 
73raising an issue or sending an email).
74
75
76/eof