GitHub Auth

First, you'll need to create a GitHub OAuth app for your organisation.

Creating a GitHub OAuth app

From GitHub, click on your profile picture and chose "Settings":

Step 1

Then "Developer settings" from the left-hand menu:

Step 2

Then "OAuth Apps":

Step 3

And create a new OAuth app:

Step 4

Give it a name, and a homepage URL. The authorization callback is the important bit. It needs to be in this form:

1[your-nx-cloud-url]/auth-callback 2 3# for example 4https://my.nx-enterprise.url:8080/auth-callback 5

Step 5

Once you create, keep a note of the Client ID:

Step 6

And then generate a new client secret, and save it somewhere secure (we'll use it in a bit):

Step 7

Configure Nx Cloud Installation

Using Helm:

1image: 2 tag: 'latest' 3 4nxCloudAppURL: '' 5 6github: 7 auth: 8 enabled: true 9 10secret: 11 name: 'cloudsecret' 12 nxCloudMongoServerEndpoint: 'NX_CLOUD_MONGO_SERVER_ENDPOINT' 13 githubAuthClientId: 'GITHUB_AUTH_CLIENT_ID' 14 githubAuthClientSecret: 'GITHUB_AUTH_CLIENT_SECRET' 15

Note that the secret must contain GITHUB_AUTH_CLIENT_ID and GITHUB_AUTH_CLIENT_SECRET ( see Nx Cloud Helm Charts for more context).

Not using Helm:

Provide the following env variables to the nx-cloud-frontend container:

Helm Chart Environment Variables

If you are using our Helm chart, you can find all the information you need about env variables in the Helm chart repository.

GitHub Enterprise

If you are running a self-hosted version of GitHub (Enterprise Server), you will need to configure one additional environment variable:


This will point all auth endpoints to your GitHub server (rather the public one).

Good to know!

The above environment variable, also helps with setting up the GitHub app integration, so you can have Nx Cloud build stats directly on your pull request. See full set up instructions here.