omniauth/oa-openid
James A. Rosen f4919a113a Bundler's add_bundler_dependencies is considered harmful and being deprecated; changed from Gemfile -> .gemspec dependencies to the reverse. 2010-06-13 16:36:59 -04:00
..
lib/omniauth merged with achiu 2010-06-13 13:20:52 -04:00
spec added spec_helper for oa-openid, added stup spec for openid strategy 2010-06-12 22:41:05 -04:00
CHANGELOG.rdoc READMEs and CHANGELOGs updated. 2010-05-01 15:22:25 -04:00
Gemfile Bundler's add_bundler_dependencies is considered harmful and being deprecated; changed from Gemfile -> .gemspec dependencies to the reverse. 2010-06-13 16:36:59 -04:00
LICENSE.rdoc Adds lots of stuff. Facebook is broken, beware. 2010-04-09 21:30:16 -04:00
README.rdoc changed omniauth-openid to omniauth/openid and likewise for -basic in OpenID README 2010-06-12 22:56:41 -04:00
Rakefile Bundler's add_bundler_dependencies is considered harmful and being deprecated; changed from Gemfile -> .gemspec dependencies to the reverse. 2010-06-13 16:36:59 -04:00
VERSION misc small adjustments to get the gems to install 2010-06-09 13:48:55 -04:00
oa-openid.gemspec Bundler's add_bundler_dependencies is considered harmful and being deprecated; changed from Gemfile -> .gemspec dependencies to the reverse. 2010-06-13 16:36:59 -04:00

README.rdoc

= OmniAuth::OpenID

OpenID strategies for the OmniAuth gem.

== Installation

To get just OpenID functionality:

    gem install oa-openid
    
For the full auth suite:

    gem install omniauth
    
== Stand-Alone Example

Use the strategy as a middleware in your application:

    require 'omniauth/openid'
    require 'openid/store/filesystem'
    
    use OmniAuth::Strategies::OpenID, OpenID::Store::Filesystem.new('/tmp')
    
Then simply direct users to '/auth/open_id' to prompt them for their OpenID identifier. You may also pre-set the identifier by passing an <tt>identifier</tt> parameter to the URL (Example: <tt>/auth/open_id?identifier=google.com</tt>).

== OmniAuth Builder

If OpenID is one of several authentication strategies, use the OmniAuth Builder:

    require 'omniauth/openid'
    require 'omniauth/basic'  # for Campfire
    require 'openid/store/filesystem'
    
    use OmniAuth::Builder do
      provider :open_id, OpenID::Store::Filesystem.new('/tmp')
      provider :campfire
    end