# HG changeset patch # User Sebastien Jodogne # Date 1479813943 -3600 # Node ID 13a9f265d5d35f74fd954dfc302df53ad7aaecba # Parent 6a2374a974cd225fe1c996554d5f95d2c4b2b7fa migrate the doc of ServeFolder to Orthanc Book diff -r 6a2374a974cd -r 13a9f265d5d3 Plugins/Samples/ServeFolders/README --- a/Plugins/Samples/ServeFolders/README Tue Nov 22 11:40:05 2016 +0100 +++ b/Plugins/Samples/ServeFolders/README Tue Nov 22 12:25:43 2016 +0100 @@ -1,52 +1,11 @@ -Introduction -============ +ServeFolders plugin +=================== This sample plugin enables Orthanc to serve additional folders using its embedded Web server. - -Compilation for Linux -===================== - -# mkdir Build -# cd Build -# cmake .. -# make - - -Cross-compilation for Windows using MinGW -========================================= - -# mkdir Build -# cd Build -# cmake .. -DCMAKE_TOOLCHAIN_FILE=../../../Resources/MinGWToolchain.cmake -# make - - -Configuration -============= +The shared library containing the plugin is created as part of the +build process of Orthanc. -First, generate the default configuration of Orthanc: -https://orthanc.chu.ulg.ac.be/book/users/configuration.html - -Then, modify the "Plugins" option to point to the folder containing -the built plugins. - -Finally, create a section "ServeFolders" in the configuration file to -specify which folder you want to serve, and at which URI. For -instance, the following excerpt would load the plugins from the -working directory, then would branch the content of the folder -"/home/jodogne/WWW/fosdem" as the URI "http://localhost:8042/fosdem": - -{ - "Name" : "MyOrthanc", - [...] - "HttpPort" : 8042, - [...] - "Plugins" : [ - "." - ], - "ServeFolders" : { - "/fosdem" : "/home/jodogne/WWW/fosdem" - } -} +Documentation is available in the Orthanc Book: +http://book.orthanc-server.com/plugins/serve-folders.html