Skip to content

Commit a6a4ea2

Browse files
wip
1 parent 52f149b commit a6a4ea2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/content/docs/service-architecture-intelligence/github-enterprise-integration.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This integration streamlines the onboarding process for users and teams, simplif
2525
* Docker environment to run the collector service within your GHE network.
2626

2727

28-
**Architecture Overview**
28+
**Architecture overview**
2929

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

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

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

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**.
3939

4040
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.
4141
2. **Set Up Webhooks**: Configure the Webhook URL (which we will provide) and create a custom Event Secret for secure communication.
4242
3. **Install the App**: Install the created GitHub App on the relevant GHE organizations that you want to integrate with New Relic.
4343
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.
4444

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:
4646

4747
<table>
4848
<thead>
@@ -86,7 +86,7 @@ Data collection from your GHE environment uses a collector service deployed with
8686
</tbody>
8787
</table>
8888

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:
9090

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

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

102-
**Option B: Direct Docker Image Run**
102+
**Option B: Direct Docker image run**
103103

104104
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.
105105

0 commit comments

Comments
 (0)