Skip to content
GantryCD

GitHub

At a glance — a platform-wide GitHub OAuth provider, built once at boot from environment variables. Access maps from GitHub org and team membership.

Configure

Set the client credentials and restart the backend:

VariableRequiredNotes
GANTRYCD_SSO_GITHUB_CLIENT_IDYesOAuth app client id
GANTRYCD_SSO_GITHUB_CLIENT_SECRETYesOAuth app client secret
GANTRYCD_SSO_GITHUB_BASE_URLGHE onlyGitHub Enterprise web base URL
GITHUB_API_BASE_URLGHE onlyGitHub Enterprise API base URL

Register the single callback URL with the OAuth app. Verify it registered:

curl https://gantrycd.example.com/api/v1/auth/sso/providers
# expect {"key":"github","display_name":"GitHub"} in the array

Access rules

{"type": "github_org",  "org": "acme"}
{"type": "github_team", "org": "acme", "team": "platform"}

Troubleshooting

  • /providers returns [] — both the client id and secret must be set; restart after changing them.

Internals

SSO Configuration.