README
1Database plugins for Orthanc
2============================
3
4
5General information
6-------------------
7
8This repository contains the source code of various database plugins
9for Orthanc, the lightweight, RESTful DICOM server. These plugins
10enable Orthanc to store its index and its storage area within
11well-known relational databases systems (RDBMS).
12
13
14Content
15-------
16
17* ./Framework/ : code shared by all the plugins
18* ./MySQL/ : index and storage plugins for MySQL and MariaDB
19* ./PostgreSQL/ : index and storage plugins for PostgreSQL
20* ./SQLite/ : index plugin for SQLite (for experimentation)
21
22If you downloaded this project as a versioned release package
23(.tar.gz) focused on one given RDBMS, you will only find the folders
24that are related to this specific RDBMS. The full source code is
25available at:
26https://bitbucket.org/sjodogne/orthanc-databases/
27
28
29Compilation and usage
30---------------------
31
32The compilation and usage of the plugins is available in the Orthanc
33Book:
34
35* MySQL/MariaDB : http://book.orthanc-server.com/plugins/mysql.html
36* PostgreSQL : http://book.orthanc-server.com/plugins/postgresql.html
37
38
39Older releases of PostgreSQL
40----------------------------
41
42This repository supersedes the older "orthanc-postgresql" repository
43that was only focused on PostgreSQL.
44
45Releases <= 2.1 of the PostgreSQL plugins can still be found in the
46following legacy repository:
47https://bitbucket.org/sjodogne/orthanc-postgresql/
48
49
50Licensing
51---------
52
53The database plugins for Orthanc are licensed under the AGPL license.
54
55We also kindly ask scientific works and clinical studies that make
56use of Orthanc to cite Orthanc in their associated publications.
57Similarly, we ask open-source and closed-source products that make
58use of Orthanc to warn us about this use. You can cite our work
59using the following BibTeX entry:
60
61@Article{Jodogne2018,
62 author="Jodogne, S{\'e}bastien",
63 title="The {O}rthanc Ecosystem for Medical Imaging",
64 journal="Journal of Digital Imaging",
65 year="2018",
66 month="Jun",
67 day="01",
68 volume="31",
69 number="3",
70 pages="341--352",
71 issn="1618-727X",
72 doi="10.1007/s10278-018-0082-y",
73 url="https://doi.org/10.1007/s10278-018-0082-y"
74}
75