xTuple Admin Guide

You will be prompted to log into GitHub with your username and password. This window will recommend that you generate a GitHub token, which is a string of characters that you can use as your password to log in to GitHub every time the xTuple Admin Utility (xTAU) needs to read a private repository.

To create a GitHub token, go to the GitHub website and log in. Locate the https://github.com/settings/tokens and select the option Generate New Token. You will be prompted to name your personal access token and define the access this token will have. When all of that is decided, a token will be generated. Copy the generated token to a safe place.

GitHub Personal Access Token

In the terminal, in the GitHub Username field enter in your username, make sure its just the handle not your email address, and your token in the GitHub Password field. Then select the Save Token option.

More settings and defaults will appear as the process continues. Accept and note the defaults as the process prompts you. Remember that you might need to TAB or use your right arrow key to select options to accept them. It is also likely that error screens will also pop up, but its ok to ignore these errors and continue on with the installation process.

Eventually you will land on a Success screen. Select Ok to proceed and you will be presented with the ERP's host, port number, username, password, domain, url, and other key information. Be sure to copy this information to a safe place.

The system writes a JSON configuration file as it goes, which you can pass as input to the program with the -c option. The following command gives a usage message:

./xtuple-utility.sh -h