Deploy BuildVu with Payara and Payara Micro

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
    1. Payara
    2. Payara Micro
  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 Payara or Payara Micro
  2. Start your Payara server and navigate to the admin console in your browser
    • For example, the command
      ./bin/asadmin start-domain will start the server on port 8080, with the admin console on port 4848 - check the README.txt supplied with Payara for detailed instructions.
  3. On the home page, click on ‘Applications’ from the menubar on the left, then click ‘Deploy’.

  4. You should now be on the Deploy page as show below.
    1 You should enter the following values.
    The remaining options can be left as their default values or configured however you wish.
    • Upload the .war file you built earlier or Provide GlassFish with the path to it.
    • Set Type to ‘Web Application’.
    • Set a Context Root. If left empty, the default context root (usually the name of the .war file) will be used. For example, if your server is located at localhost:8080 and you’ve set the web app’s context root to buildvu-microservice, you can find it at localhost:8080/buildvu-microservice.
    • Set a Virtual Server - Make sure you have a server selected, or the web app will fail to deploy.
  5. Click OK and you’re done!

Payara Micro

Payara Micro offers a quick and simple method of deployment. You can start the micro-server on port 8080 and deploy the web app with a single line:

 java -jar payara-micro.jar --deploy /path/to/buildvu-microservice.war

This method uses the war file name as a default context path. For example, using the above command the converter could be reached at localhost:8080/buildvu-microservice. To check whether the server is working from a browser go to localhost:8080/buildvu-microservice/buildvu.


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.