Deploy BuildVu with Jetty

Table of contents

  1. Download or Build the WAR file
    1. Download the WAR file
    2. Build the WAR file
  2. Deploying the web app
  3. Usage

Download or Build the WAR file

Before getting started you need the WAR file which you can either download or build yourself.
This WAR file is required for the BuildVu service to work.

Download the WAR file

For trial users:

  1. If you haven’t already, sign up for BuildVu trial.
  2. Open the email you receive when you signed up.
  3. Follow the download link found in the Docker section.

For customers:

  1. Visit the Customer download page.
  2. Click on ‘Download Latest Customer WAR’.
  3. Submit your username and password.

Build the WAR file

Build a copy of our BuildVu Microservice Example project.
Instructions can be found on the GitHub page.

Deploying the web app

  1. Download and install the latest version of Jetty.
  2. In the downloaded Jetty directory, navigate to the webapps folder and place the war file into that directory. The name of the war file will be the base of your web app. For example, if the webserver is hosted at localhost:8080, buildvu-microservice.war will be deployed at localhost:8080/buildvu-microservice.

  3. You also need an endpoint to serve static files produced through the conversion. To do this, we have a jetty-static.xml in buildvu-microservice-example/lib. Copy/Move jetty-static.xml to {Jetty directory}/webapps/ which will automatically configure this for you.

  4. Start the Jetty server and navigate to the admin console in your browser.
    java -jar start.jar will start the server on localhost:8080

You can check if the web app has successfully deployed by navigating to its URL in your browser - you should see a blank white page with BuildVu Microservice Example written in the centre.


You can interact with the BuildVu Microservice Example using the REST API (See the GitHub page for details).

For specific languages, see our tutorials.

Still need help? Send us your questions.