Skip to content
This repository has been archived by the owner on May 26, 2021. It is now read-only.

psu-libraries/devise_remote

Repository files navigation

DeviseRemote

Using Devise, this allows your application to authenticate with a remote service such as LDAP, Shibboleth, or any other service that supplies a user's information via HTTP headers.

Installation

Add this line to your application's Gemfile:

gem 'devise_remote'

And then execute:

$ bundle

Or install it yourself as:

$ gem install devise_remote

Usage

DeviseRemote uses much of Devise's generators. Using it with in a new Rails application should only require one command:

$ bundle exec rails g devise_remote:install NAME

Where NAME is the ActiveRecord class you'd like to use for your user. The typical class is User although this is not assumed as a default and you must provide one yourself.

After that, you'll need to get your controllers to authenticate by including:

before_action :authenticate_user!

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devise_remote.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published