diff options
| author | Nikos Sklikas <nsklikas@admin.grnet.gr> | 2019-10-15 16:50:58 +0300 |
|---|---|---|
| committer | Ivan Kanakarakis <ivan.kanak@gmail.com> | 2019-12-26 17:14:14 +0200 |
| commit | 7fd1719ffe942e59273971776db1a925255848e9 (patch) | |
| tree | 63e598abfb025fd7fc4751749df9661f15437893 | |
| parent | 08a071da1383811e3df1d888036f7381ec11aacd (diff) | |
| download | pysaml2-7fd1719ffe942e59273971776db1a925255848e9.tar.gz | |
Update documentation with mdq freshness_period
| -rw-r--r-- | docs/howto/config.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/howto/config.rst b/docs/howto/config.rst index 0e3be8a8..91195b34 100644 --- a/docs/howto/config.rst +++ b/docs/howto/config.rst @@ -209,6 +209,7 @@ For example:: { "url": "http://mdq.ukfederation.org.uk/", "cert": "ukfederation-mdq.pem", + "freshness_period": "P0Y0M0DT2H0M0S", }, ], }, @@ -221,6 +222,14 @@ metadata signing certificates should be used. These public keys must be acquired by some secure out-of-band method before being placed on the local file system. +When using MDQ, the `freshness_period` option can be set to define +a period for which the metadata fetched from the the MDQ server are considered +fresh. After that period has passed the metadata are not valid anymore and must +be fetched again. The period must be in the format defined in `iso 8601 <https://www.iso.org/iso-8601-date-and-time-format.html>`_. + +By default, if `freshness_period` is not defined, the metadata are fetched +only the first time they are requested and never refreshed. + organization ^^^^^^^^^^^^ |