Onboard GitHub Enterprise (On-Prem)

Connect GitHub Enterprise Server repositories to Cortex Cloud.

Prerequisites

Cortex Cloud requirements

• User permissions: You need View/Edit permissions for Data Sources and Integrations. Use the AppSec Admin or Instance Administrator role
• Onboarding port: Allow port 443 for outbound HTTPS communication to Cortex Cloud. A Transporter uses port 443 for its WSS tunnel
• Egress path: Create an egress path for outbound data transmission from Cortex Cloud. Refer to Egress configurations
• Allow list: Add the applicable Reference B: Egress proxy IP addresses to your allow list

GitHub Enterprise requirements

• Organization permissions: You need Organization Owner permissions to install the Cortex application. Repository administrators require explicit organization approval to install GitHub Apps.
• OAuth scopes: Review Reference A: GitHub Enterprise OAuth scopes.

Onboarding steps

1. In Cortex Cloud, navigate to Settings → Data Sources & Integrations → + Add New.
2. Search for GitHub Self Managed (On-Prem) → Select Add or Add Another Instance.
3. Enter your domain in Configure Domain.
4. Optional: Select your Broker VM and Transporter applet.

   For setup details, refer to Transporter over Broker VM.
5. Select Register. Copy the Application Name, Homepage URL, and Authorization Callback URL.
6. In GitHub Enterprise, register a new OAuth application with those values. Copy its Client ID and Client Secret.
7. In Cortex Cloud, paste the client credentials and select Authorize.
8. Select the repositories to connect. Select Save, then Close.

Verify integration

1. On Data Sources & Integrations, search for GitHub Self Managed (On-Prem).
2. Select the instance and confirm its status is Connected.

Next steps

View repository assets and mitigate detected issues.

Manage the integration

Instance-level actions

1. Navigate to Settings → Data Sources & Integrations and search for GitHub Self Managed (On-Prem).
2. Select the matching result.
3. Locate your instance from the displayed list, right-click it, then select an option:

   • Edit instance: Opens the onboarding wizard, where you can change the instance configuration.
   • Delete instance: Deletes the instance and previous scan data.
   • Copy entire row: Copies all row values to the clipboard.

Repository-level actions

Right-click a connected repository to Set Scanned Branches, run a manual scan through Scan Repository, modify the Scan Configuration, or Remove Repository entirely. You can toggle specific scanners and manage PR behavior in Scan Configuration.

1. Locate your instance. See Verify integration above.
2. Select the instance. A list of connected repositories appears.
3. Right-click a repository, select the required action, then click Save.