ueberauth_openstreetmap/README.md

Überauth OpenStreetMap

OpenStreetMap strategy for Überauth.

Note: Sessions are required for this strategy.

Installation

1. Setup your application at OpenStreetMap Developers.

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

   def deps do
     [
       {:ueberauth_OpenStreetMap, "~> 0.3"}
     ]
   end
   

3. Add OpenStreetMap to your Überauth configuration:

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

4. Update your provider configuration:

   config :ueberauth, Ueberauth.Strategy.OpenStreetMap.OAuth,
     consumer_key: System.get_env("OpenStreetMap_CONSUMER_KEY"),
     consumer_secret: System.get_env("OpenStreetMap_CONSUMER_SECRET")
   

5. Include the Überauth plug in your controller:

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

6. 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
   

7. 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 initiate the request through:

/auth/OpenStreetMap

Development mode

As noted when registering your application on the OpenStreetMap Developer site, you need to explicitly specify the oauth_callback url. While in development, this is an example url you need to enter.

Website - http://127.0.0.1
Callback URL - http://127.0.0.1:4000/auth/OpenStreetMap/callback

License

Please see LICENSE for licensing details.