CFConfig Documentation
  • Introduction
  • The Basics
    • About This Book
    • Authors
    • Overview
    • Getting Started Guide
    • Supported Engines
    • Config Items
  • Using the CLI
    • Installation
    • Usage
    • CommandBox Server Interceptors
      • Server Start
      • Server Stop
    • Command Overview
      • Export Settings
      • Import Settings
      • Transfer Settings
      • Diff Settings
      • Set/View Settings
      • Manage Datasources
      • Manage CF Mappings
      • Manage Caches
      • Manage Mail Servers
      • Manage Event Gateway Configuration
      • Manage Event Gateway Instances
      • Manage Lucee Loggers
      • Manage Scheduled Tasks
    • JSON File Storage
    • Env Var Overrides
  • Using the Services
    • Installation
    • Component Overview
    • API Overview
Powered by GitBook
On this page
  • Specifying a Server Home
  • Lucee 4/5 Web Context
  • Lucee 4/5 Server Context
  • Adobe 9/10/11/2016/2018/2021/2023 CF Home
  • JSON File
  • Server Format (engine/version)
  • Embedded CommandBox Server
  • ModCFML and Web Contexts

Was this helpful?

Edit on GitHub
Export as PDF
  1. Using the CLI

Usage

PreviousInstallationNextCommandBox Server Interceptors

Last updated 5 months ago

Was this helpful?

Specifying a Server Home

CFConfig must determine the server(s) on which to operate, which will either be a web context or a server context. CFConfig will determine the server as follows:

  1. By default, when the to or from parameters are not present, CFConfig will use the current working directory, assuming it is the web root for an Embedded CommandBox Server (see below).

  2. You provide a file path to the server home by using the to and/or from parameters.

  3. You provide the name of a previously-started CommandBox server, using to and/or from parameters (see ).

Lucee 4/5 Web Context

The folder containing the lucee-web.xml.cfm file. An example would be:

<webroot>C:/myapp/WEB-INF/lucee/

cfconfig export from=C:/myapp/WEB-INF/lucee/ to=myconfig.json

Lucee 4/5 Server Context

Path to the lucee-server folder containing the /context/lucee-server.xml file. An example would be:

C:/lucee/tomcat/lucee-server/

cfconfig export from=C:/lucee/tomcat/lucee-server/ to=myconfig.json

Adobe 9/10/11/2016/2018/2021/2023 CF Home

The cfusion folder that contains the lib/neo-runtime.xml file. An example would be:

C:/ColdFusion11/cfusion/

JSON File

Just provide the path to the JSON file. This is auto-detected if the path ends in .json. An example would be:

C:/path/to/myConfig.json

Server Format (engine/version)

Every command with a to and/or from parameter also has a matching toFormat and/or fromFormat parameter. In most cases, you don't need to provide this. If you are pointing to an existing CommandBox server, or typical server installation, CFConfig will examine the files in the CF home to determine what engine and version it is. However, if you are writing files to an empty or non-existent directory, you'll need to tell CFConfig what format to write them in.

Format is specified as engine@version where:

  • engine is the name of the CF engine.

  • version is a semantic version number representing the engine version.

Possible engine values are:

  • luceeWeb - Lucee web context.

  • luceeServer - Lucee server context (Default for Lucee servers).

  • adobe - Adobe server.

  • railoWeb - Railo web context.

  • railoServer - Railo server context.

Here are some examples of server formats:

  • adobe@10

  • adobe@11.0.10

  • luceeServer@5

  • luceeWeb@4.5

Embedded CommandBox Server

If you run CFConfig from the web root of a CommandBox embedded server, you do not need to specify the from or to parameters to reference it, and CFConfig will automatically default to the luceeServer format, which operates on the server context. If you wish to interact with the web context (which has little distinction in a CommandBox server since there's only one web context per server), you will need to provide the explicit luceeWeb format by using either the toFormat or fromFormat parameters.

cfconfig show fromFormat=luceeWeb

This example assumes you are running CFConfig from the web root of an embedded server:

cfconfig import from=config_admin.json toFormat=luceeWeb

ModCFML and Web Contexts

When using ModCFML, Lucee can have more than one web context. When using the fromFormat or toFormat of luceeWeb, you will be interacting with the Lucee web context associated with the default web root. To interact with a specific Lucee web context, specify the web root in the format name like so:

cfconfig export fromFormat=luceeWeb-/path/to/webroot/site1 to=.cfconfig-web-site1.json
cfconfig export fromFormat=luceeWeb-/path/to/webroot/site2 to=.cfconfig-web-site2.json
CommandBox Managing Servers