Provide more context on setting up GitHub Connections for self-hosted customers#3171
Open
mjhilton wants to merge 2 commits into
Open
Provide more context on setting up GitHub Connections for self-hosted customers#3171mjhilton wants to merge 2 commits into
mjhilton wants to merge 2 commits into
Conversation
Contributor
mjhilton
commented
May 22, 2026
mjhilton
commented
- Expands decision-tree for whether you should externally host your Signing Keys
- Adds info on the impact of being an untrusted instance (needing to copy the Access Code)
- Helps customers decide whether to set a custom OIDC Issuer URL
|
Pull request environment is available at https://stoctodocspr3171.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
stevencl840
reviewed
May 24, 2026
| When externally hosting public keys, they will be available for download as a zip file. The contents of this zip file can then be hosted on any hosting provider that publicly serves HTTPS. The location where the files are hosted must be provided as the **OIDC Issuer URL**. When Octopus Deploy creates a token, the issuer will point to the **OIDC Issuer URL**. While the location specified by the issuer URL must be publicly available, the Octopus Deploy instance can be isolated from public access. | ||
| External hosting is for **self-hosted instances on private or isolated networks** that are not reachable from the internet. Services like the Octopus GitHub service or cloud providers need to fetch your public keys to validate tokens — if they can't reach your instance directly, you need to host those keys somewhere they can. | ||
|
|
||
| When externally hosting, Octopus generates a ZIP file containing your OIDC discovery document and public key set. Host the contents of this file at any publicly accessible HTTPS location, then provide that address as the **OIDC Issuer URL**. Octopus uses this URL as the issuer in tokens it generates, and external services fetch keys from there instead of from your instance. |
Contributor
There was a problem hiding this comment.
You need to provide the address you will use before generating the zip file, the issuer property of the discover document will be set correctly. To be this paragraph implies it can be changed after the files have been gernated whish not correct.
| ## Externally hosted | ||
|
|
||
| When externally hosting public keys, they will be available for download as a zip file. The contents of this zip file can then be hosted on any hosting provider that publicly serves HTTPS. The location where the files are hosted must be provided as the **OIDC Issuer URL**. When Octopus Deploy creates a token, the issuer will point to the **OIDC Issuer URL**. While the location specified by the issuer URL must be publicly available, the Octopus Deploy instance can be isolated from public access. | ||
| External hosting is for **self-hosted instances on private or isolated networks** that are not reachable from the internet. Services like the Octopus GitHub service or cloud providers need to fetch your public keys to validate tokens — if they can't reach your instance directly, you need to host those keys somewhere they can. |
Contributor
There was a problem hiding this comment.
Nit: I think we generally refer to it as the Octopus GitHub app
lourens-octopus
approved these changes
May 25, 2026
Contributor
lourens-octopus
left a comment
lourens-octopus
left a comment
There was a problem hiding this comment.
Thanks Matt, feels like it has cleared the situation up a great deal
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.