Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Corrected some typos and improved instructions

  • Loading branch information...
commit 3d4646688fe657cbb74d7db81c76ab81e46713d0 1 parent 59780d2
authored February 01, 2008

Showing 1 changed file with 27 additions and 16 deletions. Show diff stats Hide diff stats

  1. 43  auth/shibboleth/README.txt
43  auth/shibboleth/README.txt
@@ -58,22 +58,21 @@ Moodle Configuration with Dual login
58 58
    #############################################################################
59 59
    Shibboleth Attributes needed by Moodle:
60 60
    For Moodle to work properly Shibboleth should at least provide the attribute
61  
-   that is used as usernam in Moodle. It has to be unique for all Shibboleth 
62  
-   users.
  61
+   that is used as username in Moodle. It has to be unique for all Shibboleth 
  62
+   Be aware that Moodle converts the username to lowercase. So, the overall
  63
+   behaviour of the username will be case-insensitive.
63 64
    All attributes used for moodle must obey a certain length, otherwise Moodle 
64 65
    cuts off the ends. Consult the Moodle documentation for further information 
65 66
    on the maximum lengths for each field in the user profile.
66 67
    #############################################################################
67 68
 
68  
-4. Save the changes for the 'Shibboleth settings'.
69  
-
70  
-5.a  If you want Shibboleth as your only authentication method with an external
  69
+4.a  If you want Shibboleth as your only authentication method with an external
71 70
      Where Are You From (WAYF) Service , set the 'Alternate Login URL' in the 
72 71
      'Common settings' in 'Administrations >> Users >> Authentication Options' 
73 72
      to the the URL of the file 'moodle/auth/shibboleth/index.php'. 
74 73
      This will enforce Shibboleth login.
75 74
 
76  
-5.b If you want to use the Moodle internal WAYF service, you have to activate it
  75
+4.b If you want to use the Moodle internal WAYF service, you have to activate it
77 76
     in the Moodle Shibboleth authentication settings by checking the 
78 77
     'Moodle WAYF Service' checkbox and providing a list of entity IDs in the 
79 78
     'Identity Providers' textarea together with a name and an optional 
@@ -88,23 +87,34 @@ Moodle Configuration with Dual login
88 87
                     moodle/auth/shibboleth/ is protected but *not* the other 
89 88
                     scripts and especially not the login.php script.
90 89
 
91  
-6.b If you want to use another authentication method together with Shibboleth, 
92  
-    in parallel, change the 'Instructions' in the 'Common settings' of the
93  
-    'Administrations >> Users >> Authentication Options' to contain a link to the
  90
+5.  Save the changes for the 'Shibboleth settings'. T
  91
+
  92
+    Important Note: If you went for 4.b (integrated WAYF service), saving the 
  93
+                    settings will overwrite the Moodle Alternate Login URL
  94
+                    using the Moodle web root URL.
  95
+
  96
+6.  If you want to use Shibboleth in addition to another authentication method
  97
+    not using the integrated WAYF service from 4.b, change the 'Instructions' in 
  98
+    'Administrations >> Users >> Manage authentication' to contain a link to the
94 99
      moodle/auth/shibboleth/index.php file which is protected by
95  
-     Shibboleth (see step 1) and causes the Shibboleth login procedure to start.
  100
+     Shibboleth (see step 1.) and causes the Shibboleth login procedure to start.
96 101
      You can also use HTML code in that field, e.g. to include an image as a
97 102
      Shibboleth login button.
98 103
 
99  
-7. Save the changes for the 'Common settings'.
  104
+     Note: As of now you cannot use dual login together with the integrated
  105
+           WAYF service provided by Moodle (4.b).
  106
+
  107
+7. Save the authentication changes.
100 108
 
101 109
 How the Shibboleth authentication works
102 110
 --------------------------------------------------------------------------------
103 111
 To get Shibboleth authenticated in Moodle a user basically must access the
104 112
 Shibboleth-protected page /auth/shibboleth/index.php. If Shibboleth is the only
105  
-authentication method (see 5.a), this happens automatically when a user wants to
106  
-login in Moodle. Otherwise, the user has to click on the link on the login page
107  
-you provided in step 5.b.
  113
+authentication method (see 4.a), this happens automatically when a user selects
  114
+his home organization in the Moodle WAYF service or if the alternate login URL
  115
+is configured to be the protected /auth/shibboleth/index.php
  116
+Otherwise, the user has to click on the link on the dual login page you 
  117
+provided in step 5.b.
108 118
 
109 119
 Moodle basically checks whether the Shibboleth attribute that you mapped
110 120
 as the username is present. This attribute should only be present if a user is
@@ -132,7 +142,8 @@ to work, you have to set up the two authentication methods (e.g. 'Manual
132 142
 Accounts' and 'Shibboleth') and specify an alternate login link to your own dual
133 143
 login page. On that page you basically need a link to the Shibboleth-protected
134 144
 page ('/auth/shibboleth/index.php') for the Shibboleth login and a
135  
-form that sends 'username' and 'password' to moodle/login/index.php.
  145
+form that sends 'username' and 'password' to moodle/login/index.php. Set this 
  146
+web page then als alternate login page.
136 147
 Consult the Moodle documentation for further instructions and requirements.
137 148
 
138 149
 How to customize the way the Shibboleth user data is used in Moodle
@@ -190,4 +201,4 @@ Example file:
190 201
 
191 202
 --------------------------------------------------------------------------------
192 203
 In case of problems and questions with Shibboleth authentication, contact
193  
-Lukas Haemmerle <haemmerle@switch.ch> or Markus Hagman <hagman@hytti.uku.fi>
  204
+Lukas Haemmerle <lukas.haemmerle@switch.ch> or Markus Hagman <hagman@hytti.uku.fi>

0 notes on commit 3d46466

Please sign in to comment.
Something went wrong with that request. Please try again.