nx/docs/nx-cloud/enterprise/single-tenant/custom-github-app.md

Custom GitHub App

Before creating your container, you'll need to create a GitHub app for your organisation.

Creating a GitHub OAuth app

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

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

Then "GitHub Apps":

And create a new GitHub app:

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

[your-nx-cloud-url]/callbacks/github-user

# for example
https://my.nx-enterprise.url:8080/callbacks/github-user

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

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

Configure Permissions for the GitHub App

The following permissions are required for Nx Cloud to work:

Repository permissions:

• Contents: Read & Write
• Pull requests: Read & Write
• Checks: Read Only
• Commit Statuses: Read & Write
• Issues: Read & Write
• Metadata: Read Only

Organization permissions:

• Administration: Read Only
• Members: Read Only

Connect Your Nx Cloud Installation

Provide the following values to your developer productivity engineer so they can help connect Nx Cloud to your custom GitHub app:

• Github App Client ID
• Github App Client Secret
• Github App App ID