No commit activity in last 3 years
No release in over 3 years
OmniAuth strategy for Netlify (https://netlify.com).
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Omniauth::Netlify

Travis-CI CodeClimate Test Coverage Gem Gem

Netlify's OAuth2 Strategy for OmniAuth.

Installation

Add this line to your application's Gemfile:

gem 'omniauth-netlify'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-netlify

Usage

OmniAuth::Strategies::Netlify is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.

First, create a new application at https://app.netlify.com/user/applications#oauth. Your callback URL must be something like https://example.com/auth/netlify/callback. For development you can use http://127.0.0.1:3000/auth/netlify/callback.

Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb. This example assumes you're exporting your credentials as environment variables.

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :netlify,
            ENV['NETLIFY_CLIENT_ID'],
            ENV['NETLIFY_CLIENT_SECRET']
end

Now visit /auth/netlify to start authentication against Netlify.

Contributing

  1. Fork omniauth-netlify
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request