- App Store
On-site Installation of xTuple PostBooks Edition, client and server
xTuple offers two primary options for obtaining and using our business management software for free:
- Access xTuple Free Trial in the Cloud
- Install and run xTuple PostBooks Edition on-site
Commercial licenses for all xTuple Editions are available for both in the Cloud and on-site implementations.
xTuple Cloud Service
xTuple Cloud Service is the easiest way to begin using xTuple ERP. Sign up for a Free Trial and use a free hosted database for a limited time. Free Trial is the only way to:
- Test our value-packed premium offering, Enterprise Edition
- Test the first-ever on-the-go Mobile Web application, fully integrated with classic Desktop client
At the end of your Free Trial, you may subscribe to the paid xTuple Cloud Service, and we can continue to host it.
If you prefer to install and run xTuple PostBooks Edition, the free and open source software (FOSS), on your own machine, you need three things:
- PostgreSQL server
- xTuple PostBooks Edition database
- xTuple Desktop client
xTuple PostBooks Edition is a client-server application, where the database resides on a PostgreSQL server. To run it locally, you need the server, the database and the client.
How do I obtain components to setup xTuple PostBooks Edition for an on-site implementation?
Step 1: PostgreSQL Server
xTuple requires PostgreSQL, a powerful, open source object-relational database system, to operate. Before using xTuple ERP applications (Mobile Web and the classic Desktop), you must first install and properly configure PostgreSQL. For additional information and documentation on installing PostgreSQL, visit http://www.postgresql.org. If needed, contact xTuple for installation support.
EnterpriseDB, a third-party company that provides PostgreSQL products and services, offers free PostgreSQL installer packages for most common platforms.
NOTE: xTuple requires PostgreSQL version 9.1. Be sure to download and install version 9.1, not 9.2 or another version.
Links to download the EnterpriseDB installer for PostgreSQL version 9.1:
After downloading the installer, run it to install PostgreSQL 9.1 on your computer.
NOTE: xTuple applications require the PostgreSQL pgcrypto module used for credit card processing and storing other sensitive information. Be certain to include the pgcrypto module when installing PostgreSQL. If you do not, errors will be encountered when running xTuple ERP.
Step 2: xTuple PostBooks Edition database
The following steps are required to manually prepare your PostgreSQL server to run xTuple PostBooks Edition:
- Install and configure PostgreSQL (see above)
- Create the PostgreSQL database superuser 'admin' and the group 'xtrole' (see init.sql below)
- Create a new PostgreSQL database (Example: $ createdb -U admin production)
- Restore one of the xTuple starter databases into the new PostgreSQL database (Example: $ pg_restore -U admin -d production quickstart.backup -v)
init.sql: Creating the admin user and xtrole group
Run the following SQL script using either psql, pgAdmin or some other program that allows a direct connection to a PostgreSQL database server before creating your xTuple ERP database:
-- Begin init.sql
-- This script creates the group xtrole and the user admin
CREATE GROUP xtrole;
-- Create the user 'admin' with the password 'admin',
-- give it permission to create databases and users,
-- and place it in the xtrole group.
CREATE USER admin WITH PASSWORD 'admin'
IN GROUP xtrole;
-- End of init.sql
NOTE: Since the default password for the user admin is 'admin', change it immediately.
xTuple supplies three different databases for you to begin. All are available on the PostBooks project page at SourceForge.net:
- empty.backup — Empty database with no data, but with all the tables and structures created.
- quickstart.backup — Database with a basic Chart of Accounts and also the Account Assignments required to run the full range of transactions.
- demo.backup — Database contains a suite of sample data built on top of the 'quickstart' database.
Restore one of these databases to the server before you can connect with the client. For detailed instructions, see Installing the Database.
Step 3: xTuple Desktop Client
Obtain the xTuple Desktop Client Installer for your platform, (Be sure the PostBooks Desktop Client version matches the PostBooks database version you are installing.)
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 the data to connect to your local PostgreSQL server.
Username: If you installed one of the xTuple databases (demo, quickstart, or empty) your username will be "admin"
Password: If you installed one of the xTuple databases (demo, quickstart, or empty) your password will be "admin"
Server: The server name for local installations of PostgreSQL is "localhost"
Port: The default Port number for PostgreSQL is "5432"
Database: Enter the name of the database you want to connect to, e.g. "demo", "quickstart", or "empty".
Click the LOGIN button after you have filled in all the fields.
Need more information on connecting to PostBooks with the Desktop client? See Get Started with xTuple PostBooks Edition.