Überauth GitHub

GitHub OAuth2 strategy for Überauth.

Installation

1. Setup your application at GitHub Developer.

2. Add :ueberauth_github to your list of dependencies in mix.exs:

   def deps do
     [{:ueberauth_github, "~> 0.2"}]
   end
   

3. Add the strategy to your applications:

   def application do
     [applications: [:ueberauth_github]]
   end
   

4. Add GitHub to your Überauth configuration:

   config :ueberauth, Ueberauth,
     providers: [
       github: [{Ueberauth.Strategy.GitHub, []}]
     ]
   

5. Update your provider configuration:

   config :ueberauth, Ueberauth.Strategy.GitHub.OAuth,
     client_id: System.get_env("GITHUB_CLIENT_ID"),
     client_secret: System.get_env("GITHUB_CLIENT_SECRET")
   

6. Include the Überauth plug in your controller:

   defmodule MyApp.AuthController do
     use MyApp.Web, :controller
     plug Ueberauth
     ...
   end
   

7. Create the request and callback routes if you haven't already:

   scope "/auth", MyApp do
     pipe_through :browser
   
     get "/:provider", AuthController, :request
     get "/:provider/callback", AuthController, :callback
   end
   

8. You controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

For an example implementation see the Überauth Example application.

Calling

Depending on the configured url you can initial the request through:

/auth/github

Or with options:

/auth/github?scope=user,public_repo

By default the requested scope is "user,public_repo". Scope can be configured either explicitly as a scope query value on the request path or in your configuration:

config :ueberauth, Ueberauth,
  providers: [
    github: {Ueberauth.Strategy.GitHub, [default_scope: "user,public_repo,notifications"]}
  ]

License

Please see LICENSE for licensing details.