Mercurial > hg > orthanc

comparison Plugins/Samples/ServeFolders/README @ 2164:13a9f265d5d3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
migrate the doc of ServeFolder to Orthanc Book
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 22 Nov 2016 12:25:43 +0100
parents 9c2ffc4e938b
children
comparison
equal deleted inserted replaced
2163:6a2374a974cd 2164:13a9f265d5d3
1 Introduction 1 ServeFolders plugin
2 ============ 2 ===================
3 3
4 This sample plugin enables Orthanc to serve additional folders using 4 This sample plugin enables Orthanc to serve additional folders using
5 its embedded Web server. 5 its embedded Web server.
6 6
7 The shared library containing the plugin is created as part of the
8 build process of Orthanc.
7 9
8 Compilation for Linux 10 Documentation is available in the Orthanc Book:
9 ===================== 11 http://book.orthanc-server.com/plugins/serve-folders.html
10
11 # mkdir Build
12 # cd Build
13 # cmake ..
14 # make
15
16
17 Cross-compilation for Windows using MinGW
18 =========================================
19
20 # mkdir Build
21 # cd Build
22 # cmake .. -DCMAKE_TOOLCHAIN_FILE=../../../Resources/MinGWToolchain.cmake
23 # make
24
25
26 Configuration
27 =============
28
29 First, generate the default configuration of Orthanc:
30 https://orthanc.chu.ulg.ac.be/book/users/configuration.html
31
32 Then, modify the "Plugins" option to point to the folder containing
33 the built plugins.
34
35 Finally, create a section "ServeFolders" in the configuration file to
36 specify which folder you want to serve, and at which URI. For
37 instance, the following excerpt would load the plugins from the
38 working directory, then would branch the content of the folder
39 "/home/jodogne/WWW/fosdem" as the URI "http://localhost:8042/fosdem":
40
41 {
42 "Name" : "MyOrthanc",
43 [...]
44 "HttpPort" : 8042,
45 [...]
46 "Plugins" : [
47 "."
48 ],
49 "ServeFolders" : {
50 "/fosdem" : "/home/jodogne/WWW/fosdem"
51 }
52 }