Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/serve-folders.rst @ 64:a3df3c2b68cf
import the documentation of the Worklists sample plugin
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 22 Nov 2016 13:02:56 +0100 |
parents | 34ccc7fc7ef3 |
children | 731d6c12f599 |
rev | line source |
---|---|
24 | 1 .. _serve-folders: |
2 | |
3 | |
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
4 Sample Serve Folders plugin |
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
5 =========================== |
24 | 6 |
7 This **official** plugin enables Orthanc to serve additional folders | |
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
8 from the filesystem using its embedded Web server. This plugin is |
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
9 extremely useful when creating new Web applications on the top of the |
34 | 10 REST API of Orthanc, as it allows to fulfill the :ref:`same-origin |
11 policy <same-origin>` without setting up a reverse proxy. | |
24 | 12 |
31
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
13 The source code of this sample plugin is `available in the source |
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
14 distribution of Orthanc |
93bbfaf0e62c
worklist instructions migrated to a specific page, indexing of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
15 <https://bitbucket.org/sjodogne/orthanc/src/default/Plugins/Samples/ServeFolders/>`__ |
63
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
16 (GPLv3+ license). |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
17 |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
18 |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
19 Basic usage |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
20 ----------- |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
21 |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
22 1. First, generate the :ref:`default configuration of Orthanc <configuration>`. |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
23 2. Then, modify the ``Plugins`` option to point to the folder containing |
64
a3df3c2b68cf
import the documentation of the Worklists sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
63
diff
changeset
|
24 the shared library of the plugin. |
63
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
25 3. Finally, create a section ``ServeFolders`` in the configuration file to |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
26 specify which folder you want to serve, and at which URI. |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
27 |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
28 .. highlight:: json |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
29 |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
30 For instance, the following excerpt would load the plugins from the |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
31 working directory, then would map the content of the folder |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
32 ``/home/jodogne/WWW/fosdem`` as URI "http://localhost:8042/fosdem":: |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
33 |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
34 { |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
35 [...] |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
36 "Plugins" : [ |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
37 "." |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
38 ], |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
39 "ServeFolders" : { |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
40 "/fosdem" : "/home/jodogne/WWW/fosdem" |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
41 } |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
42 } |
34ccc7fc7ef3
migrate the doc of ServeFolder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
34
diff
changeset
|
43 |