Home

Resources

• Changelog - A list of the changes between versions of OmniAuth.
• Philosophy - An explanation of the philosophy behind OmniAuth.
• Roadmap - A plan for upcoming features for OmniAuth.
• Mailing List - Google Group for questions and discussion of OmniAuth.
• API Documentation - YARD-generated documentation for the OmniAuth code.
• Sites Using OmniAuth - A community-curated list of sites that are using OmniAuth for authentication.

Documentation

• Auth Hash Schema - Learn what the contents of the auth hash returned by OmniAuth will include.
• Using Multiple Providers - The easiest way to use multiple providers from a single application.
• Contributing to OmniAuth - Some instructions for setting up an environment to contribute to OmniAuth.
• Integration Testing - OmniAuth has some facilities for easing integration testing. Learn about them here!
• Setup Phase - Information on the per-request setup phase.
• Dynamic Providers - How to modify the credentials of a provider at runtime.
• Saving User Location - Redirect users back to where they came upon login.
• Selectively loading Omniauth gems - e.g. if you're only using OAuth and don't want LDAP dependencies et al

Provider-Specific Docs

• Developer Credentials List - Need to find out where to sign up for that consumer key and secret? Check here.
• LDAP
• OpenID and Google Apps

Tutorials / Blog Posts

• Detailed Tutorial for Rails 3 + Mongoid + Omniauth by Daniel Kehoe
• Ruby on Rails CommunityGuides: Omniauth pure - Authentication with Facebook, Google, Google Apps, Twitter, Github, AOL, MyOpenID, ... [March 2011] with demo application on Github.
• Separating Authentication and Identity with OmniAuth - Tutorial about integrating OmniAuth with Rails in a robust manner.
• OmniAuth: Flexible, Unassuming Authentication - Announcement post, covers some philosophy behind OmniAuth and brief tech intro.
• Railscasts: OmniAuth Screencast Part 1 and Part 2 - A two-part video walkthrough of installing, configuring and using OmniAuth in existing Rails application.
• Railscasts: Simple OmniAuth Screencast - A follow up screencast in the Railscasts series that demonstrates a simpler approach to using OmniAuth
• An OmniAuth Provider for Everything Else - Great workup of how to write additional providers for OmniAuth.
• Writing acceptance tests for OmniAuth - A blog post with a tutorial explaining how to write an acceptance test for OmniAuth, including how to stub the Provider responses.
• Easy Rails OAuth integration testing with OmniAuth - A blog post detailing how to test authentication workflow with Capybara
• Dynamically Requesting Facebook Permissions with OmniAuth - Detailed explanation on dynamically setting Facebook permissions within the Setup Phase

Examples

• Example app using Rails 3 + Mongoid + Omniauth by Daniel Kehoe
• Sinatra - A simple authentication example in Sinatra.