README.markdown in shibboleths_lil_helper-1.0.0 vs README.markdown in shibboleths_lil_helper-1.0.1
- old
+ new
@@ -8,30 +8,16 @@
* __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.
-IMPORTANT NOTE/DISCLAIMER
+DISCLAIMER
-------------------------
All you see here on Github is the readme, no code yet.
-For that to happen two things need to occur:
+This is released as a RubyGem right now, we hope to push the source up
+here once things stabilize further
-* We need to battle-test the (working) code across our entire
- infrastructure and fix bugs before releasing.
-
-* Someone from the IDM team within OIT needs approve that our approach
- is solid and endorse its usage for the U of M.
-
-**The current status as of October 6th, 2011**
-
-* We have it working in PHP, .NET, and Rails on 2 servers and 4 vhosts for Apache and IIS.
-
-* Assuming no snags (cause that never happens in software, :)), we
-anticipate 90% of our infrastructure migrated by Nov 1st. At which
-point we hope to release this code into the wild. And perhaps do a demo
-session at a Code-People meeting.
-
Why another tool?
-----------------
We needed something that could help manage shibboleth SP
configuration consistently with minimal manual work for:
@@ -45,20 +31,15 @@
============
* Pre-requisites:
* Rubygems: http://rubygems.org/pages/download
* Bundler: gem install bundler
-* From github:
+* Via Ruby Gems:
+ * gem install shibboleths_lil_helper
+ * Then type `slh` -- this provides more detailed/actionable
+ documentation
- git clone git://github.com/joegoggins/shibboleths_lil_helper.git
- cd shibboleths_lil_helper
- bundle
- ./bin/slh
- (then follow instructions)
-
-* Via Ruby Gems: Not working yet
-
Assumptions
===========
* Shibboleth Native Service Provider Apache/IIS is already installed on your target web servers.
* The X509Certificate (sp-cert.pem, sp-key.pem) keys are in their default locations along-side shibboleth2.xml. This tool does not help you generate these keys, that's up to you. The default installation of Native Shib generates keys for you though.
* The Shibboleth apache module is loaded globally for all vHosts
@@ -187,10 +168,10 @@
Email Us
----------------------
* Let us know you are interested in using the tool.
-* Voice you ideas about questions you have and features you'd like to see.
+* Voice your ideas about questions you have and features you'd like to see.
Authors
=======
* Joe Goggins, Academic Support Resources, goggins@umn.edu
* Chris Dinger, Academic Support Resources, ding0057@umn.edu