Skip to content
Open
Show file tree
Hide file tree
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
Fixed review comments
  • Loading branch information
cbehera-newrelic committed Oct 30, 2025
commit 79b23fe3171428b39ca84b6e501dfce292e1b14b
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ You'll be able to configure your data selection preferences during the initial s
## Set up the GitHub integration

1. Go to **[one.newrelic.com > + Integration & Agents > GitHub integration](https://one.newrelic.com/marketplace/install-data-source?state=9306060d-b674-b245-083e-ff8d42765e0d)**.
2. Select **Github Enterprise Cloud** as your instrumentation method.
2. On the **Select an action** step, select **Set up a new integration**, and click **Continue**.
3. On the **Begin integration** screen:
a. To connect with your GitHub account, click **Get started in GitHub**. The New Relic Observability opens in the GitHub Marketplace.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,22 +90,22 @@ This integration streamlines the onboarding process for users and teams while si
<tr>
<td>`SERVER_SSL_KEY_STORE`</td>
<td>SSL Configuration</td>
<td>Path to the SSL keystore file for HTTPS configuration.</td>
<td>Path to the SSL keystore file for HTTPS configuration. See SSL certificate setup instructions below.</td>
</tr>
<tr>
<td>`SERVER_SSL_KEY_STORE_PASSWORD`</td>
<td>SSL Configuration</td>
<td>Password for the SSL keystore file.</td>
<td>Password for the SSL keystore file. This is the password you set when creating the PKCS12 keystore.</td>
</tr>
<tr>
<td>`SERVER_SSL_KEY_STORE_TYPE`</td>
<td>SSL Configuration</td>
<td>Type of the SSL keystore (e.g., PKCS12, JKS).</td>
<td>Type of the SSL keystore (e.g., PKCS12, JKS). Use PKCS12 when following the SSL setup instructions below.</td>
</tr>
<tr>
<td>`SERVER_SSL_KEY_ALIAS`</td>
<td>SSL Configuration</td>
<td>Alias for the SSL key within the keystore.</td>
<td>Alias for the SSL key within the keystore. This is the name you specify when creating the keystore.</td>
</tr>
<tr>
<td>`SERVER_PORT`</td>
Expand All @@ -115,6 +115,30 @@ This integration streamlines the onboarding process for users and teams while si
</tbody>
</table>

**SSL Certificate Setup Instructions**

To obtain an SSL certificate from a trusted Certificate Authority (CA) for HTTPS configuration, follow these steps:

1. **Generate a private key and a Certificate Signing Request (CSR)**:

```bash
openssl req -new -newkey rsa:2048 -nodes -keyout mycert.key -out mycert.csr
```

2. **Submit the CSR to your chosen CA**: Submit the `mycert.csr` file to your chosen Certificate Authority (e.g., DigiCert, Let's Encrypt, GoDaddy).

3. **Complete domain validation**: Complete any required domain validation steps as instructed by the CA.

4. **Download the certificate**: Download the issued certificate files from the CA (commonly a `.crt` or `.pem` file).

5. **Create a PKCS12 keystore**: Combine the certificate and private key into a PKCS12 keystore:

```bash
openssl pkcs12 -export -in mycert.crt -inkey mycert.key -out keystore.p12 -name mycert
```

6. **Use the keystore**: Use the generated `keystore.p12` file as the value for `SERVER_SSL_KEY_STORE` in your Docker configuration.

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 @@ -131,7 +155,7 @@ This integration streamlines the onboarding process for users and teams while si

**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.
You can download the Docker image directly from our [Docker Hub registry](https://hub.docker.com/repository/docker/newrelic/nr-ghe-collector/general) and run it using your organization's preferred CI/CD pipeline or deployment method.

4. **Access the New Relic UI**:

Expand Down