Skip to content

Commit b019653

Browse files
committed
update the WAR install docs
1 parent 8555114 commit b019653

File tree

1 file changed

+47
-20
lines changed
  • docs/04.guides/02.installing-lucee/03.osx/01.installing-tomcat-and-lucee-on-os-x-using-the-lucee-war-file

1 file changed

+47
-20
lines changed

docs/04.guides/02.installing-lucee/03.osx/01.installing-tomcat-and-lucee-on-os-x-using-the-lucee-war-file/page.md

Lines changed: 47 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,64 @@ title: Installing Tomcat and Lucee on Mac OS X using the Lucee WAR file
33
id: running-lucee-installing-tomcat-and-lucee-on-os-x-using-the-lucee-war-file
44
---
55

6-
Download a copy of Apache Tomcat 8.5 core, available at the [Tomcat download page](https://tomcat.apache.org/download-80.cgi).
6+
This guide walks you through deploying Lucee as a WAR file to Apache Tomcat on macOS. This is a lightweight setup ideal for development or small deployments where you want full control over your servlet container.
77

8-
Install Tomcat by extracting the downloaded archive. Extract the archive to your home folder, /Users/<username>. For convenience, you can rename the resulting folder from //apache-tomcat-8.5.29// to //tomcat//.
8+
By the end of this guide, you'll have Lucee running at `http://localhost:8080/` with access to both the Server and Web admin interfaces.
99

10-
1. Go into tomcat/webapps/. Delete the /ROOT/ folder and /ROOT.war/.
10+
## Prerequisites
1111

12-
2. Next, go to the [Lucee download page](https://lucee.org/downloads.html) and download the latest lucee war file.
12+
- **Java 11 or higher** - Lucee 6.x requires Java 11+. You can install via Homebrew: `brew install openjdk@21`
13+
- **Apache Tomcat** - Version depends on your Lucee version:
14+
- **Lucee 6.x** (javax-based): Use [Tomcat 9.x](https://tomcat.apache.org/download-90.cgi)
15+
- **Lucee 7+** (jakarta-based): Use [Tomcat 10.x](https://tomcat.apache.org/download-10.cgi) or [11.x](https://tomcat.apache.org/download-11.cgi)
1316

14-
3. Rename the lucee war file to /ROOT.war/ (note the capitalization).
17+
## Installation Steps
1518

16-
4. Copy the renamed /ROOT.war/ file into tomcat/webapps/.
19+
1. Extract Tomcat to your home folder `/Users/<username>/`. For convenience, rename the folder to `tomcat`.
1720

18-
5. Create a startup.sh file in tomcat/ with the following contents, replacing "\<username\>" with your username to provide the literal path:
21+
1. Go into `tomcat/webapps/`. Delete the `/ROOT/` folder and `/ROOT.war/`.
1922

20-
> \# set the path to Tomcat binaries
21-
> export CATALINA_HOME=/Users/\<username\>/tomcat9
22-
>
23-
> \# set the path to the instance config, i.e. current directory if this file is in the CATALINA_BASE directory
24-
> export CATALINA_BASE=/Users/\<username\>/tomcat9
25-
>
26-
> EXECUTABLE=${CATALINA_HOME}/bin/catalina.sh
27-
> exec $EXECUTABLE run
23+
1. Go to the [Lucee download page](https://download.lucee.org/) and download the latest Lucee WAR file.
2824

29-
6. In Terminal, cd into the tomcat directory and then execute the following command to start Lucee
25+
1. Rename the Lucee WAR file to `ROOT.war` (note the capitalization).
3026

31-
> ./startup.sh
27+
1. Copy `ROOT.war` into `tomcat/webapps/`.
3228

33-
7. Next, open a web browser to localhost:8080/lucee/admin/web.cfm. You should see the Lucee Web admin login screen. Lucee is now installed.
29+
1. Create a `startup.sh` file in the `tomcat/` directory with the following contents, replacing `<username>` with your macOS username:
3430

35-
8. You may want to install [mod_cfml](https://viviotech.github.io/mod_cfml/install-lin-ubuntu.html) to use Apache
31+
```bash
32+
#!/bin/bash
33+
# set the path to Tomcat binaries
34+
export CATALINA_HOME=/Users/<username>/tomcat
3635

37-
**Next Steps**
36+
# set the path to the instance config
37+
export CATALINA_BASE=/Users/<username>/tomcat
38+
39+
EXECUTABLE=${CATALINA_HOME}/bin/catalina.sh
40+
exec $EXECUTABLE run
41+
```
42+
43+
1. Make the script executable and start Tomcat:
44+
45+
```bash
46+
chmod +x startup.sh
47+
./startup.sh
48+
```
49+
50+
1. Open a web browser to `http://localhost:8080/lucee/admin/server.cfm`. You should see the Lucee Server Admin login screen. On first access, you'll be prompted to set an admin password.
51+
52+
## Understanding Lucee's Directory Structure
53+
54+
When Lucee starts, it creates configuration directories:
55+
56+
- **Server config**: `tomcat/webapps/ROOT/WEB-INF/lucee-server/` - Contains server-wide settings
57+
- **Web config**: `tomcat/webapps/ROOT/WEB-INF/lucee/` - Contains web context settings
58+
- **Config file**: `.CFConfig.json` in the `context/` subdirectory stores your configuration
59+
60+
## Optional: Apache Integration
61+
62+
You may want to install [mod_cfml](https://viviotech.github.io/mod_cfml/) to integrate with the Apache web server.
63+
64+
## Next Steps
3865

3966
From this point you can configure your Tomcat instance and set up your applications in Lucee.

0 commit comments

Comments
 (0)