You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/service-architecture-intelligence/github-enterprise-integration.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ This integration streamlines the onboarding process for users and teams, simplif
25
25
* Docker environment to run the collector service within your GHE network.
26
26
27
27
28
-
**Architecture Overview**
28
+
**Architecture overview**
29
29
30
30
Data collection from your GHE environment uses a collector service deployed within your private network to circumvent enterprise firewalls.
31
31
@@ -35,14 +35,14 @@ Data collection from your GHE environment uses a collector service deployed with
35
35
36
36
**To set up the GitHub Enterprise integration:**
37
37
38
-
1.**Create and Configure a GitHub App**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**.
38
+
1.**Create and configure a GitHub app**: In your GHE instance, navigate to **Settings → Developer Settings → GitHub Apps → New GitHub App**.
39
39
40
40
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.
41
41
2.**Set Up Webhooks**: Configure the Webhook URL (which we will provide) and create a custom Event Secret for secure communication.
42
42
3.**Install the App**: Install the created GitHub App on the relevant GHE organizations that you want to integrate with New Relic.
43
43
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.
44
44
45
-
2.**Prepare Environment Variables**: Before deploying the collector service, gather the following information:
45
+
2.**Prepare environment variables**: Before deploying the collector service, gather the following information:
46
46
47
47
<table>
48
48
<thead>
@@ -86,7 +86,7 @@ Data collection from your GHE environment uses a collector service deployed with
86
86
</tbody>
87
87
</table>
88
88
89
-
3.**Deploy the Collector Service**: The collector service is delivered as a Docker image. Deployment can be done in one of two ways:
89
+
3.**Deploy the collector service**: The collector service is delivered as a Docker image. Deployment can be done in one of two ways:
90
90
91
91
**Option A: Using Docker Compose (Recommended)**
92
92
@@ -99,7 +99,7 @@ Data collection from your GHE environment uses a collector service deployed with
99
99
docker-compose up -d
100
100
```
101
101
102
-
**Option B: Direct Docker Image Run**
102
+
**Option B: Direct Docker image run**
103
103
104
104
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.
0 commit comments