Commandbox Server.json

Commandbox used with cfml web servers

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/commandbox-server-json/latest.json
Source https://raw.githubusercontent.com/Ortus-Solutions/vscode-commandbox/master/resources/schemas/server.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration file for a CommandBox server

Properties

name string

The name of the server

Default: ""
openBrowser boolean

Controls whether browser opens by default when starting server

Default: true
openBrowserURL string

Override the URL to open when starting the server

Default: ""
startTimeout number

The length of time in seconds to wait for the server to start

Default: 240
stopsocket number

The port the server listens on to receive a stop command

Default: 0
debug boolean

Enable debug level logging for server

Default: false
trace boolean

Enable trace level logging for server

Default: false
console boolean

Start the server in console mode instead of in the background

Default: false
trayEnable boolean

Control whether the server has an associated icon in the system tray

Default: true
trayicon string

Path to the server's tray icon

Default: ""
trayOptions trayOptionsItem[]

An array of custom menu items to be added to the server's tray menu

Default:
[]
minItems=0
jvm object

JVM Options

5 nested properties
heapSize number | string

The max heap size of the server

Default: ""
minHeapSize number | string

The starting heap size for the server

Default: ""
args string

Ad-hoc JVM args for the server such as -X:name

Default: ""
javaHome string

Path to custom JRE. Default is the one that the CommandBox CLI is using

Default: ""
javaVersion string

A Java installation ID. In its entirety, it has the form _

Default: ""
web object

Web Server Options

13 nested properties
host string

The default host name of the server

Default: "127.0.0.1"
webroot string

Webroot directory

Default: ""
directoryBrowsing boolean

Enables file listing for directories with no welcome file

Default: false
accessLogEnable boolean

Enable web server access log

Default: true
GZIPEnable boolean

Enable GZip compression in HTTP responses

Default: true
welcomeFiles string

A comma-delimited list of files that you would like CommandBox to look for when a user hits a directory

Default: ""
aliases object

Web aliases for the web server, similar to virtual directories

Default:
{}
errorPages object

The error pages that CommandBox servers return. You can have a setting for each status code including a default error page to be used if no other setting applies

Default:
{}
1 nested properties
default string

Path to default error page

Default: ""
HTTP object

Configure the HTTP listener on the server

2 nested properties
enable boolean

Enable HTTP for this serer

Default: true
port number

HTTP port to use

Default: 0
SSL object

Configure the HTTPS listener on the server

5 nested properties
enable boolean

Enable HTTPS for this server

Default: false
port number

HTTPS port to use

Default: 1443
certFile string

Path to SSL cert file

Default: ""
keyFile string

Path to SSL key file

Default: ""
keyPass string

Password for SSL key file

Default: ""
AJP object

Configure the AJP listener on the server

2 nested properties
enable boolean

Enable AJP for this server

Default: false
port number

AJP port to use

Default: 8009
rewrites object

Configure URL Rewrites

5 nested properties
enable boolean

Enable URL Rewrites on this server

Default: false
logEnable boolean

Enable Rewrite log file

Default: false
config string

Path to xml config file or .htaccess

Default: ""
statusPath string

URL path to visit Tuckey status page like '/tuckey-status'

Default: "/tuckey-status"
configReloadSeconds number

Number of seconds to check rewrite config file for changes

basicAuth object
2 nested properties
enable boolean

Enable basic auth for this server

Default: true
users Record<string, string>

Users who can authenticate to basic auth

Default:
{}
app object

Application Server Options

11 nested properties
logDir string

The folder path where the servlet out, rewrite, and access log are written to

Default: ""
libDirs string

A comma-delimited list of directories from which CommandBox will load JARs

Default: ""
webConfigDir string

Directory for Lucee/Railo web context

Default: ""
serverConfigDir string

Directory for Lucee/Railo server context

Default: ""
webXML string

Path to web.xml file

Default: ""
WARPath string

Path to a local WAR archive or exploded WAR folder. Mutually exclusive with cfengine.

Default: ""
cfengine string

An Endpoint ID that resolves to a CF engine such as 'adobe' or 'lucee'. Include version as 'adobe@2016'

Default: ""
restMappings string

Comma delimited list of paths to map to the CF engine's REST servlet such as '/rest/,/api/'

Default: ""
serverHomeDirectory string

Path to folder where the server WAR will be expanded

Default: ""
sessionCookieSecure boolean

Enable secure session cookies

Default: false
sessionCookieHTTPOnly boolean

Enable HTTP-only session cookies

Default: false
runwar object

These settings apply to the underlying Runwar library that starts servers

1 nested properties
args string

Ad-hoc options for the underlying Runwar library

Default: ""

Definitions

trayOptionsItem object

An object that represents a single tray menu item

label string

Text of menu item

action string

Action to perform when user clicks this menu item. 'openfilesystem', 'openbrowser', or 'stopserver'

url string

Url to open for 'openbrowser' action

disabled boolean

Turn menu item grey and nothing happens when clicking on it

Default: false
image string

Path to PNG image to display on menu item next to the label

Default: ""
hotkey string

Keyboard shortcut to choose this menu item

Default: ""
path string

Filesystem path to open for 'openfilesystem' action

Default: ""
items trayOptionsItem[]

Nested menu items

Default:
[]
minItems=0