X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=7955caa35ca9269f01ec5c2c6ea46846ca1a8f3b;hb=HEAD;hp=5bafe8e91d2890acb5594de849fcb960b906c4c0;hpb=e6f558aafe4b1156d7823193a1659bef559d185c;p=catagits%2FCatalyst-Authentication-Store-LDAP.git diff --git a/README b/README index 5bafe8e..7955caa 100644 --- a/README +++ b/README @@ -193,7 +193,7 @@ CONFIGURATION OPTIONS identifier for the user. user_search_options - This takes a hashref. It will append it's values to the call to + This takes a hashref. It will append its values to the call to Net::LDAP's "search" method during the initial user lookup. See Net::LDAP for valid options. @@ -256,7 +256,7 @@ CONFIGURATION OPTIONS role_filter. If this is set to "dn", we will use the User Objects DN. role_search_options - This takes a hashref. It will append it's values to the call to + This takes a hashref. It will append its values to the call to Net::LDAP's "search" method during the user's role lookup. See Net::LDAP for valid options. @@ -275,19 +275,20 @@ CONFIGURATION OPTIONS instead be performed when bound as the user you authenticated as. persist_in_session - Can take one of the following values, defaults to *username*: + Can take one of the following values, defaults to "username": - username - Only store the username in the session and lookup the user and its roles - on every request. That was how the module worked until version 1.015 and - is also the default for backwards compatibility. + "username" + Only store the username in the session and lookup the user and its + roles on every request. That was how the module worked until version + 1.015 and is also the default for backwards compatibility. - all - Store the user object and its roles in the session and never look it up - in the store after login. + "all" + Store the user object and its roles in the session and never look it + up in the store after login. - NOTE: It's recommended to limit the user attributes fetched from LDAP - using user_search_options / attrs to not exhaust the session store.. + NOTE: It's recommended to limit the user attributes fetched from + LDAP using "user_search_options" / "attrs" to not exhaust the + session store. entry_class The name of the class of LDAP entries returned. This class should exist