README.md in devise-radius-authenticatable-0.0.4 vs README.md in devise-radius-authenticatable-0.0.5
- old
+ new
@@ -1,18 +1,20 @@
Devise Radius Authenticatable
=============================
+[](http://badge.fury.io/rb/devise-radius-authenticatable)
[](https://travis-ci.org/cbascom/devise-radius-authenticatable)
+[](https://codeclimate.com/github/cbascom/devise-radius-authenticatable)
Devise Radius Authenticatable is a Radius authentication strategy for [Devise](http://github.com/plataformatec/devise).
Dependencies
------------
- Rails ~> 3.2
- Devise ~> 2.0
-- radiustar ~> 0.0.6
+- radiustar ~> 0.0.8
Installation
------------
In the Gemfile for your application:
@@ -34,19 +36,21 @@
This will update the devise.rb initializer. The IP and SECRET parameters specify the IP address and shared secret for the radius server. There are also some options you can pass to the generator to customize some default settings:
Options:
- [--uid-field=UID_FIELD] # What database column to use for the UID
- # Default: uid
- [--port=PORT] # The port to connect to the radius server on
- # Default: 1812
- [--timeout=TIMEOUT] # How long to wait for a response from the radius server
- # Default: 60
- [--retries=RETRIES] # How many times to retry a radius request
- # Default: 0
- [--dictionary-path=DICTIONARY_PATH] # The path to load radius dictionary files from
+ [--uid-field=UID_FIELD] # What database column to use for the UID
+ # Default: uid
+ [--port=PORT] # The port to connect to the radius server on
+ # Default: 1812
+ [--timeout=TIMEOUT] # How long to wait for a response from the radius server
+ # Default: 60
+ [--retries=RETRIES] # How many times to retry a radius request
+ # Default: 0
+ [--dictionary-path=DICTIONARY_PATH] # The path to load radius dictionary files from
+ [--handle-timeout-as-failure=HANDLE_TIMEOUT_AS_FAILURE] # Option to handle radius timeout as authentication failure
+ # Default: false
Documentation
-------------
The rdocs for the gem are available here: http://rubydoc.info/github/cbascom/devise-radius-authenticatable/master/frames
@@ -68,15 +72,15 @@
The field that is used for logins is the first key that's configured in the Devise `config.authentication_keys` settings, which by default is email. For help changing this, please see the [Railscast](http://railscasts.com/episodes/210-customizing-devise) that goes through how to customize Devise.
Configuration
-------------
-The radius_authenticatable module is configured through the normal devise initializer `config/initializers/devise.rb`. The initial values are added to the file when you run the devise_radius_authenticatable:install generator as describe previously.
+The radius_authenticatable module is configured through the normal devise initializer `config/initializers/devise.rb`. The initial values are added to the file when you run the devise_radius_authenticatable:install generator as described previously.
References
----------
* [FreeRadius](http://www.freeradius.org/)
* [Devise](http://github.com/plataformatec/devise)
* [Warden](http://github.com/hassox/warden)
-Copyright (c) 2012 Calvin Bascom Released under the MIT license
+Copyright (c) 2012-2013 Calvin Bascom Released under the MIT license