Build Instructions

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.

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 unit tests. To save a bit of time, you can skip these tests by appending the skipTests flag to the install command like so:

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:

The source code of the Official Docker Images is also integrated in the main Payara repository. In order to be able to build these images, a Docker Client needs to be installed on the machine you execute the Maven command.

The Maven build expects that a regular build of Payara is already executed as it searches for some artifacts in the Maven repository (like SNAPSHOT builds of the server)

There are a number of additional Maven build profiles: