Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 2.47 KB

README.md

File metadata and controls

81 lines (57 loc) · 2.47 KB

Überauth Steam

Hex.pm Build Status Coverage Status Inline docs Deps Status Hex.pm

Steam OpenID strategy for Überauth.

Installation

  1. Obtain an Steam Web API Key at Steam Dev.

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

    def deps do
      [{:ueberauth_steam, "~> 0.1.2", github: "kouwasi/ueberauth_steam"},]
    end
  3. Add the strategy to your applications:

    def application do
      [applications: [:ueberauth_steam]]
    end
  4. Add Steam to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        steam: {Ueberauth.Strategy.Steam, []}
      ]
  5. Update your provider configuration:

    config :ueberauth, Ueberauth.Strategy.Steam,
      api_key: System.get_env("STEAM_API_KEY")
  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. Your 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 initialize the request through:

/auth/steam

License

Please see LICENSE for licensing details.