Skip to content

Commit

Permalink
[nojira]
Browse files Browse the repository at this point in the history
update documentation
  • Loading branch information
jj committed Oct 29, 2018
1 parent 8122a26 commit 3ce04ef
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 7 additions & 1 deletion docs/METADATAPROVIDERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`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.
8 changes: 7 additions & 1 deletion docs/METADATASOURCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`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.

0 comments on commit 3ce04ef

Please sign in to comment.