Mercurial > hg > orthanc-book
changeset 63:34ccc7fc7ef3
migrate the doc of ServeFolder
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 22 Nov 2016 12:25:28 +0100 |
parents | 4b332c3d7824 |
children | a3df3c2b68cf |
files | Sphinx/source/plugins/serve-folders.rst |
diffstat | 1 files changed, 28 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/plugins/serve-folders.rst Tue Nov 22 11:33:43 2016 +0100 +++ b/Sphinx/source/plugins/serve-folders.rst Tue Nov 22 12:25:28 2016 +0100 @@ -13,4 +13,31 @@ The source code of this sample plugin is `available in the source distribution of Orthanc <https://bitbucket.org/sjodogne/orthanc/src/default/Plugins/Samples/ServeFolders/>`__ -(GPLv3 license). +(GPLv3+ license). + + +Basic usage +----------- + +1. First, generate the :ref:`default configuration of Orthanc <configuration>`. +2. Then, modify the ``Plugins`` option to point to the folder containing + the built shared library. +3. Finally, create a section ``ServeFolders`` in the configuration file to + specify which folder you want to serve, and at which URI. + +.. highlight:: json + +For instance, the following excerpt would load the plugins from the +working directory, then would map the content of the folder +``/home/jodogne/WWW/fosdem`` as URI "http://localhost:8042/fosdem":: + + { + [...] + "Plugins" : [ + "." + ], + "ServeFolders" : { + "/fosdem" : "/home/jodogne/WWW/fosdem" + } + } +