Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
R

rails-omniauth

> 编程语言
Open source

Rails 5.0 starter app with OmniAuth for authentication.

280 stars0 likes1 views
WebsiteGitHub

About

Rails 5.0 starter app with OmniAuth for authentication.

h1. !http://railsapps.github.io/images/rails-36x36.jpg(Rails OmniAuth)! Rails and OmniAuth

Rails 5.0 example application that integrates Rails and OmniAuth. "OmniAuth":https://github.com/intridea/omniauth/wiki is a gem that provides authentication using third-party credentials such as Facebook, Twitter, or GitHub accounts.

You can build this application in only a few minutes using the "Rails Composer":http://railsapps.github.io/rails-composer/ tool, choosing either a Bootstrap or Foundation front-end framework, as well as many other options, such as Haml or Slim.

h4. !http://railsapps.github.io/images/join/join-railsapps.png(Join RailsApps)!:http://railsapps.github.io/

Our "Rails and OmniAuth tutorial":http://railsapps.github.io/rails-omniauth/ explains the application in-depth so there is no mystery code.

h4. From the RailsApps Project

The "RailsApps":http://railsapps.github.io/ open source project offers starter applications and tutorials for Rails developers. Generate the applications with the Rails Composer tool.

All the code is explained in the Capstone Rails Tutorials. You can purchase the "Capstone Rails Tutorials":https://tutorials.railsapps.org/ to support the project.

h4. If You Are New to Rails

If you're new to Rails, see "What is Ruby on Rails?":http://railsapps.github.io/what-is-ruby-rails.html, the book "Learn Ruby on Rails":http://learn-rails.com/learn-ruby-on-rails.html, and recommendations for a "Rails tutorial":https://tutorials.railsapps.org/rails-tutorial.

h2. What Is Implemented -- and What Is Not

The example application can be used as the basis for a website that provides a login using a Twitter account. You can easily substitute any other "provider supported by OmniAuth":https://github.com/intridea/omniauth/wiki/List-of-Strategies. With knowledge of Rails, the website can be adapted and customized to your needs. Features include:

  • Home page
  • Navigation bar
  • Login
  • Logout
  • Show user profile
  • List of users

The list of users is visible to anyone. Use authentication to restrict it to the user who was created first, or implement authorization to restrict it to an administrator. See the "rails-devise-pundit":https://github.com/RailsApps/rails-devise-pundit example application if you wish to add authorization.

h4. Single Provider or Multiple Providers?

This application is designed for sign-in with a single provider. For example, you may be creating an application just for Twitter users. Alternatively, it’s possible to create an application that lets a user log in using multiple providers. This example application doesn't show the more complex use of multiple providers.

h4. When to use Devise?

"Devise":https://github.com/plataformatec/devise provides authentication using username (or email address) and password. If you don’t need the option of using a username/password, that is, if you wish to have all your users sign in using a service provider’s account (such as Twitter or Facebook), there’s no need to use Devise. Devise can be used in conjunction with the OmniAuth gem when you need to offer users the option of signing up for access to a website using an email address. For example, combine Devise with OmniAuth to accommodate users who want to log in with various service providers (Twitter, Facebook, etc.) as well as users who don’t have external accounts and want to sign up with just an email address.

h4. The Email Problem

You don’t need to ask a visitor for an email address when you build an application that allows a user to log in using a service provider such as Twitter or Facebook. You may consider that an advantage: if a user is logged in with Twitter or Facebook, they don’t need to enter an email address and password to access your application. However, the lack of an email address may be a business drawback, if you want the opportunity to stay in contact with the user by email. Some service providers provide the user’s email address to your application (Facebook). Some service providers only provide the email address at the user’s option (GitHub supplies it if the user has provided a public email address). And other service providers do not provide the email address at all (Twitter, Meetup, LinkedIn). Our "Rails and OmniAuth tutorial":http://railsapps.github.io/rails-omniauth/ shows how to customize the application to ask for an email address when the user signs in for the first time.

h4. Database

The application requires a database. The example application uses SQLite with Rails ActiveRecord. You can easily substitute PostgreSQL, MySQL, or other databases.

h4. Front-end Framework

The example application (here in the GitHub repository) includes simple CSS for a navigation bar and flash messages. The "rails_layout":https://github.com/RailsApps/rails_layout gem is included so you can add the Bootstrap or Foundation front-end frameworks.

h2. Similar Examples and Tutorials

This is one in a series of Rails example apps and tutorials from the "RailsApps Project":http://railsapps.github.io/. See a list of additional "Rails examples, tutorials, and starter apps":http://railsapps.github.io/rails-examples-tutorials.html. Related example applications may be useful:

  • "Learn Rails":https://github.com/RailsApps/learn-rails companion to the book "Learn Ruby on Rails":http://learn-rails.com/learn-ruby-on-rails.html
  • "Foundation and Rails":https://github.com/RailsApps/rails-foundation shows how to integrate Foundation
  • "Bootstrap and Rails":https://github.com/RailsApps/rails-bootstrap shows to integrate Bootstrap
  • "Devise and Rails":https://github.com/RailsApps/rails-devise shows to use Devise for authentication
  • "Devise and Pundit and Rails":https://github.com/RailsApps/rails-devise-pundit uses Pundit for authorization

h2. Accounts You Will Need

h3. Heroku

We provide instructions to deploy the application to "Heroku":https://www.heroku.com/ which provides Rails application hosting. It costs nothing to set up a Heroku account and deploy as many applications as you want. To deploy an app to Heroku, you must have a Heroku account. Visit Heroku "to set up an account":https://id.heroku.com/signup/devcenter.

h3. Obtaining API Keys

Before installing the application, register with a service provider to obtain the required API keys. The example assumes you will be using Twitter.

h4. Twitter

Visit the Twitter "Create an application":https://dev.twitter.com/apps/new page to register your application. You can use the following values when you register your application:

|. Application Website |. Callback URL |_. Notes | | http://example.com | http://127.0.0.1:3000/ | http://localhost:3000/ doesn't work |

h4. Facebook

Visit the "Facebook Developer Site":http://developers.facebook.com/setup to register your application.

h4. GitHub

Visit GitHub's "Register a new OAuth application":https://github.com/settings/applications/new page to register your application.

h4. Others

See the OmniAuth "List of Strategies":https://github.com/intridea/omniauth/wiki/List-of-Strategies page.

h2. Dependencies

Before generating your application, you will need:

  • The Ruby language - version 2.3.1
  • The Rails gem - version 5.0

See the article "Installing Rails":http://railsapps.github.io/installing-rails.html for instructions about setting up Rails and your development environment.

h2. Getting the Application

h3. Local

You have several options for getting the code on your own machine. You can fork, clone, or generate.

h4. Fork

If you'd like to add features (or bug fixes) to improve the example application, you can fork the GitHub repo and "make pull requests":http://help.github.com/send-pull-requests/. Your code contributions are welcome!

h4. Clone

If you want to copy and customize the app with changes that are only useful for your own project, you can clone the GitHub repo. You'll need to search-and-replace the project name throughout the application. You probably should generate the app instead (see below). To clone:

$ git clone git://github.com/RailsApps/rails-omniauth.git

You'll need "git":http://git-scm.com/ on your machine. See "Rails and Git":http://railsapps.github.io/rails-git.html.

h4. Generate

If you want to use the project as a starter application, use the "Rails Composer":http://railsapps.github.io/rails-composer/ tool to generate a new version of the example app. You'll be able to give it your own project name when you generate the app. Generating the application gives you additional options.

To build the example application, Rails 5.0 must be installed in your development environment. Run the command:

$ rails new rails-omniauth -m https://raw.github.com/RailsApps/rails-composer/master/composer.rb

The @$@ character indicates a shell prompt; don't include it when you run the command.

This creates a new Rails app named @rails-omniauth@ on your computer. You can use a different name if you wish.

You'll see a prompt:

option Build a starter application? 1) Build a RailsApps example application 2) Contributed applications 3) Custom application

Enter "1" to select Build a RailsApps example application. You'll see a prompt:

option Choose a starter application. 1) learn-rails 2) rails-bootstrap 3) rails-foundation 4) rails-mailinglist-activejob 5) rails-omniauth 6) rails-devise 7) rails-devise-roles 8) rails-devise-pundit 9) rails-signup-download 10) rails-stripe-checkout

Choose rails-omniauth. The Rails Composer tool may give you other options (other applications may have been added since these notes were written).

The application generator template will ask you for additional preferences:

question Web server for development? 1) WEBrick (default) 2) Thin 3) Unicorn 4) Puma 5) Phusion Passenger (Apache/Nginx) 6) Phusion Passenger (Standalone) question Web server for production? 1) Same as development 2) Thin 3) Unicorn 4) Puma 5) Phusion Passenger (Apache/Nginx) 6) Phusion Passenger (Standalone) question Database used in development? 1) SQLite 2) PostgreSQL 3) MySQL 4) MongoDB question Template engine? 1) ERB 2) Haml 3) Slim question Test framework? 1) None 2) RSpec with Capybara question Front-end framework? 1) None 2) Twitter Bootstrap 3.3 3) Twitter Bootstrap 2.3 4) Zurb Foundation 5.5 5) Zurb Foundation 4.0 6) Simple CSS question OmniAuth provider? 1) Facebook 2) Twitter 3) GitHub 4) LinkedIn 5) Google-Oauth-2 6) Tumblr question Use a form builder gem? 1) None 2) SimpleForm extras Set a robots.txt file to ban spiders? (y/n) extras Create a GitHub repository? (y/n) extras Use or create a project-specific rvm gemset? (y/n)

h4. Web Servers

If you plan to deploy to Heroku, select Unicorn as your production webserver. Unicorn is recommended by Heroku.

h4. Database

Use SQLite for development on Mac or Linux, unless you already have PostgreSQL installed locally. Use PostgreSQL if you plan to deploy to Heroku. You can easily change the database later if you select SQLite to start.

h4. Template Engine

The example application uses the default "ERB" Rails template engine. Optionally, you can use another template engine, such as Haml or Slim. See instructions for "Haml and Rails":http://railsapps.github.io/rails-haml.html.

h4. Testing

If you are a beginner, select "None."

h4. Front-end Framework

The example in the GitHub repository was built using "Simple CSS." Use Zurb Foundation or Bootstrap if you prefer.

h4. OmniAuth Provider

Choose the service provider you will use. The example application uses Twitter.

h4. Other Choices

Set a robots.txt file to ban spiders if you want to keep your new site out of Google search

Issues· 5 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

Ruby

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 18, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言