This guide covers the installation of Gradle Enterprise using a pre-configured and ready-to-go virtual machine, and how to quickly start using build scans and the build cache with a sample project that is pre-configured to use your installation.

Installation

During the installation you will need your trial license file and trial VM image that you have downloaded from your personal trial page. If you have not done this yet, you should do so now.

You can find the link to your personal trial page in the email you will have received when you signed up for the trial. If you have not yet started a trial of Gradle Enterprise, start it today.

The provided virtual machine image is an OVF (Open Virtualization Format) file. It will work with any virtualization provider that supports the OVF standard. Oracle VirtualBox is a free virtualization provider for Mac OS, Windows and Linux that supports OVF. The following are instructions for installing Gradle Enterprise via Oracle VirtualBox.

  1. Install and launch VirtualBox.

    1. Download VirtualBox from https://www.virtualbox.org/wiki/Downloads

    2. Run the VirtualBox installer, and complete installation

    3. Launch VirtualBox

  2. Select File > Import Appliance, and select the *.ova trial image you downloaded previously. Accept the default settings during import.

  3. Start the VM and wait until it shows as Running and the login prompt has appeared in the VM window. You can choose a Headless Start if you prefer not to see a window for the VM.

  4. Open a web browser and navigate to https://localhost:8800 to access the Gradle Enterprise admin console.

    Due to the Gradle Enterprise admin console being configured with an unsigned certificate by default, the first time you visit the admin console your browser will show you an SSL certificate warning. You should follow the browser’s instructions to proceed in order to access the admin pages. It is recommended to install a signed certificate when using Gradle Enterprise in production.
  5. Select Choose License, and select the *.rli trial license you downloaded previously.

    install license
  6. Select Dashboard from the navigation menu to see the current status of the application. You should see a screen like the one below once the application has completed installation and the server has successfully started.

    install dashboard

Gradle Enterprise is now ready!

Try it out

Download the starter project ZIP file and unpack it.

This is a Gradle project configured to publish build scans to your Gradle Enterprise installation and use its build cache. Simply run ./gradlew build inside the project on your command line and open the link displayed at the end of the build to view your build scan.

View the project’s README.md file for what else you can do with it.

Sharing your installation

The virtual machine image is pre-configured to use network address translation (NAT) networking by default. Gradle Enterprise is accessible via ports that are forwarded from the host to the guest VM. This makes it easy to access Gradle Enterprise via http://localhost:8180, on your machine.

If you wish to share your installation with others, you need to configure Gradle Enterprise with the public IP address or hostname of your machine. You can do this by accessing http://localhost:8800/settings and updating the Hostname setting. Others can then access your installation via this hostname.

Next steps

Now that you have Gradle Enterprise up and running, follow the Getting Started with Gradle Enterprise guide to configure your own projects to work with Gradle Enterprise and to learn more about its features.

Getting help

If you require assistance with the installation, or with using Gradle Enterprise during your trial, please get in touch with us by sending an email to enterprise-support@gradle.com.