From 8b38589e1aa00f3c21c8f818b8ea445d81153c58 Mon Sep 17 00:00:00 2001 From: Steven Cleve <107827476+stevencl840@users.noreply.github.com> Date: Mon, 13 Apr 2026 10:29:58 +1000 Subject: [PATCH 1/7] First draft --- src/pages/docs/projects/version-control/github/index.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index c9055f4276..7149f96a7b 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2024-03-14 -modDate: 2024-11-07 +modDate: 2026-04-13 title: GitHub integration description: Octopus Deploy GitHub integration icon: fa-brands fa-github @@ -79,6 +79,10 @@ There are specific GitHub permissions that the Octopus GitHub App requests in or Whenever possible, Octopus uses a token scoped down to minimal permissions in accordance with the principle of least privilege. +## Allow List + +The Octopus Deploy GitHub App can be used with the GitHub Enterprise allow list feature. To include the app in your allow list either enable "Enable IP allow list configuration for installed GitHub Apps" in the "Authenication security" section, or manually add the IP Address "172.182.208.68" to your allow list. + ## More information on installing and authorizing the Octopus GitHub App 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,9 +93,6 @@ Installing and authorizing are both GitHub concepts. If you want to find out mor - [Installing GitHub apps documentation](https://docs.github.com/en/apps/using-github-apps/installing-a-github-app-from-a-third-party) - [Authorizing GitHub apps documentation](https://docs.github.com/en/apps/using-github-apps/authorizing-github-apps) -## Known limitations - -- Connecting to GitHub organizations with IP allow lists enabled is not currently supported with Octopus GitHub App Connections. ## Older versions From fd29219f15cbe73e97a04b730cdc08d2fa27ce07 Mon Sep 17 00:00:00 2001 From: Steven Cleve <107827476+stevencl840@users.noreply.github.com> Date: Mon, 13 Apr 2026 10:52:43 +1000 Subject: [PATCH 2/7] Clean up --- src/pages/docs/projects/version-control/github/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index 7149f96a7b..7cb41dd97a 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -81,7 +81,7 @@ Whenever possible, Octopus uses a token scoped down to minimal permissions in ac ## Allow List -The Octopus Deploy GitHub App can be used with the GitHub Enterprise allow list feature. To include the app in your allow list either enable "Enable IP allow list configuration for installed GitHub Apps" in the "Authenication security" section, or manually add the IP Address "172.182.208.68" to your allow list. +The Octopus Deploy GitHub App can be used with the GitHub Enterprise allow list feature. To include the app in your allow list either enable "Enable IP allow list configuration for installed GitHub Apps" in the "Authentication security" section, or manually add the IP Address "172.182.208.68" to your allow list. ## More information on installing and authorizing the Octopus GitHub App @@ -93,7 +93,6 @@ Installing and authorizing are both GitHub concepts. If you want to find out mor - [Installing GitHub apps documentation](https://docs.github.com/en/apps/using-github-apps/installing-a-github-app-from-a-third-party) - [Authorizing GitHub apps documentation](https://docs.github.com/en/apps/using-github-apps/authorizing-github-apps) - ## Older versions - Prior to version 2024.3.12703 when the new UI navigation was introduced, the GitHub Connections page is located in the Library section of Octopus. From 30a06cd97396e01c9d1cd9a96e452c9094f8a383 Mon Sep 17 00:00:00 2001 From: Steven Cleve <107827476+stevencl840@users.noreply.github.com> Date: Mon, 13 Apr 2026 15:48:16 +1000 Subject: [PATCH 3/7] Add information about instance IPs --- src/pages/docs/projects/version-control/github/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index 7cb41dd97a..755913b769 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -83,6 +83,12 @@ Whenever possible, Octopus uses a token scoped down to minimal permissions in ac The Octopus Deploy GitHub App can be used with the GitHub Enterprise allow list feature. To include the app in your allow list either enable "Enable IP allow list configuration for installed GitHub Apps" in the "Authentication security" section, or manually add the IP Address "172.182.208.68" to your allow list. +:::div{.hint} +**Note:** +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 [staitc IP](/docs/octopus-cloud/static-ip) via the Control Center. +::: + + ## More information on installing and authorizing the Octopus GitHub App 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. From 48c3c4ddd4bd7dc77ee6f8eacb4f53836cb9a47b Mon Sep 17 00:00:00 2001 From: Steven Cleve <107827476+stevencl840@users.noreply.github.com> Date: Mon, 13 Apr 2026 15:54:06 +1000 Subject: [PATCH 4/7] Clean up again --- src/pages/docs/projects/version-control/github/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index 755913b769..527515c62d 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -85,10 +85,9 @@ The Octopus Deploy GitHub App can be used with the GitHub Enterprise allow list :::div{.hint} **Note:** -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 [staitc IP](/docs/octopus-cloud/static-ip) via the Control Center. +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. ::: - ## More information on installing and authorizing the Octopus GitHub App 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. From 65deb50dd69d48b26aac87285c4f9f47416b3469 Mon Sep 17 00:00:00 2001 From: Steven Cleve <107827476+stevencl840@users.noreply.github.com> Date: Tue, 14 Apr 2026 12:50:29 +1000 Subject: [PATCH 5/7] Update --- src/pages/docs/projects/version-control/github/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index 527515c62d..578f733b87 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -81,7 +81,7 @@ Whenever possible, Octopus uses a token scoped down to minimal permissions in ac ## Allow List -The Octopus Deploy GitHub App can be used with the GitHub Enterprise allow list feature. To include the app in your allow list either enable "Enable IP allow list configuration for installed GitHub Apps" in the "Authentication security" section, or manually add the IP Address "172.182.208.68" to your allow list. +The Octopus Deploy GitHub App can be used with the GitHub Enterprise allow list feature. To include the app in your allow list manually add the IP Address `172.182.208.68`. 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) :::div{.hint} **Note:** From 116fbcb037f2862ca3f0a18e0f7e0a3894de334e Mon Sep 17 00:00:00 2001 From: Steven Cleve <107827476+stevencl840@users.noreply.github.com> Date: Tue, 14 Apr 2026 15:42:23 +1000 Subject: [PATCH 6/7] Added link to documentation, rearrange to make the limitiation of the github app registration stand out --- src/pages/docs/projects/version-control/github/index.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index 578f733b87..2250a0c12f 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -79,15 +79,17 @@ There are specific GitHub permissions that the Octopus GitHub App requests in or Whenever possible, Octopus uses a token scoped down to minimal permissions in accordance with the principle of least privilege. -## Allow List +## GitHub Allow List -The Octopus Deploy GitHub App can be used with the GitHub Enterprise allow list feature. To include the app in your allow list manually add the IP Address `172.182.208.68`. 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) +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) :::div{.hint} **Note:** 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. ::: +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) + ## More information on installing and authorizing the Octopus GitHub App 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. From ae06a9700a54bebdb0687cac97085c9d206dc183 Mon Sep 17 00:00:00 2001 From: Steven Cleve <107827476+stevencl840@users.noreply.github.com> Date: Wed, 15 Apr 2026 08:08:24 +1000 Subject: [PATCH 7/7] Fix trailing white space --- src/pages/docs/projects/version-control/github/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/projects/version-control/github/index.md b/src/pages/docs/projects/version-control/github/index.md index 2250a0c12f..a00950f439 100644 --- a/src/pages/docs/projects/version-control/github/index.md +++ b/src/pages/docs/projects/version-control/github/index.md @@ -81,7 +81,7 @@ Whenever possible, Octopus uses a token scoped down to minimal permissions in ac ## GitHub Allow List -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) +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) :::div{.hint} **Note:**