README.markdown in shibboleths_lil_helper-1.0.4 vs README.markdown in shibboleths_lil_helper-1.0.5

- old
+ new

@@ -1,18 +1,22 @@ About ===== Shibboleth's Lil Helper (slh) is a tool that automates the generation of Apache/IIS Shibboleth Native Service Provider configuration & metadata files. It provides several benefits over manually configuring each NativeSp instance/server by: -* __Providing a consistent configuration approach__ you can apply uniformly across all of the servers managed by your organization. - * Makes deployment automation possible, errors less frequent, and troubleshooting easier. +* __Providing a consistent configuration approach__ applied uniformly across all servers in your organization. +* __Providing conceptually simple linear process__ that distills the main steps associated with Shibboleth integration. + +* __Verifying metadata consistency__ across sites & hosts associated with particular Shibboletht SP entity_id. + * __Dividing high level auth specs from actual NativeSp configuration__ * Programmers can focus on high level goals like "protect files underneath the '/secure' directory on 'somewebsite.com'" rather than grappeling with the bewildering complexity of the NativeSp's interrelated XML files, the Shibboleth protocal, SAML, etc. -* __Providing conceptually simple linear process__ that distills the main steps associated with Shibboleth integration. +__This code is under active development as of 11/12/2011__. +Please watch this Github repo or periodically check CHANGLOG.markdown to stay to up-to-date. -* __Verifying metadata consistency__ across sites & hosts associated with particular Shibboletht SP entity_id. +Use `gem update shibboleths_lil_helper` to get the most current version. Why another tool? ----------------- We needed something that could help manage shibboleth SP configuration consistently with minimal manual work for: @@ -83,10 +87,13 @@ Assumptions ----------- * Each host integrates with a single Identity Provider, not multiple. -* (for Apache) The Shibboleth apache module is loaded globally for all vHosts. +* (for Apache) The Shibboleth apache module is loaded globally for all + vHosts. (This doesn't mean that it requires auth globally--just available). +* shibboleth-2.4.3 is installed on your target hosts. Versions greater than this should + work too, but have not been tested. Concept ------- All configuration and authentication specs for all Shibboleth SP instances are specified in a single ruby parseable `shibboleths_lil_helper/config.rb` file. From these specs, slh is capable of generating all of the required XML files you will need to integrate with a Shibboleth Identify Provider (Idp). The following breaks down the essential steps.