Deploy BuildVu with GlassFish

Table of contents

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

Compatibility Warning

Glassfish 6 has moved from using JavaEE to using JakartaEE. As it no longer supports JavaEE packages you will need to use Glassfish 5.

As of January 2021, GlassFish 5 is not compatible with Java 10 or higher. If you are using Java 10 or higher, you will need to configure the server to use a Java 9 or lower SDK.

To do so, navigate to /glassfish/config/ and change the following:


asenv.bat - Add "set AS_JAVA=PATH\TO\JDK.jdk"
For example: "set AS_JAVA=C:\Program Files\Java\jdk1.8.0_172.jdk"


asenv.conf - Add "AS_JAVA=/PATH/TO/JDK.jdk"
For example: "AS_JAVA=/Library/Java/JavaVirtualMachines/jdk1.8.0_172.jdk"

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 GlassFish. You can use either the Web Profile or the Full Platform. (Versions tested: 4.X, 5.0)
  2. Start GlassFish and navigate to the admin console in your browser.
    • For example, the command glassfish5/glassfish/bin/asadmin start-domain will start the server on port 8080, with the admin console on port 4848 - check the README.txt supplied with GlassFish 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!

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.