Use disabled template for mappings and lists
[cascardo/ipsilon.git] / README
diff --git a/README b/README
index 78f8ee2..dc4dae8 100644 (file)
--- a/README
+++ b/README
@@ -14,7 +14,8 @@ completely agnostic of what authentication infrastructure is being used.
 Applications can currently use the SAML2[2] protocol to talk to the Ipsilon
 identity provider, an application that uses SAML is called a Service Provider.
 
 Applications can currently use the SAML2[2] protocol to talk to the Ipsilon
 identity provider, an application that uses SAML is called a Service Provider.
 
-Ipsilon uses the LASSO[3] libraries an Python bindings to implement SAML support.
+Ipsilon uses the LASSO[3] libraries and Python bindings to implement SAML
+support.
 
 Ipsilon Server Installation
 ===========================
 
 Ipsilon Server Installation
 ===========================
@@ -62,10 +63,17 @@ Instances are configured to be available at https://hostname/instance
 So for a server called ipsilon.example.com, using the default installation
 options the IdP will be available at https://ipsilon.example.com/idp/
 
 So for a server called ipsilon.example.com, using the default installation
 options the IdP will be available at https://ipsilon.example.com/idp/
 
+The install script expects to find the keytab in /etc/httpd/conf/http.keytab
+
 NOTE: If you are installing Ipsilon in a FreeIPA[4] environment you can use the
 --ipa switch to simplify the deployment. Using the --ipa switch will allow the
 use of your IPA Kerberos administrative credentials to automatically provision
 NOTE: If you are installing Ipsilon in a FreeIPA[4] environment you can use the
 --ipa switch to simplify the deployment. Using the --ipa switch will allow the
 use of your IPA Kerberos administrative credentials to automatically provision
-a keytab for the HTTP service if one is not available yet.
+a keytab for the HTTP service if one is not available yet.  You will likely
+want to use the --admin-user option to specify the full principal of the user
+who will administer Ipsilon.  For example to use the FreeIPA admin user for
+the EXAMPLE.COM realm, you would use:
+
+ $ ipsilon-server-install --ipa --admin-user admin@EXAMPLE.COM
 
 Once the script has successfully completed the installation, restart the Apache
 HTTPD server to activate it.
 
 Once the script has successfully completed the installation, restart the Apache
 HTTPD server to activate it.