Skip to content

Commit

Permalink
GITBOOK-8498: NE - GitHub Server App: remove public docs and references.
Browse files Browse the repository at this point in the history
  • Loading branch information
TashaTBaker authored and gitbook-bot committed Nov 19, 2024
1 parent 3df7839 commit 2beb4de
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 112 deletions.
1 change: 0 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,6 @@
* [GitHub Enterprise](scm-ide-and-ci-cd-integrations/snyk-scm-integrations/github-enterprise.md)
* [GitHub](scm-ide-and-ci-cd-integrations/snyk-scm-integrations/github.md)
* [GitHub Cloud App](scm-ide-and-ci-cd-integrations/snyk-scm-integrations/github-cloud-app.md)
* [GitHub Server App](scm-ide-and-ci-cd-integrations/snyk-scm-integrations/github-server-app.md)
* [GitHub Read-only Projects](scm-ide-and-ci-cd-integrations/snyk-scm-integrations/github-read-only-projects.md)
* [GitLab](scm-ide-and-ci-cd-integrations/snyk-scm-integrations/gitlab.md)
* [Bitbucket Cloud](scm-ide-and-ci-cd-integrations/snyk-scm-integrations/bitbucket-cloud.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ Snyk Source Control Manager (SCM) integrations allow you to:
Snyk can integrate with the following SCMs to help you track, monitor, and fix the issues and vulnerabilities in your code:

* [GitHub Cloud App](github-cloud-app.md)
* [GitHub Server App](github-server-app.md)
* [GitHub Enterprise](github-enterprise.md)
* [GitHub](github.md)
* [GitHub Read-only Projects](github-read-only-projects.md)
Expand Down Expand Up @@ -156,7 +155,6 @@ See the following for detailed permission requirements:

* [GitHub and GitHub Enterprise](./#github-and-github-enterprise-permissions-requirements)
* [GitHub Cloud App](./#github-cloud-app-permission-requirements)
* [GitHub Server App](./#github-server-app-permission-requirements)
* [GitLab](./#gitlab-permission-requirements)
* [Bitbucket](./#bitbucket-permission-requirements)
* [Azure Repositories (TFS)](./#azure-repositories-tfs-permission-requirements)
Expand Down Expand Up @@ -210,20 +208,6 @@ The following table states the required GitHub App permissions and scopes:

<table><thead><tr><th width="191">Action and scope</th><th width="254">Scope</th><th>Level</th><th>Permission</th></tr></thead><tbody><tr><td>Determine if the GitHub user has admin role on the GitHub org, to restrict app installation reuse to only admin users</td><td>Members</td><td>Organization</td><td>Read</td></tr><tr><td>Search repositories, and access repository metadata.</td><td>Metadata</td><td>Repository</td><td>Read</td></tr><tr><td>Interact with the GitHub Checks tab</td><td>Checks</td><td>Repository</td><td>Read and write</td></tr><tr><td>Create commits and branches</td><td>Contents</td><td>Repository</td><td>Read and write</td></tr><tr><td>Send PR check results as commit statuses</td><td>Commit status</td><td>Repository</td><td>Read and write</td></tr><tr><td>Get pull requests details, post related comments (next gen PR experience)</td><td>Pull request</td><td>Repository</td><td>Read and write</td></tr><tr><td>Manage webhooks which trigger the PR checks</td><td>Repository hooks</td><td>Repository</td><td>Read and write</td></tr></tbody></table>

### GitHub Server App permission requirements

{% hint style="warning" %}
To utilize the Snyk GitHub Server App you must be using a self-hosted instance of GitHub.
{% endhint %}

The [Snyk GitHub Server App](github-server-app.md) uses role-based access control, meaning access control is not dependent on individual users or their role, it is instead tied to the app entity.

To set up the GitHub Server app integration you must be a:

* Snyk Organization Admin.
* GitHub Organization Admin.
* GitHub Repository Admin (if installing through the GitHub UI).

### GitLab permission requirements

The [Snyk GitLab integration](gitlab.md#gitlab-access-tokens) uses either a personal access token (PAT) or group access token (GAT), depending on the GitLab account tier you are on.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
{% hint style="info" %}
**Release status**

The GitHub Cloud App is in Early Access. This feature is not supported for Snyk Broker.

If you are using a self-hosted instance of GitHub, you must use the [GitHub Server App](github-server-app.md).
The GitHub Cloud App is in Early Access. This feature is not supported for Snyk Broker or self-hosted instances of GitHub.

As Snyk does not have static IP addresses, this integration will not work with IP allowlisting in GitHub.
{% endhint %}
Expand Down

This file was deleted.

0 comments on commit 2beb4de

Please sign in to comment.