Skip to content

Update unattended install docs with current options from installer help #1537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zspitzer merged 2 commits into from
Sep 30, 2025
Merged

Update unattended install docs with current options from installer help #1537

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
168d2f9
Update docs with current options
jimpriest Sep 30, 2025
384efc6
Fix linting issues
jimpriest Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 101 additions & 25 deletions ...installing-lucee/05.installation-linux/05.installing-in-unattended-mode/page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,92 @@ To launch the installer in unattended mode, you will need to run the following f

After unattended mode has been initialized, default values will be used in required locations with the exception of where there are no default values. If there is no default value on a variable where a value is required.

The following is required and does not have a default. This value MUST be specified or the installer will fail with an error saying this variable doesn't have a value.
#### Installer Help ####

**--luceepass**
Available installer options are viewable by passing in --help:

# lucee-[version]-installer.run --help

#### Password ####

A password is required and does not have a default. This value MUST be specified or the installer will fail with an error saying this variable doesn't have a value.

**--luceepass**
**Default Value:** [None]

The password that will be used for the Lucee Administrators at install time. **This password must be 6 characters or more.**

# lucee-[version]-installer.run --mode unattended --luceepass "this is my password"

Simply running the above will make the installer use default values, including the default ports, installing the Apache connector if Apache is present, and use default usernames and installation directories. The default values for these variables is defined in detail below
Simply running the above will make the installer use default values, including the default ports, installing the Apache connector if Apache is present, and use default usernames and installation directories. The default values for these variables is defined in detail below.

### Installer Variables ###

The following variables can also be customized by passing them to the installer via the command-line.

**--help**
Display the list of valid options

**--version**
Display product information

**--unattendedmodeui**
**Default:** [none]
**Allowed:** [none minimal minimalWithDialogs]
Unattended Mode UI

**--optionfile**
**Default:** [none]
Installation option file.

**--debuglevel**
**Default: [2]**
**Allowed:** [0 1 2 3 4]
Debug information level of verbosity.

**--mode**
**Default:** [gtk]
**Allowed:** [gtk xwindow text unattended]
Installation mode

**--debugtrace**
**Default:** [none]
Debug filename

**--installer-language**
**Default:** [en]
**Allowed:** [en]
Language selection

**--installjre**
**Default:** [installjre]
**Allowed:** [false true]
Select Java

**--prefix**
**Default:** [unknown variable my_prefix]
Installation Directory

**--luceepass**
**Default:** [none - this is required]
Lucee Password (must be 6 characters or more)

**--minheap**
**Default: [none]**
Minimum (mb)

**--maxheap**
**Default:** [none]
Maximum (mb)

**--servicename**
**Default:** [Lucee]
Set the service name

**--systemuser**
**Default Value:** [root]
This is the user account that Lucee will run as on your system. If this user account doesn't exist at Install time, a user and group account will be made using this name and Lucee will run as this system user.

**--tomcatport**
**Default Value:** [8888]
The port number Tomcat will use for it's internal web server (coyote). This port is what's used by default for Apache mod_proxy_html.
Expand All @@ -41,58 +111,63 @@ The Tomcat shutdown port number. This port should not be open to the Internet.
**Default Value:** [8009]
This is the port the AJP listener will be connecting to. This port is used by mod_jk and mod_proxy_ajp and is required to be available to your apache server if you are using either of those connection methods.

**--systemuser**
**Default Value:** [root]
This is the user account that Lucee will run as on your system. If this user account doesn't exist at Install time, a user and group account will be made using this name and Lucee will run as this system user.

**--startatboot**
**Default Value:** [true]
This is a BOOLEAN value, meaning it must be true or false.
The default setting of "true" will copy the lucee_ctl script to the /etc/init.d/ directory and use system commands to set the service to start at boot time. Setting the variable to "false" will cause the script to only exist in the installation directory. /opt/lucee/lucee_ctl for example.

**--installiis**
**Default Value:** [true]
This is a BOOLEAN value, meaning it must be true or false.
This value tells the installer to install the connector for IIS, the BonCode Connector. (Ignored on Linux) By setting this variable to [true], the Windows Lucee Installer will launch the BonCode Connector installer silently during the install process. You will see several DOS windows pop-up during the connector install process as the BonCode Connector verifies modules and installs what it needs.

**--installconn**
**Default Value:** [true]
This is a BOOLEAN value, meaning it must be true or false.
This value tells the installer to install the Apache connector. (Ignored on Windows) This variable must be set to [true] if any of the Apache-specific variables are to have any relevance. If this variable is set to [false], the Apache-specific variables will be ignored.

**--installmodcfml**
**Default Value:** [true]
This is a BOOLEAN value, meaning it must be true or false.
This value tells the installer to install the mod_cfml connector.

**--customLuceejar**
**Default:** [none]
Select a Lucee jar

**--apachecontrolloc**
**Default Value:** [/usr/sbin/apachectl]
Requires: "--installconn true"
**Requires:** "--installconn true"
Specifies the location of the "apachectl" control script.

**--apachemodulesloc**
**Default Value (RHEL/32):** [/usr/lib/httpd/modules]
**Default Value (RHEL/64):** [/usr/lib64/httpd/modules]
**Default Value (Debian/32):** [/usr/lib/apache2/modules]
**Default Value (Debian/64):** [/usr/lib64/apache2/modules]
Requires: "--installconn true"
**Requires:** "--installconn true"
Specifies the location for new Apache modules. Default value changes depending on default system and the existence of the default directory.

**--apacheconfigloc**
**Default Value (RHEL):** [/etc/httpd/conf/httpd.conf]
**Default Value (Debian):** [/etc/apache2/apache2.conf]
Requires: "--installconn true"
**Requires:** "--installconn true"
Specifies the location of the primary Apache configuration script. Global installs for mod_proxy and mod_cfml will be placed in this file.

**--apachelogloc**
**Default Value (RHEL):** [/var/log/httpd/]
**Default Value (Debian):** [/var/log/apache2/]
Requires: "--installconn true"
**Requires:** "--installconn true"
Specifies the location of the Apache log files. Used in the configuration of the connector logs for mod_jk.

**--installiis**
**Default Value:** [true]
This is a BOOLEAN value, meaning it must be true or false.
This value tells the installer to install the connector for IIS, the BonCode Connector. (Ignored on Linux) By setting this variable to [true], the Windows Lucee Installer will launch the BonCode Connector installer silently during the install process. You will see several DOS windows pop-up during the connector install process as the BonCode Connector verifies modules and installs what it needs.

**--installmodcfml**
**Default Value:** [true]
This is a BOOLEAN value, meaning it must be true or false.
This value tells the installer to install the mod_cfml connector.
**--bittype**
**Default:** infinite recursion in variable bittype
**Allowed:** [32 64]
32-bit or 64-bit system

### Using an OptionFile ###

The Bitrock InstallBuilder software also supports using an "optionfile" to pass parameters to the Lucee Installer in unattended mode. To use an option file, create a text file (lucee-options.txt in this example) and give it the following content:
The Bitrock InstallBuilder software also supports using an "optionfile" to pass parameters to the Lucee Installer in unattended mode. To use an option file, create a text file (lucee-options.txt in this example) and give it the following content (adjust options for your needs):

```lucee
luceepass=YOURPASSWORDHERE
Expand All @@ -104,10 +179,11 @@ systemuser=root
startatboot=true
installconn=true
apachecontrolloc=/usr/sbin/apachectl
apachemodulesloc=
apacheconfigloc=
apachelogloc=
installiis=true
apachemodulesloc=/usr/lib/apache2/modules
apacheconfigloc=/etc/apache2/apache2.conf
apachelogloc=/var/log/apache2/
installiis=false
installmodcfml=true
```

You may need to remove or change some options for your specific system. Be sure to change the "luceepass" option to your own password.
Expand Down