Overview

To build and run Payara Server, your environment must be set up with the following:

You can also optionally add the Maven bin folder to the PATH environment variable as well, and the documentation will assume that you have done so.

If using JDK 7, you will need to increase the heap size and PermGen size to prevent the build process from running out of memory.

Create a MAVEN_OPTS environment variable and set it as:

If using JDK 8, PermGen has been replaced by Metaspace, which can increase its maximum size on its own, so you only need to increase the heap size:

To download the Payara Server’s source code, open a terminal or Git Bash window, navigate to the directory you would like the source code to be downloaded to, and run git clone https://github.com/payara/Payara.git.

This will download the Payara Server’s source code, and initialize git, in a directory called Payara.

With your Git Bash or terminal window, navigate into the downloaded Payara directory, and run:

This will build Payara and run the integrated GlassFish unit tests. To save a bit of time, you can skip these tests by appending the skipTests flag to the install command like so:

Since release 164, Payara Micro is included as part of the default build. As it depends on modules of Payara Server, it can’t be built on its own. To build Payara Micro:

After the build has completed, the Payara Micro jar can be found in the target directory at:

Payara Microprofile is built as part of Payara Micro. To build Payara Microprofile, you can run:

Payara Microprofile can be found in its target directory at:

There are a number of additional Maven build profiles:

To save time on builds, you can also add the flag skipTests:

This will cut out all build tests so will save quite a bit of time.