Add id_attr LDAP attribute to opensrf.xml.example
authorDan Scott <dscott@laurentian.ca>
Thu, 8 Mar 2012 18:36:04 +0000 (13:36 -0500)
committerDan Wells <dbw2@calvin.edu>
Sat, 10 Mar 2012 02:53:01 +0000 (21:53 -0500)
Also add a Release Notes entry for the authentication proxy service.

Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Dan Wells <dbw2@calvin.edu>
Open-ILS/examples/opensrf.xml.example
docs/RELEASE_NOTES_2_2.txt

index 82c55e7..ea6f18b 100644 (file)
@@ -393,6 +393,7 @@ vim:et:ts=4:sw=4:
                             <hostname>name.domain.com</hostname>
                             <basedn>ou=people,dc=domain,dc=com</basedn>
                             <authid>cn=username,ou=specials,dc=domain,dc=com</authid>
+                            <id_attr>uid</id_attr>
                             <password>my_ldap_password_for_authid_user</password>
                             <login_types>
                                 <type>staff</type>
index 036eef9..ecd0808 100644 (file)
@@ -98,6 +98,27 @@ may be particularly useful for libraries that have defined one set of copy
 locations at the consortial level and want to enable quick keyboard navigation
 to copy locations by typing just the first letters of the copy location.
 
+Authentication proxy
+~~~~~~~~~~~~~~~~~~~~
+To support integration of Evergreen with organizational authentication systems,
+and to reduce the proliferation of user names and passwords, Evergreen offers 
+a new service called `open-ils.auth_proxy`. If you enable the service,
+`open-ils.auth_proxy` supports different authentication mechanisms
+that implement the `authenticate` method. You can define a chain of these
+authentication mechanisms to be tried in order within the `<authenticators>`
+element of the `opensrf.xml` configuration file, with the option of falling
+back to the `native` mode that uses Evergreen's internal method of password
+authentication.
+
+This service only provides authentication; there is no support for automatic
+provisioning of accounts. To authenticate against any authentication system,
+the user account must first be defined within the Evergreen system, and
+authentication will be based on the user name as it exists in Evergreen.
+
+A sample authentication mechanism for LDAP is provided in
+`Open-ILS::Application::AuthProxy::LDAP_AUTH`, and corresponding sample
+attributes can be found in `opensrf.xml.example`.
+
 Reports
 ~~~~~~~