Commit 8fa8b93bbdbaed347445afe1164a850ded169c49

Authored by Casper Valdemar Poulsen
1 parent fc1747eede
Exists in master

updated docs

Showing 1 changed file with 15 additions and 13 deletions Side-by-side Diff

... ... @@ -8,18 +8,18 @@
8 8  
9 9 == Installation
10 10  
11   -1) Install required gems
  11 +1. Install required gems
  12 + +gem install XMLCanonicalizer+
  13 + +gem install ruby-saml+
  14 +
  15 +2. Copy plugin to +vendor/plugins+
12 16  
13   -<code>
14   - gem install XMLCanonicalizer
15   - gem install ruby-saml
16   -</code>
  17 +3. Copy +saml_auth.yml.example+ to +config/saml_auth.yml+
17 18  
18   -2) Copy plugin to +vendor/plugins+
19   -3) Copy +saml_auth.yml.example+ to +config/saml_auth.yml+
20   -4) Configure +saml_auth.yml+ (see below)
21   -5) Restart webserver/passenger/mongrel_rails
  19 +4. Configure +saml_auth.yml+ (see below)
22 20  
  21 +5. Restart webserver/passenger/mongrel_rails
  22 +
23 23 == Configuration
24 24  
25 25 Open +saml_auth.yml+ and set up the plugin, a sample configuration is provided. Restart passenger/mongrel after changes to configuration.
26 26  
27 27  
... ... @@ -30,11 +30,13 @@
30 30  
31 31 == Todo
32 32  
33   - * Enable/disable plugin from config
34   - * Disable and redirect /login to identity provider
35   - * Administration screen in Redmine interface
  33 +* Enable/disable plugin from config
36 34  
  35 +* Disable and redirect /login to identity provider
  36 +
  37 +* Administration screen in Redmine interface
  38 +
37 39 == License and copyright
38 40  
39   -Copyright (C) 2011 Casper Valdemar Poulsen. License follows Redmine - GNU General Public License v2 (GPL).
  41 +Copyright (c) 2011 Casper Valdemar Poulsen. License follows Redmine - GNU General Public License v2 (GPL).