Install Dependencies

Switchboard uses Vagrant for cross-platform local setup, and Ansible for deployment. Vagrant requires Virtualbox to handle its virtual machines.

So, before setting up Switchboard you must install:

  • Virtualbox - tested on 4.3.15. Once installed, Virtualbox will ask if you want to set up a virtual machine. You can skip this; Vagrant will handle it.
  • Vagrant - tested on 1.6.3
  • Ansible - tested on 1.6.1

Setup Switchboard

Run the following at your shell to get a virtual machine up and running Switchboard. Once running, the virtual machine is assigned the IP address

git clone switchboard
cd switchboard
# Create a virtual machine, compile Switchboard, and start it up
vagrant up

## Using Switchboard from within the virtual machine:
# Login to the virtual machine
vagrant ssh
# To see the Switchboard service's options
service switchboard
# To connect a remote shell to the switchboard process
/home/vagrant/switchboard/_rel/switchboard/bin/switchboard remote_console


Ansible sometimes times out when fetching the Erlang .deb file. If this happens, please check your network connection and retry.

Please create an issue if there were any problems getting setup – we’d love to get you up and running.


Switchboard’s Ansible provisioning scripts can be used to deploy the application on remote servers. To provision a server it must be listed in an inventory file.

There is an example inventory file under provisioning/hosts.example. To customize, list the servers under the [switchboard] heading, and set custom variables under [switchboard:vars]. See provisioning/roles/switchboard/default/main.yml for a list of variables which can be customized.

Coming soon: Description of deploying from your own switchboard repo.

If your inventory is located at provisioning/hosts, you can provision switchboard by running:

ansible-playbook -i provisioning/hosts provisioning/playbook.yml

Next up: worker and client interfaces.