FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...
ContentBox CLIv1.4.0+38 Public
This is the official ContentBox CLI for interacting with ContentBox headless instances and also for allowing you to create and manage ContentBox installations.
Apache License, Version 2.0.
Install the commands via CommandBox like so:
box install contentbox-cli
You can use the CLI for many thing like installing ContentBox, creating widgets, themes, and much more. More importantly, the CLI is the official way to install ContentBox from version 5 forwards. It is a gargantuan task to be able to maintain more than 4 CFML engines against 4 major databases. That's why this CLI was built, to make things easier for installing and working with ContentBox across the board.
We have created the
install and the
install-wizard commands so you can easily install ContentBox on any OS, using any supported CFML engine and supported database. Here are the supported engines and databases:
Before using the commands you must do two things:
# Start the CommandBox shell box # Create and move into the directory where we will install your site mkdir --cd mySite
install command is meant to be used without user interactivity. It is great for automation and setting up ContentBox sites with no user input. The
install-wizard command is meant to be used as a wizard that will guide you through the installation process.
# Automated install contentbox install name="MySite" databaseType="MySQL8" databaseUsername="root" databasePassword="mysql" # Wizard install contentbox install-wizard
install command has several arguments you can use in order to install ContentBox. Please note the arguments with the
required name- The name of the site
cfmlEngine = "[email protected]"- The CFML engine to use
cfmlPassword = "contentbox"- The password to seed the CFML Admin with
coldboxPassword = "contentbox"- The password to seed the ColdBox application with
required databaseType- The database type you are installing against
databaseHost = "localhost"- The host location for your database
databasePort=""- The database port
required databaseUsername- The database connection useranme
required databasePassword- The database connection password
databaseName = "contentbox"- The name of the database
boolean production = false- Is this a development site or a production site
boolean deployServer = true- If true, we will deploy the CFML Engine on CommandBox in the directory you chose for installation. Else, we just prepare everything for you to run the folder within your CFML installation.
boolean verbose = false- Verbose logging to the cli
The available CFML Engines are:
The available RDBMS are:
Once you run the command, this command will do the following procedures:
.envin the root with the appropriate secrests and credentials to your database
box.jsonin your root configured with all dependencies and migrations connection information to your database
server.jsonin your root configured to your CFML engine of choice.
That's it, enjoy ContentBox.
Here are some example commands for installation:
# Install against MySQL 8 with Lucee contentbox install name="MySite" databaseType="MySQL8" databaseUsername="root" databasePassword="mysql" # Install against MySQL 8 with Adobe 2018 contentbox install name="MySite" cfmlEngine="[email protected]" databaseType="MySQL8" databaseUsername="root" databasePassword="mysql" # Install against Microsoft SQL Server with Adobe 2018 contentbox install name="MySite" cfmlEngine="[email protected]" databaseType="MicrosoftSQL" databaseUsername="sa" databasePassword="sqlserver" # Install against Lucee and PostgreSQL contentbox install name="MySite" databaseType="PostgreSQL" databaseUsername="myRole" databasePassword="myPassword"
I THANK GOD FOR HIS WISDOM FOR THIS PROJECT
"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12
All notable changes to this project will be documented in this file.
deployServerso you can choose to deploy or not a CommandBox server when installing ContentBox
appcfcmissing variable when updating lucee + mysql 8 bug for ddl creation.
box install contentbox-cli