diff --git a/docs/METADATAPROVIDERS.md b/docs/METADATAPROVIDERS.md new file mode 100644 index 000000000..547dc6c3e --- /dev/null +++ b/docs/METADATAPROVIDERS.md @@ -0,0 +1,16 @@ +# Metadata providers + +The application can generate a `metadata-providers.xml` configuration appropriate for use in the Shibboleth IdP. +There are 2 ways to access this configuration: through a web endpoint or a file. + +1. Web endpoint + + A request can be made to the `${ui.baseUrl}/api/MetadataResolvers` to get the + current configuration + +2. File export + + A file can be periodically written to disk. Set the application property `shibui.metadataProviders.target`, + pointing to a spring file resource. Note that there is no value set by default, and nothing will be written + out by default. A file, once defined, will be written every 30 seconds by default. To change the rate, set the + `shibui.metadataProviders.taskRunRate` application property, in milliseconds. \ No newline at end of file diff --git a/docs/METADATASOURCES.md b/docs/METADATASOURCES.md new file mode 100644 index 000000000..1e628c46d --- /dev/null +++ b/docs/METADATASOURCES.md @@ -0,0 +1,15 @@ +# Metdata Sources + +Metadata sources in the UI are individual metadata artifacts describing single entities, typically +relying parties. There are 2 ways to access these artifacts. + +1. MDQ + + _To be written_ + +2. File export + + Files can be periodically written to disk. Define the application property `shibui.metadata-dir`, + and the files will be written out by default every 30 seconds. Note that there is no default value + set for this property and no file will be written by default. To change the run rate, set the + `shibui.taskRunRate` application property, in milliseconds. \ No newline at end of file