Mercurial > hg > orthanc

annotate Plugins/Samples/ServeFolders/README @ 1914:501769757bf9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
flag to remove network support in dcmtk, removal of unneeded sources in static builds
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 09 Feb 2016 11:47:02 +0100
parents 9c2ffc4e938b
children 13a9f265d5d3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1324
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 Introduction
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 ============
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 This sample plugin enables Orthanc to serve additional folders using
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 its embedded Web server.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 Compilation for Linux
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 =====================
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 # mkdir Build
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 # cd Build
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 # cmake ..
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 # make
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 Cross-compilation for Windows using MinGW
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 =========================================
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 # mkdir Build
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 # cd Build
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 # cmake .. -DCMAKE_TOOLCHAIN_FILE=../../../Resources/MinGWToolchain.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 # make
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 Configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 =============
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 First, generate the default configuration of Orthanc:
1808
9c2ffc4e938b configuration of the sample modality worklists plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1324
diff changeset
30 https://orthanc.chu.ulg.ac.be/book/users/configuration.html
1324
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 Then, modify the "Plugins" option to point to the folder containing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 the built plugins.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 Finally, create a section "ServeFolders" in the configuration file to
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 specify which folder you want to serve, and at which URI. For
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 instance, the following excerpt would load the plugins from the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 working directory, then would branch the content of the folder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 "/home/jodogne/WWW/fosdem" as the URI "http://localhost:8042/fosdem":
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 "Name" : "MyOrthanc",
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 [...]
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 "HttpPort" : 8042,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 [...]
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 "Plugins" : [
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 "."
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 ],
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 "ServeFolders" : {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 "/fosdem" : "/home/jodogne/WWW/fosdem"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 }