running locally

Jar

If you'd like to run it yourself the easiest way is to download and run the jar file. You can manually download the latest release from GitHub or run the following command from the command line to download:

wget $( curl https://api.github.com/repos/build-canaries/nevergreen/releases/latest | grep browser_download_url | head -n 1 | cut -d '"' -f 4 )

Then you can run the jar using the follow standard java jar command:

java -jar nevergreen-standalone.jar

Nevergreen runs on port 5000 by default.

Environment variables

• PORT
• AES_KEY
• ALLOW_IFRAME_FROM

PORT

This changes the port Nevergreen listens on and can be set to any valid port number.

PORT=4000 java -jar nevergreen-standalone.jar

AES_KEY

If you are using authentication with your CI server, it is strongly recommended to override the default AES key that Nevergreen uses to encrypt your passwords.

The key must be 16 characters (128bits).

AES_KEY=thisisa128bitkey java -jar nevergreen-standalone.jar

ALLOW_IFRAME_FROM

If you want to use Nevergreen via an <iframe> then you need to whitelist the hosts which will be using Nevergreen via an iframe. Once this environment variable is set it will be returned in the content-security-policy as the value of frame-ancestors

ALLOW_IFRAME_FROM=192.168.100.115:8000 java -jar nevergreen-standalone.jar

This will change the http headers to change frame-ancestors to your value:

content-security-policy: default-src 'self'; .......; frame-ancestors '192.168.100.115:8000'

More advanced installations

Docker

You can also run locally by using Docker. The Nevergreen dockerfile is also available on Dockerhub.