This project is a self-hostable application that provides a dashboard for build statuses. In order to facilitate self-hosting, the application is designed to work in Cloud Foundry.

The application stores its internal data model in a PostgreSQL database. This database needs to be provisioned before the application is started, but the application manages the creation and modification of the schemas itself so no other setup is needed. Since the application is designed to work in Cloud Foundry, it is highly recommended that you use a database-as-a-service provided by Cloud Foundry.

The application is written in Java and packaged as a self executable JAR file. This enables it to run in anywhere that Java is available. Building the application (required for deployment) requires Maven.

The application uses WebSockets to keep itself up to date while running. In order to take advantage of this, you need to use a WebSockets capable browser. To find out if your browser is WebSocket capable check caniuse.com.

The following instructions assume that you have created an account and installed the cf command line tool.

In order to automate the deployment process as much as possible, the project contains a Cloud Foundry manifest. To deploy run the following commands:

mvn -Dmaven.test.skip=true package
cf push

Once the deployment has completed the the application will be available on https://<host>:4443/.

The project is set up as a Maven project and doesn't have any special requirements beyond that.

The project is released under version 2.0 of the Apache License.