continuing work on getting started and troubleshooting

Sustainsys · Jan 27, 2018 · 35f8c99 · 35f8c99
1 parent b373299
commit 35f8c99
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
@@ -3,6 +3,13 @@ Getting Started
 See the sections below which contain information that will help you get started adding SAML2P support into 
 your flavor of ASP.NET.
 
+If you have gotten the appropriate Nuget package installed and then completed the configuration 
+described below and are having any trouble, make sure to check out the :doc:`Troubleshooting <troubleshooting>` for assistance.
+
+A sample SAML identity provider is available to further assist you in getting started if you don't already 
+have a SAML identity provider that you can test with.  You can access it directly at https://stubidp.sustainsys.com, 
+or you can download the solution to run it locally yourself (it's a project within the `Sustainsys.Saml2 github repository <https://github.com/Sustainsys/Saml2>`_).
+
 ASP.NET Web Forms
 -----------------
 The ``Saml2AuthenticationModule`` provides Saml2 authentication to IIS web sites. In many cases it should just be 

diff --git a/docs/index.rst b/docs/index.rst
@@ -30,4 +30,6 @@ See :doc:`getting-started` for all the details.
    getting-started
    configuration
    owin-middleware
+   troubleshooting
+
 
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
@@ -0,0 +1,12 @@
+Troubleshooting
+===============
+If you're having trouble - don't give up!  :)
+
+The items below may point you in the right direction.
+
+* Check the `issues archive <https://github.com/Sustainsys/Saml2/issues>`_.
+* Check the `SAML2 specification <http://saml.xml.org/saml-specifications>`_, starting with the core section, or the newer `OASIS Saml Wiki <https://wiki.oasis-open.org/security/FrontPage>`_.
+* Log your actual SAML2 conversation with `SAML Chrome Panel <https://chrome.google.com/webstore/detail/saml-chrome-panel/paijfdbeoenhembfhkhllainmocckace>`_ or `SAML Tracer for Firefox <https://addons.mozilla.org/en-US/firefox/addon/saml-tracer/>`_.
+* Connect an ``ILoggerAdapter`` to your ``SPOptions.Logger``. If you are using the ``OWIN`` middleware this is done for you automatically and you can see the output in the OWIN/Katana logging.
+* Last but not least, download the Saml2 source and check out what's really happening.
+