Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
wip
  • Loading branch information
cbehera-newrelic committed Oct 16, 2025
commit a6a4ea266d89e0fb3f9ecf87475f568ce1f44212
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This integration streamlines the onboarding process for users and teams, simplif
* Docker environment to run the collector service within your GHE network.


**Architecture Overview**
**Architecture overview**

Data collection from your GHE environment uses a collector service deployed within your private network to circumvent enterprise firewalls.

Expand All @@ -35,14 +35,14 @@ Data collection from your GHE environment uses a collector service deployed with

**To set up the GitHub Enterprise integration:**

1. **Create and Configure a GitHub App**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**.
1. **Create and configure a GitHub app**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**.

1. **Configure Permissions**: Set the specific permissions required for the app to perform real-time and initial data syncs. A separate document outlining the required permissions will be provided.
2. **Set Up Webhooks**: Configure the Webhook URL (which we will provide) and create a custom Event Secret for secure communication.
3. **Install the App**: Install the created GitHub App on the relevant GHE organizations that you want to integrate with New Relic.
4. **Generate Keys**: Upon creation, the app will generate a unique App ID and a Private Key file (.pem format). Save these securely as they will be needed for the collector service configuration.

2. **Prepare Environment Variables**: Before deploying the collector service, gather the following information:
2. **Prepare environment variables**: Before deploying the collector service, gather the following information:

<table>
<thead>
Expand Down Expand Up @@ -86,7 +86,7 @@ Data collection from your GHE environment uses a collector service deployed with
</tbody>
</table>

3. **Deploy the Collector Service**: The collector service is delivered as a Docker image. Deployment can be done in one of two ways:
3. **Deploy the collector service**: The collector service is delivered as a Docker image. Deployment can be done in one of two ways:

**Option A: Using Docker Compose (Recommended)**

Expand All @@ -99,7 +99,7 @@ Data collection from your GHE environment uses a collector service deployed with
docker-compose up -d
```

**Option B: Direct Docker Image Run**
**Option B: Direct Docker image run**

You can download the Docker image directly from our Docker App registry and run it using your organization's preferred CI/CD pipeline or deployment method.

Expand Down