Snyk GitHub Server App
Release status and feature availability
The Snyk GitHub Server App is in Closed Beta. This feature must be enabled using a feature flag on the Group or Organization level. Contact Snyk support if you are interested in getting access.
The Snyk GitHub Server App is available to Snyk Enterprise plan customers. If you have a Legacy Business plan, contact Snyk support for access. See the Plans and pricing page for details.
This feature is not yet supported for Snyk Broker. As Snyk does not have static IP addresses, this integration will not work with IP Whitelisting in GitHub.
Prerequisites for GitHub Server App
A self-hosted instance of GitHub.
Snyk Organization Admin user role.
GitHub Organization Admin user role.
A public or private GitHub repository.
Users can install the app on GitHub Organizations they are Repository Admins on through the GitHub UI.
GitHub Server App benefits
The Snyk GitHub Server App improves on many features compared to the Snyk GitHub Enterprise integration, including role-based granular access control, increased API rate limits, and the creation of an entry point for expanded and enhanced developer experiences.
RBAC (Role-Based Access Control) Compliance: With the GitHub Server App, the access control mechanism is decoupled from individual user accounts. Instead, it is associated with the app entity itself. This separation allows for better management and enforcement of RBAC policies, as access control is handled at the application level rather than being tied to individual user accounts.
Granular access control: The GitHub Server App allows for fine-grained control over access permissions at the repository level.
Increased API rate limit: The GitHub Server App provides higher rate limits, allowing Snyk to make a larger number of API requests. This increased limit will assist in handling large-scale use cases, such as monorepos with a large number of Projects, GitHub organizations with a large number of repositories, and more.
Enabler for an enhanced developer experience:
Pull request checks: The Checks tab experience in GitHub is exclusively accessible through the GitHub Cloud App, enabling an SCM native experience as part of potential future PR check workflow improvements.
Fix and upgrade pull requests: Pull requests initiated by Snyk are performed directly by the GitHub App rather than a service account.
How to set up the Snyk GitHub Server App
Log in to your Snyk account and navigate to the Integrations section in the Snyk Organization where you would like to set up the GitHub Server App.
Select the GitHub Server App tile.
In the confirmation modal, select Configure GitHub Server App.
You'll be redirected to your GitHub instance in order to register the app. You can choose the name of the GitHub App that will be registered on your instance.
You are then asked to authorize the app to act on your user’s behalf. The app uses this information to check which GitHub organizations you are authorized to install the app in.
When the install screen in GitHub opens, you can select the GitHub organization where you wish to install the app.
If the GitHub Server App is already installed in a GitHub organization on your GitHub instance, you can select that same GitHub organization during the integration process for a different Snyk Organization.
Specify whether you wish to install the app in all or a select number of the repositories belonging to the selected GitHub organization, then click Install & Authorize.
The GitHub Server App will lose access to Snyk if it is uninstalled from the GitHub organization or if the repositories to which the app instance has access are edited.
How to migrate to the Snyk GitHub Server App
If you are an Enterprise plan customer, you can migrate Snyk Targets to the Snyk GitHub Server App using the snyk-migrate-to-github-app tool in the tool repository.
Feedback on the Snyk GitHub Server App
Because this feature is in Closed Beta, the functionality will likely evolve based on your feedback. If you would like to provide any feedback, contact your Account Manager or Snyk support.
Last updated
