Getting Started

Slatwall is an extremely powerful and robust digital commerce management system. It is designed to work in a multitude of different business situations, and helps to centralize your commerce activity by integrating into existing systems. Slatwall easily operates as an eCommerce shopping cart for your website but it can also do a lot more like Inventory Mangement, Vendor Ordering, Subscription Management, etc.

It's important to note that these docs are part of the Slatwall core which means they get updated as new versions of Slatwall are rolled out.

If you have a question that can't be answered by these docs you can post it to the Slatwall Commerce Google Group where the community provides free support.  Slatwall is a professionally supported open source project, if you would like to get more infomation about our professional services and help with you project you can find more info at

Running Slatwall

There are a number of different ways to get up and running with Slatwall.  The table below provides the various ways to get up and running on Slatwall so that you decide what will work best for your situation.

Install Type Description & Instructions
Slatwall Quickstart
(Docker & Kitematic)

If you'd just like to explore the Slatwall tool on your own local machine, then the Docker Quickstart is a great way to get something up and running quickly.



Setup Instructions

  1. Open the Kitematic application that comes with Docker Toolbox
  2. Search for "slatwall"
  3. Choose ten24 - slatwall-quickstart
  4. Click "Create"
  5. Click the Settings tab in the top right
  6. Click on Hostname / Ports
  7. Find Port 8888 and copy the 5 numbers after localhost:
  8. Click back to Home and then lick the Launch icon next to Settings icon
  9. In the URL, after localhost: paste the 5 numbers you copied from Port 8888.
  10. Once Slatwall is set-up you should have a Slatwall screen with Set-up Super User form

IMPORTANT: The Docker Quickstart container includes both a Slatwall server running on Lucee/Tomcat and a MySQL database server both running on the same container.  Because of this it's not inteded to be used in production.

Install on CFML Engine

For CFML developers you can run Slatwall on your existing CFML infustructure.


  • CFML Server: Coldfusion 9.0.1+, Railo, Lucee 4.5+
  • Database Engine: MySQL, Microsoft SQL or Oracle
  • Operating System: Windows, Mac OSX, Linux


  1. Download the Slatwall application from github here:
  2. The file should be downloaded as a .zip file that you will need to unzip.
  3. Once the application is unzipped, place it in your web root and configure it to run either via IIS or Apache.
  4. Create a datasource called 'Slatwall' in your CFIDE or Railo administrator, and point it to a fresh database.
  5. Navigate to the site in your browser and follow the steps on the screen.

You may also want to view the Connection a Custom CFML App Tutorial which will guide you through the steps to connect Slatwall to your existing app.

CMS Integation Install If you have an existing Content Management System there are a number of CMS Plugins that will connect your frontend to a Slatwall backend.

Please review the CMS Download Instructions for CMS Specific install instructions.
Docker In Production

If you are comfortable with Docker and want to create a project that uses that Slatwall server we have a docker container that is ready to go and can be included in your project.


  • Docker
  • Database Container (MySQL, MS SQL or Oracle)

Please view the Slatwall Docker Repository for setup and configuration instructions.


Accessing The Slatwall API

Now that you have a Slatwall server running there are 3 simple ways to access the API programatically to accomplish any task.  Once you are farmilar with the 3 methodologies and selected the one that makes the most sense, you can visit the API Reference section which will provide code samples for all.

RESTFul API Slatwall comes with a fully functional RESTFul API that can be used to accomplish any task. Specific instructions on accessing the API can be found on the RESTFul API Reference Page.
Language SDK's In addition to the RESTFul API we've developed language specific SDK's that can be found on the Downloads page.
Native CFML If you are coding directly on the Slatwall Server, or have connected Slatwall to you own custom CFML project than you can use the CFML based SlatwallScope.

Updating Slatwall

Once you have Slatwall installed, it is important to keep it up to date with the latest releases.  This ensures that you are always up to date with any new features & functionality as well as security bugs that have been fixed.  The good news is that Slatwall makes this extreamly easy.

  1. Backup your Site Files & Database
  2. Log into the admin
  3. Navigate to Tools / Help >> Update Slatwall
  4. You will see the current version you are on as well as the available versions to update to
  5. From the dropdown you can select either the latest stable release, or latest bleeding edge release.  In addition you can also define a custom branch on github that you would like to update to by typing the name in.
    Version Description
    Stable This version should be used by all production sites.
    Bleeding Edge This version should only be used when testing on development server a new feature that is planned to be in a future release.
    Custom This should only be used by advanced users, and when explicitly asked to update to a custom branch from the support forums.
  6. Select the appropriate option and click the "Update" button.
  7. Be patient because this can take several minutes.  Once the action is complete you should be redirected to the main dashboard with an "Update Successful Message"
  8. You can verify that your version of Slatwall was updated by navigating to Tools / Help >> About and reviewing the version number


IMPORTANT DEVELOPER NOTE:  If you have made any changes to files in your slatwall instance that are outside of the "Update Safe" folders defined in the File Structure docs, there is a very high chance that those changes will be overridden so please take extream caution and always backup your work.  You should never need to make a change to Slatwall that is outside of the "Update Safe" folders.  If you don't know how to make your necessary customization inside the "Update Safe" folders, please post a question to the google group.

Questions & Comments