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:
| Variable | Required | Notes |
|---|---|---|
GANTRYCD_SSO_GITHUB_CLIENT_ID | Yes | OAuth app client id |
GANTRYCD_SSO_GITHUB_CLIENT_SECRET | Yes | OAuth app client secret |
GANTRYCD_SSO_GITHUB_BASE_URL | GHE only | GitHub Enterprise web base URL |
GITHUB_API_BASE_URL | GHE only | GitHub 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
/providersreturns[]— both the client id and secret must be set; restart after changing them.