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 and run the
9start-server script and you have a 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 the Lucee JAR and configuration.
14(See readme file in lucee-base for further details.)
15 16This bundle was created from the template at:
17 18 https://github.com/boughtonp/lucee-on-jetty
19 20 21Usage
22-----
23 24Unzip to a suitable location.
25On Windows, double-click the start-server.bat to start the server.
26All other operating systems, execute start-server.sh to start the server.
27Pressing Ctrl-C will shutdown the server.
28 29There are README files in many directories. Reading them is highly recommended.
30 31Key points:
32* The default port (8080) can be changed in lucee-base/start.ini
33* The default webroot is lucee-base/webapps/ROOT
34* Instructions for adding more are in lucee-base/webapps/readme.md
35* The Lucee web admin for a context is at http://{hostname}/lucee/admin/web.cfm
36and the context directories are at lucee-base/webinfs/{lucee-context-label}
37* The Lucee server admin is http://{hostname}/lucee/admin/server.cfm and the
38server context can be found in lucee-base/lucee-server
39 40 41Licensing
42---------
43 44This Lucee on Jetty bundle is collectively licensed as LGPLv3, with its included
45documentation licensed as CC-BY-SA v4.0.
46 47The primary components are licensed as below. These in turn have their own
48components - see respective READMEs for details.
49 50Jetty v{JETTY_VERSION}
51* Website: http://eclipse.org/jetty
52* Source: http://git.eclipse.org/c/jetty
53* License: Apache v2.0 (also available under EPL v2)
54* Files: jetty-home/*
55 56Lucee v{LUCEE_VERSION}
57* Website: http://lucee.org
58* Source: https://bitbucket.org/lucee/lucee
59* License: LGPLv2
60* Files: lucee-base/modules/lucee/lib/lucee*.jar
61 62 63 64FAQ
65---
66 67> What port does it run on?
68 69The HTTP server will run on the port specified by the `jetty.http.port` setting in
70the lucee-base/start.ini config file, and uses the Jetty default of 8080. It can
71be changed to any available port. Note that changes to start.ini require a Jetty
72restart to be picked up.
73 74> Where is the hostname/aliases set?
75 76Jetty runs on localhost only by default, but can be set to respond to any IP or
77hostname. This is configured on a per-context basis, e.g. each host can have its
78own context, or multiple virtual host aliases can point to a single context.
79 80The configuration for this is via the webapp context XML config files, which
81reside in lucee-base/webapps - see the associated readme for further details.
82 83> Where is the webroot?
84 85The default webroot is lucee-base/webapps/ROOT/
86You can add virtual host aliases by editing lucee-base/webapps/ROOT.xml
87You can add other webroots (contexts) by copying and changing the XML file.
88 89See the readme in lucee-base/webapps for details of both of these.
90 91> Where are the Lucee logs?
92 93Lucee logs are stored in a context's web config directory - that is in
94lucee-base/webinfs/{web-context-label}/logs
95(The web-context-label defaults to a unique value for each context. To see - and
96change - this label, for all contexts, login to the Lucee Server Admin.)
97 98The logs directory in lucee-base is used by the Jetty instance.
99100> How is Jetty upgraded?
101102Download a new Jetty distribution and replace the jetty-home directory with it.
103104> How is Lucee upgraded?
105106Use Lucee's own upgrade functionality (i.e. via admin, or an lco patch file).
107For major upgrades, replace the JAR in lucee-base/modules/lucee/lib/ with a
108new Lucee JAR download.
109110> I have a question not answered here?
111112Check the documentation:
113 https://docs.sorcerersisle.com/luje
114115If the answer is not there, raise an issue:
116 https://github.com/boughtonp/lucee-on-jetty/issues
117118119/eof