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
  • Manage All Configs
  • cfconfig export
  • cfconfig import
  • cfconfig transfer
  • cfconfig diff
  • Manage Individual Configs
  • cfconfig set
  • cfconfig show
  • Manage Datasources
  • cfconfig datasource list
  • cfconfig datasource save
  • cfconfig datasource delete
  • Manage CF Mappings
  • cfconfig cfmapping list
  • cfconfig cfmapping save
  • cfconfig cfmapping delete
  • Manage Lucee/Railo Caches
  • cfconfig cache list
  • cfconfig cache save
  • cfconfig cache delete
  • Manage Mail Servers
  • cfconfig mailserver list
  • cfconfig mailserver save
  • cfconfig mailserver delete
  • Manage Custom Tag Paths
  • cfconfig customtagpath list
  • cfconfig customtagpath save
  • cfconfig customtagpath delete
  • Event Gateway Configuration
  • cfconfig eventgatewayconfig list
  • cfconfig eventgatewayconfig save
  • cfconfig eventgatewayconfig delete
  • Event Gateway Instances
  • cfconfig eventgatewayinstance list
  • cfconfig eventgatewayinstance save
  • cfconfig eventgatewayinstance delete
  • Lucee Loggers
  • cfconfig logger list
  • cfconfig logger save
  • cfconfig logger delete
  • Scheduled Tasks
  • cfconfig task list
  • cfconfig task save
  • cfconfig task delete

Was this helpful?

Edit on GitHub
Export as PDF
  1. Using the CLI

Command Overview

Here's an overview of all the commands available to the CFConfig CLI. There are sub-pages for each of these commands with additional details.

Manage All Configs

cfconfig export

Extracts all configuration from a server to a location of your choice.

cfconfig import

Imports all configuration from a location of your choice into a server. Like export, but spelled different.

cfconfig transfer

Moves all configuration from a location of your choice to another location of your choice. Like import and export but pronounced different.

cfconfig diff

Shows a diff of every setting that's different between two servers or a server and a JSON file.

Manage Individual Configs

cfconfig set

Sets or overwrites a single setting on a server.

cfconfig show

Views a single setting on a server.

Manage Datasources

cfconfig datasource list

List all datasources.

cfconfig datasource save

Add or update a datasource by name

cfconfig datasource delete

Remove a datasource by name.

Manage CF Mappings

cfconfig cfmapping list

List all CF mappings

cfconfig cfmapping save

Add or update a CF mapping by virtual path.

cfconfig cfmapping delete

Remove a CF mapping by virtual path.

Manage Lucee/Railo Caches

cfconfig cache list

List all caches in a Lucee/Railo server.

cfconfig cache save

Add or update a cache by name.

cfconfig cache delete

Remove a cache by name.

Manage Mail Servers

cfconfig mailserver list

List all mail servers on a server.

cfconfig mailserver save

Add or update a mail server by host.

cfconfig mailserver delete

Delete a mail server by host.

Manage Custom Tag Paths

cfconfig customtagpath list

List all Custom Tag paths

cfconfig customtagpath save

Save a Custom Tag path

cfconfig customtagpath delete

Delete a Custom Tag path

Event Gateway Configuration

cfconfig eventgatewayconfig list

List all Event Gateway Configurations

cfconfig eventgatewayconfig save

Add or update an Event Gateway Configuration

cfconfig eventgatewayconfig delete

Delete an Event Gateway Configuration

Event Gateway Instances

cfconfig eventgatewayinstance list

List all Event Gateway Instances

cfconfig eventgatewayinstance save

Add or update an Event Gateway Instance

cfconfig eventgatewayinstance delete

Delete an Event Gateway Instance

Lucee Loggers

cfconfig logger list

List all Lucee Loggers

cfconfig logger save

Add or update a Lucee Logger

cfconfig logger delete

Delete a Lucee Logger

Scheduled Tasks

cfconfig task list

List all Scheduled Tasks

cfconfig task save

Add or update a Scheduled Task

cfconfig task delete

Delete a Scheduled Task

PreviousServer StopNextExport Settings

Last updated 9 months ago

Was this helpful?