LogoLogo
SourceSupportTraining
v5.x
v5.x
  • Introduction
  • Intro
    • Release History
      • What's New With 5.3.0
      • What's New With 5.2.0
      • What's New With 5.1.0
      • What's new With 5.0.0
      • Upgrading From v4.x
    • About This Book
      • Author
  • Getting Started
    • Installation
      • System Requirements
      • CommandBox Installation
      • Source Installation
      • Express Installation
      • Existing ColdBox Application
      • Docker
    • Updates
    • Quick Guide
  • Usage
    • Using ContentBox
      • The ContentBox Dashboard
        • Home
        • About
      • Categories
      • Content
        • Publish Content
          • Blog
          • Sitemap
          • Content Editing Tips
            • Editor Features
            • Dynamic Variable Output
            • Markdown Support
            • Scheduled Content
        • Consume Content
          • Content Store
          • Categories
          • Media Manager
          • Menu Manager
      • Comments
        • Inbox
        • Settings
      • Look & Feel
        • Active Theme
        • Global HTML
        • Themes
        • Widgets
          • Inserting a Simple Widget
      • Media Manager
      • Modules
        • Installing Modules
        • Managing Modules
      • Users
        • Manage
        • Permissions
        • Roles
      • Tools
        • Import
        • Export
        • Static Site Generation
      • System
        • Auth Logs
        • Geek Settings
        • Settings
          • Site Options
          • Admin Options
          • Security Options
          • Login Options
          • Content Options
          • Editor Options
          • Media Manager Options
          • Gravatars
          • Notifications
          • Mail Server
          • Search Options
          • Login Options
        • Security Rules
        • Updates
      • Widgets
        • An Easy Example
        • Inside the Page Editor
    • Developing For ContentBox
  • Front End Development
    • Front End Development
      • File Structure
      • JS and CSS Assets
      • Customizing Views
      • Customizing Layouts
      • Customizing Navigation
      • Global Variables
      • Managing Assets
      • Template Variables
      • The Content Store
    • Theme Development
      • Theme Settings
      • Theme UDFs
      • Theme Templates
      • Theme Layouts
      • Theme Views
      • Theme SEO Functionality
  • Back End Development
    • Back End Development
      • Overriding ContentBox Settings
      • Modules
        • Installing a Module
        • Using a Module
        • Module Locations and Conventions
        • Build a Module
        • Scaffold a Module
        • Theme your Module
        • Build an Admin Module
        • Adding Admin Menus to your Module
        • Adding Meta to your Modules
      • Widgets
        • Core Widgets
        • Simple Widget
        • Widgets with Arguments
        • Multiple Render Function Widgets
      • Interceptors
      • Accessing Logged in User
      • Customizing the Admin
      • Staying on the Upgrade Path
Powered by GitBook
On this page
  • Install CommandBox
  • Requirements
  • Download CommandBox
  • Starting CommandBox
  • Install ContentBox-CLI
  • Creating Your Database
  • Creating Your Datasource
  • Creating A ContentBox Site
  • Web Installer

Was this helpful?

Edit on Git
Export as PDF
  1. Getting Started
  2. Installation

Source Installation

Deploy ContentBox into any Adobe or Lucee CFML Engine

Last updated 2 years ago

Was this helpful?

In this section you will deploy ContentBox so it can run on any running Adobe or Lucee CFML engine. The first step is to use CommandBox and our contentbox-cli package so we can install and configure ContentBox for usage in any CFML Engine. We won't be using CommandBox as our server, just as a package manager and CLI.

Install CommandBox

​

CommandBox CLI

Requirements

  • MacOS, Windows or Linux

  • JDK 8+

  • A clean, empty directory on your machine

Download CommandBox

Starting CommandBox

Once you download and expand CommandBox you will have the box.exe or box binary, which you can place in your Windows Path or *Unix /usr/bin folder to have it available system-wide. Then open the binary and CommandBox will unpack itself your user's directory: {User}/.CommandBox. This happens only once and the next thing you know, you are in the CommandBox interactive shell!

We will be able to execute a-la-carte commands from our command line or go into the interactive shell for multiple commands. We recommend the interactive shell as it is faster and can remain open in your project root.

Install ContentBox-CLI

We can now install the contentbox-cli package:

install contentbox-cli

Once installed you can always run contentbox help to get the list of available commands and help information.

Creating Your Database

Create a database in your RDBMS of choice. Make sure you note the name of the database, the connection details and the credentials for it.

If you are using MySQL, make sure you use utf8mb4 for your database collation.

Creating Your Datasource

Now go to your CFML engine administrator and register the contentbox datasource that points to the database you just created.

Resources

You can use ANY name for the datasource, but we will use contentbox for ease of use.

Creating A ContentBox Site

Now that we have our CLI installed, database and datasource created, go or create a new directory where we will create our site. Most likely this folder will be your web root in your CFML engine installation or a sub-folder within that web root. Let's assume it's the web root of your current CFML Engine installation.

# Create a new directory and go into it.
mkdir mysite --cd
# Run the installer wizard
contentbox install-wizard

The wizard will take you by the hand and ask you all the relevant questions about your installation:

  1. Name of your site

  2. Which CFML Engine you will be running ContentBox on (Lucee5, Adobe 2018+)

  3. Password for the ColdBox HMVC Reinits

  4. Database of choice (MySQL5+, MSSQL, PostgreSQL, Oracle)

  5. Database credentials

  6. Development or production site

  7. Latest ContentBox version, specific or be bleeding edge

  8. Deploy a CommandBox server or not. This should be false, as we are only deploying our code to the CFML engine we have already installed.

Confirm your settings and the installer will configure the entire site for you including ORM dialects, environment variables and much much more.

Tip: You can use the `install --help` command and see how you can install ContentBox in an automated fashion with no user-interaction.

Web Installer

Now that we have installed ContentBox on disk and configured your CLI to connect to your database for delivering database migrations, we can finalize the installation via the web installer. Now open the installer by navigating to the root of the project. Let's assume you are running your CFML engine on port 8500:

http://localhost:8500

ContentBox will automagically create all the necessary database tables, indexes, and constraints for you. After it does this, it will present you with our ContentBox installer, where you will fill in:

  • Administrator Account

  • Site Information

  • Notification Emails

  • Email Information

  • URL Rewriting

  • Enjoy your ContentBox installation!

Caution: We recommend that after you install ContentBox that you remove the installer and data source wizard modules from the disk. You can do so manually or via the Dashboard once you log in. {Root}/modules/contentbox-installer and {Root}/modules/contentbox-dsncreator

​ is a ColdFusion (CFML) Command Line Interface (CLI), REPL, Package Manager and Embedded Server. We will leverage the CLI in CommandBox to install, deploy and configure ContentBox.

You can download CommandBox from the official site: and install it in your preferred Operating System (Windows, Mac, Unix).

CommandBox
http://www.ortussolutions.com/products/commandbox#download
https://docs.lucee.org/guides/cookbooks/datasource-define-datasource.html
https://helpx.adobe.com/coldfusion/configuring-administering/data-source-management-for-coldfusion.html
InstallationCommandBox : CLI, Package Manager, REPL & More
Installation Instructions
box shell
Logo