server start

Aliases: 
  • start
    •  
    Parameters:
    Name Type Required Default Hint
    name String false short name for this server or a path to the server.json file.
    port Numeric false port number
    host String false bind to a host/ip
    openbrowser Boolean false open a browser after starting
    directory String false web root for this server
    stopPort Numeric false stop socket listener port number
    force Boolean false false force start if status is not stopped
    debug Boolean false Turn on debug output while starting and stream server output to console.
    webConfigDir String false custom location for web context configuration
    serverConfigDir String false custom location for server configuration
    libDirs String false comma-separated list of extra lib directories for the server to load
    trayIconFile String false path to .png file for tray icon
    HTTPEnable Boolean false enable HTTP
    SSLEnable Boolean false enable SSL
    SSLPort Numeric false SSL port number
    SSLCertFile String false Path to SSL certificate file
    SSLKeyFile String false Path to SSL key file (required if SSLCert specified)
    SSLKeyPass String false SSL key passphrase
    rewritesEnable Boolean false enable URL rewriting (default false)
    rewritesConfig String false optional URL rewriting config file path
    heapSize Numeric false The max heap size in megabytes you would like this server to start with, it defaults to 512mb
    minHeapSize Numeric false The min heap size in megabytes you would like this server to start with
    directoryBrowsing Boolean false Enables directory browsing (default false)
    JVMArgs String false Additional JVM args to use when starting the server. Use "server status --verbose" to debug
    runwarArgs String false Additional Runwar options to use when starting the server. Use "server status --verbose" to debug
    saveSettings Boolean false true Save start settings in server.json
    cfengine String false sets the cfml engine type
    WARPath String false sets the path to an existing war to use
    serverConfigFile String false The path to the server's JSON file. Created if it doesn't exist.
    startTimeout Numeric false The amount of time in seconds to wait for the server to start (in the background).
    console Boolean false Start this server in the foreground console process and wait until Ctrl-C is pressed to stop it.
    welcomeFiles String false A comma-delimited list of default files to load when visiting a directory (index.cfm,index.htm,etc)
    serverHomeDirectory String false The folder where the CF engine WAR should be extracted
    restMappings String false A comma-delimited list of REST mappings in the form of /api/*,/rest/*. Empty string to disable.
    trace Boolean false Enable trace level logging
    javaHomeDirectory String false Path to the JRE home directory containing ./bin/java
    AJPEnable Boolean false Enable AJP
    AJPPort Numeric false AJP Port number
    javaVersion String false Any endpoint ID, such as "java:openjdk11" from the Java endpoint
    startScript String false If you want to generate a native script to directly start the server process pass bash, cmd, or pwsh
    startScriptFile String false Optional override for the name and location of the start script. This is ignored if no startScript param is specified
    dryRun Boolean false Abort actually starting the server process, but all installation and downloading will still be performed to "warm up" the engine installation.
    verbose Boolean false Activate extra server start information without enabling the debug mode in the actual server (which you wouldn't want in production)
    trayEnable Boolean false Enable the system tray icon/menu
    profile String false Controls default server settings. Profiles: production, development, none
    blockCFAdmin String false Block access to Lucee or ACF admin. Valid values are true, false, external

    Command Usage

    Start an embedded CFML server. Run command from the web root of the server.
    Please also remember to look at the plethora of arguments this command has as you can start your server with SSL, rewrites and much more.

    server start
    Start with rewrites enabled
    server start --rewritesEnable
    Start with specific heap size
    server start heapSize=768
    The default CF engine is the version of Lucee Server that the CLI is running on.
    You can also start Adobe ColdFusion engines as well as Railo Server using the "cfengine" parameter.
    Specify an engine version after an @ sign like you would on package installation.
    server start cfengine=railo

    server start cfengine=adobe

    server start cfengine=adobe@11.0
    cfengine can also be any valid Endpoint ID that points to a ForgeBox entry, HTTP URL, etc.
    server start cfengine=https://downloads.ortussolutions.com/adobe/coldfusion/9.0.2/cf-engine-9.0.2.zip
    You can also start up a local WAR file with the WARPath parameter.
    server start WARPath=/path/to/explodedWAR

    server start WARPath=/path/to/WARArchive.war