Configure GitHub OAuth

Configure GitHub and Spinnaker to use GitHub as an OAuth2 authenticator.


  • Ability to modify developer settings for your GitHub organization

  • Access to Halyard

  • A Spinnaker deployment with DNS and SSL configured

Configure GitHub OAuth in GitHub

  1. Login to GitHub and go to Settings > Developer Settings > OAuth Apps > New OAuth App

  2. Make note of the Client ID / Client Secret

  3. Homepage URL: This would be the URL of your Spinnaker service e.g.

  4. Authorization callback URL: This is going to match your --pre-established-redirect-uri in halyard and the URL needs login appended to your gate endpoint. Example or

Configure GitHub OAuth in Spinnaker

Add the following snippet to your SpinnakerService manifest under the level:

    enabled: true
      clientId: a08xxxxxxxxxxxxx93
      clientSecret: 6xxxaxxxxxxxxxxxxxxxxxxx59   # Secret Enabled Field
      scope: read:org,user:email
    provider: GITHUB

Additional OAuth resources

Last updated