Linicks edited this page May 13, 2013 · 11 revisions



This short guide will help you get Chicago Boss installed and working on your system. Chicago Boss generally isn’t installed to global system path like (/usr/local etc.). Typically, Chicago Boss will be copied to a development directory in your path, for example: (/home/your_account/cboss_dev).

Chicago Boss Requirements

Chicago Boss is written in the Erlang programming language, so naturally you will need to install it on your system.

You will need Erlang OTP R14A or later:

  • The official packages can be found here
  • Many Linux and BSD distributions come with pre-build packages for Erlang, and can be installed through their package management systems. It may be beneficial to use their packages because the packagers generally tweak the Erlang installation to work around bugs and other improvements. However, this isn’t always the case, and the official packages may be the best starting point to work from.
  • Staying Current: In some cases, using the official packages are the best/only way to stay current with the latest improvements made to Erlang OTP. Generally speaking, it’s best to stay up with the newest production version if possible, but be cautious because some libraries may not work with it.
  • On Windows Vista or Windows 7 -
    • you need install win openSSl (
    • make mochiweb with msys or cygwin
  • On all windows
    • Download and build rebar(, then add it to your path and use it instead of the version included with ChicagoBoss.
  • If Erlang OTP is already installed, you can launch it by typing erl in a terminal window.
  • You can verify the installed version by typing following command in the Erlang Shell erlang:system_info(otp_release).

Download a Chicago Boss Release

Download the latest code or a release from the website

Compile It

Build Chicago Boss with


Generate API docs

To generate the latest documentation of API calls localy:

cd /path/to/ChicagoBoss-x.y.z
make edoc
cd doc/

You should see api.html, api-controller.html, etc

Generate A Project

To create a project in the parent directory, simply type

make app PROJECT=my_new_project

(Project names must start with a lowercase letter.) Then cruise over to it and start up the server:

cd ../my_new_project

(On Windows, execute start-dev.bat instead of

There will be a lot of PROGRESS REPORTs which look scary but hopefully everything is running smoothly. With this console you can interact directly with the running server.


Point your browser to http://localhost:8001/

If all is well you will see a forbidding error message about the requested template — not to worry, the new project is empty so there is nothing to serve!

Next steps: