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

GitHub App

The GitHub App method offers a streamlined way to connect an OX platform account to GitHub. This method uses an application created by OX Security, which simplifies the connection process.

When using this method, you install the OX GitHub app into your GitHub organization. The app is granted permissions to access your GitHub data, allowing the OX platform to interact with your repositories. For details about the permissions requested by the app and how they are used, see OX GitHub App Permissions.

The following process describes the OX-generated GitHub App configuration. In addition to the OX-generated option, which is the recommended option, you can define a self-hosted GitHub App configuration.

To connect with GitHub App:

  1. In the OX platform, go to Connectors and select GitHub > GITHUB APP.

  1. Select CONNECT. You are automatically redirected to the source control system’s authentication dialog.

  2. Login to GitHub. The Install OX Security dialog appears with the list of organizations that you have defined on GitHub.

  1. Select the organization with which you want to set up the GitHub-OX integration.

  1. In the Install & Authorize OX Security dialog, select as follows:

  • All repositories: Grants OX GITHUB APP permissions to all the GitHub repositories within the selected GitHub organization.

  • Only select repositories: Select GitHub repositories to which you want to grants OX GITHUB APP permissions within the selected GitHub organization.

  1. Select Install & Authorize. The connection is established and you are redirected back to OX Security, where the list of all the repositories that participate in the integration appears.

  1. Select the repos you want to scan and click SAVE.

  2. (optional) Select branches you want to scan within the selected repos.

  3. (optional) To connect more GitHub accounts to the same organization in the OX platform, select Add another GitHub App +, add the app and select CONNECT.

What's Next?

After connecting GitHub to OX using app, you can integrate OX with your CI/CD pipelines to automate scanning and report results to pull requests.

OX supports multiple pipeline integration methods, including GitHub App integration, webhook-based integrations, and direct CI/CD integrations.

Last updated