You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add information to GitHub Connections for allow lists (#3094)
* First draft
* Clean up
* Add information about instance IPs
* Clean up again
* Update
* Added link to documentation, rearrange to make the limitiation of the github app registration stand out
* Fix trailing white space
Copy file name to clipboardExpand all lines: src/pages/docs/projects/version-control/github/index.md
+12-5Lines changed: 12 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
layout: src/layouts/Default.astro
3
3
pubDate: 2024-03-14
4
-
modDate: 2024-11-07
4
+
modDate: 2026-04-13
5
5
title: GitHub integration
6
6
description: Octopus Deploy GitHub integration
7
7
icon: fa-brands fa-github
@@ -79,6 +79,17 @@ There are specific GitHub permissions that the Octopus GitHub App requests in or
79
79
80
80
Whenever possible, Octopus uses a token scoped down to minimal permissions in accordance with the principle of least privilege.
81
81
82
+
## GitHub Allow List
83
+
84
+
The Octopus Deploy GitHub App can be used with the GitHub's allow list feature. To include the app in your allow list manually add the IP Address `172.182.208.68`. Information about adding IP addresses to GitHub's allow list can be found in [GitHub's Documentation](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#adding-an-allowed-ip-address)
85
+
86
+
:::div{.hint}
87
+
**Note:**
88
+
In order to use Octopus Deploy with GitHub allow lists, the IP address of your Octopus Deploy instance and any workers that require GitHub access will also need to be added. If you are using a Octopus Cloud instance of Octopus Deploy you can obtain your [static IP](/docs/octopus-cloud/static-ip) via the Control Center.
89
+
:::
90
+
91
+
Due to a limitation in the way that GitHub supports inheritance of IP addresses when performing actions on behalf of a user, the IP address for the GitHub App needs to be configured manually and cannot be inherited from the app settings. For more information please refer to [GitHub's Documentation](https://docs.github.com/en/enterprise-cloud@latest/apps/maintaining-github-apps/managing-allowed-ip-addresses-for-a-github-app#about-ip-address-allow-lists-for-github-apps)
92
+
82
93
## More information on installing and authorizing the Octopus GitHub App
83
94
84
95
You install the Octopus GitHub App on an account (organization or user) to give the repositories or other content within that account. Authorizing gives the Octopus GitHub App permission to act on your behalf in any account that has the app installed.
@@ -89,10 +100,6 @@ Installing and authorizing are both GitHub concepts. If you want to find out mor
0 commit comments