xTuple Admin Guide

All setups assume that you will be using vagrant to manage a guest VM on your local machine. Vagrant 1.9.x is known to work, while version 2.0.0 has been inconsistent. There is currently no documented method for installing xTC on an independent server. If you need to set up xTupleCommerce on a machine not managed by vagrant, you will need to install all the prerequisites that the vagrant box includes. [For more information, see https://github.com/xtuple/xdruple-server/tree/master/scripts which contains scripts that install the required components.]

The instructions in this document are for setting up xTupleCommerce. You need a separate installation of xTuple ERP to which you can connect your xTupleCommerce site. The ERP site must be web-enabled and must include the following packages:

(Follow the instructions in Chapter 3, Section 4, Installing Other Extensions to install these packages.) The ERP must be set up first and you must have admin access to the web client so that xTupleCommerce can connect to the REST API.

To prepare for working in GitHub, the following two security steps will make it easier to access private repositories.

Create a GitHub access token if you don’t already have one: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/. Keep a copy of that key somewhere safe, as you will need it later.

Generate an ssh key and add it to the ssh-agent on the host to allow for easier ssh communication with git.

Create a directory on the host machine where you will clone all of the needed git repositories. This is ~/Code by default, but you can actually place it anywhere and give it any name you want. Make a note of the directory name and location if you use something different.

Create a subdirectory of Code called Drupal7, which is where all xTupleCommerce sites (called "projects") will be placed on the host machine.

The default Drupal 7 project directory suffix is .xd (e.g., example.xd). You can use another suffix but you must be consistent.