INSTALL.md

Installing Houston

Needed Services

To setup Houston you will need a working node environment. Each operating system is different, so it's best to refer to the official node documentation on installing.

NOTE If you are only wanting to run the worker process for houston ci or houston build, you only need to install Docker. If you install Docker on the same machine as Houston, you should need no additional configuration.

For a fully working installation you will want to ensure all of these services are setup, working, and fully accessible to Houston.

You will need:

• A Knexjs supported database
• An Aptly repository
• A local Docker server
• A GitHub OAuth application
• A Stripe connect account
• A Mandrill account

Package

Simply run npm i -g @elementaryos/houston.

NOTE: Depending on how you installed node, you may have to run the above command with sudo.

Source

First, git clone this repo.

Next you will need to install the needed node packages. This is done with:

npm ci

Then build Houston with:

npm run build

Then install it with:

npm link

NOTE: Depending on how you installed node, you may have to run the above command with sudo.

You will need to setup your configuration. Simply copy the config.example.js file to another location and edit it's values. This file is well documented with possible values and links to needed third party services.

Lastly, you can run houston with:

houston

For a full list of commands run:

houston --help