Ctrlk
Book a demoOX Security
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Self-Hosted GitHub App

You can connect OX to GitHub using a dedicated GitHub App created for your GitHub organization. OX automatically creates the GitHub App with the permissions and URLs required for the integration, so you do not need to manually configure the app in GitHub.

You can use this connection method with GitHub.com or GitHub Enterprise Server.

If your GitHub Enterprise Server instance is not reachable from the public internet, configure the OX Broker so that OX can communicate with your GitHub server.

Prerequisites

Before you begin, make sure you have:

Requirement
Description

GitHub access

Permissions to create and install a GitHub App for the GitHub organization you want to connect.

GitHub URL

The URL of your GitHub environment. For GitHub.com, use https://github.com. For GitHub Enterprise Server, use the base URL of your GitHub server.

GitHub organization

The GitHub organization containing the repositories you want OX to scan.

OX Broker

Required if your GitHub Enterprise Server instance cannot be reached from the public internet.

Note: If your GitHub environment is not hosted on github.com or a GitHub data residency domain (*.ghe.com), contact OX Technical Support before connecting. Additional configuration is required on the OX side before you can complete the connection.

Connect a self-hosted GitHub App

  1. In OX, go to the Connectors page.

  2. Under Source Control, select GitHub.

  3. Select the Self-Hosted GitHub App tab.

  1. Enter the connection details:

Field
Description

GitHub Host URL

Enter https://github.com or the base URL of your GitHub Enterprise Server.

GitHub organization

Enter the GitHub organization where you want to create the app. Creating the app under an organization helps ensure that the integration remains available if individual users change.

Connection Name

The name used to identify the connection in OX. OX automatically provides a name, which you can change if needed.

  1. Select Connect.

GitHub opens the Create GitHub App page. OX provides the configuration required to create the app, including its permissions and URLs.

  1. In GitHub App name, enter a name for the app or use the name provided by OX.

  2. Select Create GitHub App for <organization>.

    The GitHub App is created with the permissions required by OX. You do not need to configure the repository and organization permissions manually.

  1. On the Install & Authorize page, select which repositories OX can access:

  • All repositories: Grants the app access to all current and future repositories in the organization.

  • Only select repositories: Grants the app access only to repositories you select.

  1. Select Install & Authorize.

    After authorization, you are redirected to OX.

  2. In the Configure your GitHub connector window, select the repositories that you want OX to monitor and scan.

  1. To automatically include repositories created in the future, select Monitor all newly created repos.

  2. Select Save.

The GitHub App is now connected to OX.

Last updated