Commit 8e866a5d1c64e541371f55e41f2621084c6b7d15

Authored by Casper Valdemar Poulsen
1 parent 7db42b1a4f
Exists in master

docs updated

Showing 1 changed file with 23 additions and 6 deletions Side-by-side Diff

1   -= Redmine SSL auth plugin
  1 += Redmine SAML authentication plugin
2 2  
3   -This redmine plugin enables authentication using SAML using the Onelogin toolkit for RoR.
  3 +This redmine plugin enables SAML authentication using the Onelogin toolkit.
4 4  
5   -== Usage
  5 +The plugin adds two new routes, for the SAML discovery and consumer actions. The discovery (/auth/saml) initiates the SAML exchange and the consumer (/auth/saml/consumer) recieves the SAML assertion and logs the user in.
6 6  
  7 +NB: Work in progress, but functional, see TODO for where this is heading.
7 8  
8   -== Notes
  9 +== Installation
9 10  
  11 +1) Install required gems
10 12  
  13 + gem install XMLCanonicalizer
  14 + gem install ruby-saml
  15 +
  16 +2) Copy plugin to vendor/plugins
  17 +3) Copy saml_auth.yml.example to config/saml_auth.yml
  18 +4) Configure saml_auth.yml (see below)
  19 +5) Restart webserver/passenger/mongrel
  20 +
11 21 == Configuration
12 22  
  23 +Open saml_auth.yml and set up the plugin, a sample configuration is provided. Restart passenger/mongrel after changes to configuration.
13 24  
14   -== Questions
  25 +== Notes
15 26  
16   -To cvp@fracturecode.com
  27 +Patches, fixes or complete rewrites are welcome ;)
  28 +
  29 +== Todo
  30 +
  31 + * Enable/disable plugin from config
  32 + * Disable and redirect /login to identity provider
  33 + * Administration screen in Redmine interface