BC Wilson edited this page Feb 8, 2017 · 7 revisions

So, you want to set up a web-enabled xTuple database server? The xtuple-admin-utility is the tool you need!

First, let's clarify what we mean by "web-enabled." Not all xTuple database servers are web-enabled. In a standard (non-web-enabled) xTuple installation you only need a PostgreSQL database server and a desktop client. You can learn how to set up a standard xTuple database server at our PostBooks Getting Started page.

If, on the other hand, you would like to connect to your xTuple database with a web browser such as Firefox or Chrome, or if you'd like to take advantage of our REST API, you will want to install a web-enabled database server.

The xtuple-admin-utility

To help manage the additional complexity of a web-enabled server, we provide the xtuple-admin-utility, a toolkit that provides methods for installing the stack, setting up and managing individual databases, making backups, and more. The application stack of a web-enabled xTuple database server includes PostgreSQL, Node (a javascript-based web-server), nginx, and associated code that creates the web components and the REST API.

There are two main sections to this wiki. The first is the Database Administrators (DBAs) Guide who will be installing and running a web-enabled xTuple database server. The DBA section explains how to use the xtuple-admin-utility to install and maintain your web-enabled databases.

The other section is for developers[Coming soon]. The developer section shows how to set up a web-enabled development environment so that you can modify code and contribute back to the xTuple repositories on github.

Give us your feedback

We are always working to make the database administrator's tasks as easy and efficient as possible, so we will be adding features and functions as we continue to develop this tool. If you find bugs or have suggestions for features, please use the issues section of this github repository to let us know.