From 3ce04ef49a463daef14750c55d178bd844b6cb89 Mon Sep 17 00:00:00 2001 From: Jj! Date: Mon, 29 Oct 2018 11:05:38 -0500 Subject: [PATCH] [nojira] update documentation --- docs/METADATAPROVIDERS.md | 8 +++++++- docs/METADATASOURCES.md | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/METADATAPROVIDERS.md b/docs/METADATAPROVIDERS.md index 547dc6c3e..32d02149b 100644 --- a/docs/METADATAPROVIDERS.md +++ b/docs/METADATAPROVIDERS.md @@ -13,4 +13,10 @@ There are 2 ways to access this configuration: through a web endpoint or a file. 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 + `shibui.metadataProviders.taskRunRate` application property, in milliseconds. + +## Docker considerations + +If writing the file out, one should use a mount in the docker container for the destination. While a bind mount +might be easiest, if running on a Windows host, one might run into problems. This is easily avoided by using a +volume instead. Refer to [https://docs.docker.com/storage/] for more information. \ No newline at end of file diff --git a/docs/METADATASOURCES.md b/docs/METADATASOURCES.md index 1e628c46d..2ec2563b6 100644 --- a/docs/METADATASOURCES.md +++ b/docs/METADATASOURCES.md @@ -12,4 +12,10 @@ relying parties. There are 2 ways to access these artifacts. 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 + `shibui.taskRunRate` application property, in milliseconds. + +## Docker considerations + +If writing the files out, one should use a mount in the docker container for the destination. While a bind mount +might be easiest, if running on a Windows host, one might run into problems. This is easily avoided by using a +volume instead. Refer to [https://docs.docker.com/storage/] for more information. \ No newline at end of file