File: README.md

package info (click to toggle)
ruby-omniauth-multipassword 2.0.0~rc1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 160 kB
  • sloc: ruby: 243; makefile: 2
file content (62 lines) | stat: -rw-r--r-- 1,692 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# Omniauth::Multipassword

[![Build Status](https://travis-ci.org/jgraichen/omniauth-multipassword.svg?branch=master)](https://travis-ci.org/jgraichen/omniauth-multipassword)
[![Code Climate](https://codeclimate.com/github/jgraichen/omniauth-multipassword/badges/gpa.svg)](https://codeclimate.com/github/jgraichen/omniauth-multipassword)
[![Test Coverage](https://codeclimate.com/github/jgraichen/omniauth-multipassword/badges/coverage.svg)](https://codeclimate.com/github/jgraichen/omniauth-multipassword/coverage)

**omniauth-multipassword** is a [OmniAuth](https://github.com/intridea/omniauth)
strategy that allows to authenticate again different password strategies at once.


## Installation

Add this line to your application's Gemfile:

    gem 'omniauth-multipassword'

Add multipassword compatible omniauth strategies you want to use:

	gem 'omniauth-internal'
	gem 'omniauth-kerberos'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install omniauth-multipassword


## Usage

```ruby
Rails.application.config.middleware.use OmniAuth::Strategies::MultiPassword, fields: [ :auth_key ] do |mp|
  mp.authenticator :internal
  mp.authenticator :kerberos
end
```


## Options

** title **
The title text shown on default login form.
(default: `"Restricted Access"`)

** fields **
The request parameter names to fetch username and password.
(default: `[ "username", "password" ]`)


### Compatible Strategies

* [omniauth-internal](https://github.com/jgraichen/omniauth-internal)
* [omniauth-kerberos](https://github.com/jgraichen/omniauth-kerberos)


## License

[MIT License](http://www.opensource.org/licenses/mit-license.php)

Copyright (c) 2012, Jan Graichen