From 9a9ce4b1f0bc142eca93a9a91a77613022b71502 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20=C3=85kre=20Solberg?= <andreas.solberg@uninett.no>
Date: Mon, 28 Apr 2008 09:49:28 +0000
Subject: [PATCH] Documented the dynamic entity id functionality and the
default host name func.
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@524 44740490-163a-0410-bde0-09ae8108e29a
---
docs/source/simplesamlphp-idp.xml | 18 +++++++++++++--
docs/source/simplesamlphp-sp.xml | 38 +++++++++++++++++++++++++------
2 files changed, 47 insertions(+), 9 deletions(-)
diff --git a/docs/source/simplesamlphp-idp.xml b/docs/source/simplesamlphp-idp.xml
index f0a9f8fe2..288d56124 100644
--- a/docs/source/simplesamlphp-idp.xml
+++ b/docs/source/simplesamlphp-idp.xml
@@ -7,7 +7,7 @@
<articleinfo>
<date>2007-10-15</date>
- <pubdate>Tue Apr 22 10:22:44 2008</pubdate>
+ <pubdate>Mon Apr 28 11:48:30 2008</pubdate>
<author>
<firstname>Andreas Ă…kre</firstname>
@@ -273,6 +273,17 @@ openssl x509 -req -days 60 -in server2.csr -signkey server2.key -out server2.crt
<glossdef>
<para>The entity ID of the IdP. In this example:
<literal>idp.example.org</literal>.</para>
+
+ <para>simpleSAMLphp supports dynamic entityIDs that matches a
+ URL where simpleSAMLphp automatically generates metadata for the
+ hosted entity. To enable this functionality, set the index to be
+ <literal>__DYNAMIC:1__</literal>. The index needs to be unique,
+ so when you have multiple entries, increase the integer after
+ the colon. When the index <literal>__DYNAMIC:1__</literal> is
+ used, the resulting generated entity becomes something
+ like:</para>
+
+ <literallayout>https://sp.example.org/simplesaml/saml2/idp/metadata.php</literallayout>
</glossdef>
</glossentry>
@@ -280,7 +291,10 @@ openssl x509 -req -days 60 -in server2.csr -signkey server2.key -out server2.crt
<glossterm>host</glossterm>
<glossdef>
- <para>Host name of the server running this IdP.</para>
+ <para>Host name of the server running this IdP. One of your
+ metadata entries can have the value
+ <literal>__DEFAULT__</literal>. A default entry will be used
+ when no other entry matches the current hostname.</para>
</glossdef>
</glossentry>
diff --git a/docs/source/simplesamlphp-sp.xml b/docs/source/simplesamlphp-sp.xml
index 76d0ccc99..ee67158c6 100644
--- a/docs/source/simplesamlphp-sp.xml
+++ b/docs/source/simplesamlphp-sp.xml
@@ -7,7 +7,7 @@
<articleinfo>
<date>2007-10-15</date>
- <pubdate>Tue Apr 22 10:23:15 2008</pubdate>
+ <pubdate>Mon Apr 28 11:48:32 2008</pubdate>
<author>
<firstname>Andreas Ă…kre</firstname>
@@ -149,6 +149,17 @@
<glossdef>
<para>The entity ID of the hosted SP entity.</para>
+
+ <para>simpleSAMLphp supports dynamic entityIDs that matches a
+ URL where simpleSAMLphp automatically generates metadata for the
+ hosted entity. To enable this functionality, set the index to be
+ <literal>__DYNAMIC:1__</literal>. The index needs to be unique,
+ so when you have multiple entries, increase the integer after
+ the colon. When the index <literal>__DYNAMIC:1__</literal> is
+ used, the resulting generated entity becomes something
+ like:</para>
+
+ <literallayout>https://sp.example.org/simplesaml/saml2/sp/metadata.php</literallayout>
</glossdef>
</glossentry>
@@ -156,9 +167,10 @@
<glossterm>host</glossterm>
<glossdef>
- <para>Host name of the web server running this SAML 2.0 SP. This
- option allows simpleSAMLphp to automatically discover which SP
- metadata to use, when it runs multiple virtual hosts.</para>
+ <para>Host name of the server running this SP. One of your
+ metadata entries can have the value
+ <literal>__DEFAULT__</literal>. A default entry will be used
+ when no other entry matches the current hostname.</para>
</glossdef>
</glossentry>
</glosslist>
@@ -588,6 +600,17 @@
<glossdef>
<para>The entity ID of the hosted SP entity.</para>
+
+ <para>simpleSAMLphp supports dynamic entityIDs that matches a
+ URL where simpleSAMLphp automatically generates metadata for the
+ hosted entity. To enable this functionality, set the index to be
+ <literal>__DYNAMIC:1__</literal>. The index needs to be unique,
+ so when you have multiple entries, increase the integer after
+ the colon. When the index <literal>__DYNAMIC:1__</literal> is
+ used, the resulting generated entity becomes something
+ like:</para>
+
+ <literallayout>https://sp.example.org/simplesaml/shib13/sp/metadata.php</literallayout>
</glossdef>
</glossentry>
@@ -595,9 +618,10 @@
<glossterm>host</glossterm>
<glossdef>
- <para>The hostname of the server running this Shibboleth 1.3 SP.
- This option allows simpleSAMLphp to automatically discover which
- SP metadata to use, when it runs multiple virtual hosts.</para>
+ <para>Host name of the server running this SP. One of your
+ metadata entries can have the value
+ <literal>__DEFAULT__</literal>. A default entry will be used
+ when no other entry matches the current hostname.</para>
</glossdef>
</glossentry>
</glosslist>
--
GitLab