Vagrant-powered development environment for the xTuple's open-source ERP software:
Ruby Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

Creating a Vagrant Virtual Development Environment

Vagrant is open-source software used to create lightweight and portable virtual development environments. Vagrant works like a "wrapper" for VirtualBox that can create, configure, and destroy virtual machines with the use of its own terminal commands. Vagrant facilitates the setup of environments without any direct interaction with VirtualBox and allows developers to use preferred editors and browsers in their native operating system. This blog describes a typical workflow using Vagrant in a development environment.

New to Github? Learn more about basic Github activities here.

Note: This document is for setting up a virtual environment on a Unix host. If you are using a Windows host, please use these instructions.

Install Vagrant

  • Download and install VirtualBox 4.3.12
    • Do not open VirtualBox or create a virtual machine. This will be handled by Vagrant.
  • Download and install Vagrant 1.6.4
    • Package managers like apt-get and gem install will install an older version of Vagrant so it is required to use the download page.

Fork the xtuple, fork xtuple-extensions, and fork xtuple-vagrant repositories on Github.

Clone your forks of the xtuple and xtuple-extensions repositories to a directory on your host machine:

host $ mkdir dev
host $ cd dev
host $ git clone --recursive<your-github-username>/xtuple.git
host $ git clone --recursive<your-github-username>/xtuple-extensions.git

Clone your fork of the xtuple-vagrant repository in a separate directory adjacent to your development folder:

host $ cd ..
host $ mkdir vagrant
host $ cd vagrant
host $ git clone<your-github-username-here>/xtuple-vagrant.git
host $ cd xtuple-vagrant

Important: If you have previously forked these repositories, please ensure that you update your fork and update your dependencies.

Setup Vagrant

  • In the Vagrantfile, ensure that the sourceDir variable to matches the location of the cloned xTuple source code: sourceDir = "../../dev"
    • This path should be relative to the location of the Vagrantfile

Install VirtualBox Guest Additions Plugin

vagrant plugin install vagrant-vbguest

Connect to the Virtual Machine

Start the virtual machine:

host $ vagrant up
  • Vagrant will automatically run a shell script to install git and the xTuple development environment

Connect to the virtual machine via ssh:

host $ vagrant ssh
  • The xTuple source code is synced to the folder ~/dev

Start the datasource:

vagrant $ cd dev/xtuple/node-datasource
vagrant $ node main.js

xTuple Mobile Web

Launch your local browser and navigate to application using localhost http://localhost:8888 or the static IP Address of the virtual machine

Default username and password to your local application are admin

xTuple Desktop Client

  • Obtain the xTuple Desktop Client Installer for your platform. To be sure the PostBooks Desktop Client version matches the PostBooks database version you are installing, look at the "About" information in the Mobile client.

  • Run the installer. On the screen where you select an xTuple database, select "I do not need a Free Trial database."

  • Complete the installation and launch the Desktop Client. On the login screen, enter these credentials to connect to your local xTuple server:

  • Username: admin
  • Password: admin
  • Server :
  • Port: 5432
  • Database: demo

Additional Information

Shutting down, restarting, and destroying your VM:

Basic commands