1Lucee on Jetty
2 3 4Description
5-----------
6 7Lucee on Jetty is an unzip-and-run Lucee-enabled Jetty server. It does not
8require installation, simply extract the files from the zip, run the
9start-server script, and you have a Jetty server running Lucee.
10 11The file structure uses Jetty's home/base directory split - this means:
12* The directory jetty-home is an unmodified copy of the latest Jetty release.
13* The directory lucee-base contains all configuration and the Lucee JAR.
14 15Documentation is provided in docs.pdf and online at https://docs.sorcerersisle.com/luje
16 17This bundle was built using the template at https://code.sorcerersisle.com/luje
18 19 20Requirements
21------------
22 23The requirements for running a Lucee on Jetty bundle are that of the
24individual components - namely, a supported Java VM.
25 26For Jetty 9.x and Lucee 5.x this means a JRE at v8 or v11.
27 28Jetty 10.x requires a v11 JRE.
29 30If in doubt, visit https://adoptopenjdk.net and follow the instructions
31to get the latest OpenJDK 11 (LTS) for your operating system.
32 33 34Usage
35-----
36 37Unzip to a suitable location.
38On Windows, double-click the start-server.bat to start the server.
39All other operating systems, execute start-server.sh to start the server.
40Pressing Ctrl-C will shutdown the server.
41 42Browse to http://localhost:8080/ to confirm it is working.
43 44See docs.pdf for details of what is configured, what the various files and
45directories are for, etc.
46 47Quick points:
48* The default webroot is lucee-base/webapps/ROOT
49* The default port (8080) can be changed in lucee-base/start.ini
50* The Lucee web admin for a context is at http://{hostname}/lucee/admin/web.cfm
51and the context directories are at lucee-base/webinfs/{lucee-context-label}
52* The Lucee server admin is http://{hostname}/lucee/admin/server.cfm and the
53server context can be found in lucee-base/lucee-server
54 55 56Licensing
57---------
58 59This Lucee on Jetty bundle is collectively licensed as LGPLv3.
60 61The primary components are licensed as below. These in turn have their own
62components - see respective READMEs for details.
63 64Jetty v{JETTY_VERSION}
65* Website: https://eclipse.org/jetty
66* Source: https://github.com/eclipse/jetty.project
67* License: Apache v2.0 (also available under EPL v2)
68* Files: jetty-home/*
69 70Lucee v{LUCEE_VERSION}
71* Website: https://www.lucee.org
72* Source: https://bitbucket.org/lucee/lucee
73* License: LGPLv2
74* Files: lucee-base/modules/lucee/lucee*.jar lucee-base/lucee-server/*
75 76
