Fork me on GitHub


Installing Fusebox

When installing Fusebox, the most important question is where do you want your fusebox core files as well as the supporting files from the skeleton to be placed in your directory structure?

Within the skeleton archive, there are a number of files and directories that are required for fusebox to work. If you are interested in the skeleton application and want to know more about it, you can read a brief discussion of the directory structure.

There are several alternatives to installing the core files and the skeleton files. One caveat is that unless you are creating a mapping (both ColdFusion and web) the core files can be placed in the following areas:

  • In a shared directory that several applications can share. (This will require a web site mapping)
  • Within an application and inside the web root (Some shared servers only give you the web root).
  • Within an application, but above the web root.

Note that you may not place the core files on a network drive. The core files must be on the same physical computer that your application resides on.

Depending on your application, your server and your hosting situation, you might at some time want to use fusebox in any or all of these scenarios.(An image of the file directory structure is shown beside each scenario. Click on the thumbnail to bring a larger image up in a new window.)

Installing to a Shared Directory

This is probably the simplest installation. The purpose of this installation is to allow multiple fusebox applications on the same host to share the same set of core files. This works fine when you have total control over your environment and upgrades are easily done across the board. This setup requires that the skeleton directory needs to be individually extracted into every application. (Sorry, the skeleton files are per application and are not shareable.

To install, simply copy the fusebox5 subdirectory to your application server and create a virtual directory called /fusebox5 in your web server environment. We will access these files when setting up Fusebox in the next section.

Installing within your Web Root

On some host environments, you are given access to the web root and thats it. Depending on your coding preferences, you can place the fusebox5 directory in the zip file anywhere in the web root.

Scenario 1

You like a flat environment. Everything as flat as possible. (Definitely not me). In this case, your skeleton directory and your fusebox 5 directory are unzipped directly in your web root directory.

Scenario 2

I prefer things a bit tidier so all Fusebox related items are placed in their own subdirectory "FBCore". The only files that remain in the web root itself are "index.cfm", "Application.cfm" and "onRequestEnd.cfm" as well as any directories which contain files which your web server needs access to (such as images, css and javascript) and your circuits and their accompanying fuses. All other files and subdirectories that are part of the skeleton are placed within the FBCores subdirectory. (You may of course call this subdirectory anything you wish).

Installing above your web root (Fusebox related files only)

Scenario 3

Again, for the flat environment lovers, your "index.cfm", "Application.cfm" and "onRequestEnd.cfm" go in your web root (as will any css, javascript and images). Also below the web root will go your actual application files (ie, the Controller, Model and View directories)

Scenario 4

Basically this is a replay of Scenario 2 with nice clean directories. Again, this time your ColdFusion scripts for your application are in the web root.

Scenario 5

For those of us who want as little in the web root as you can get away with, you can move all your ColdFusion scripts above the web root as well. Note that I place them in a subdirectory called "Scripts"