# HG changeset patch
# User Sebastien Jodogne <s.jodogne@gmail.com>
# Date 1490197542 -3600
# Node ID 750f7ab733c1fdfff3fb6c36d720d269ba774500
# Parent  065350232191e8717ea887deb1b003c49d413f4e
start documentation of authorization

diff -r 065350232191 -r 750f7ab733c1 Sphinx/source/plugins.rst
--- a/Sphinx/source/plugins.rst	Wed Mar 15 10:31:26 2017 +0100
+++ b/Sphinx/source/plugins.rst	Wed Mar 22 16:45:42 2017 +0100
@@ -37,6 +37,9 @@
 Index of the official plugins
 -----------------------------
 
+From University Hospital of Liège
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. toctree::
    :maxdepth: 1
 
@@ -47,17 +50,21 @@
    plugins/worklists-plugin.rst
    plugins/serve-folders.rst
 
+From Osimis
+^^^^^^^^^^^
+
+* :ref:`authorization`
+* `Osimis <http://osimis.io/>`__ maintains an evolution of the
+  official Web viewer plugin. The Osimis plugin adds tools for
+  measuring, for viewing multiple series, and for split-pane. `Check
+  out the source code
+  <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__.
 
 .. _plugins-contributed:
 
 Index of the contributed plugins
 --------------------------------
 
-* `Osimis <http://osimis.io/>`__ maintains an evolution of the
-  official Web viewer plugin. The Osimis plugin adds tools for
-  measuring, for viewing multiple series, and for split-pane.  `Check
-  out their source code
-  <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__.
 * `DWV Orthanc Plugin
   <https://github.com/ivmartel/dwv-orthanc-plugin>`__: This plugin by
   Yves Martelli is based on `dwv
diff -r 065350232191 -r 750f7ab733c1 Sphinx/source/plugins/authorization.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/plugins/authorization.rst	Wed Mar 22 16:45:42 2017 +0100
@@ -0,0 +1,62 @@
+.. _authorization:
+
+
+Advanced authorization plugin
+=============================
+
+.. contents::
+
+This **official plugin by Osimis** extends Orthanc with advanced
+authorization mechanism.
+
+For each incoming REST request to some URI, the plugin will query a
+Web service to know whether the access is granted to the
+user. Authorization credentials can be retrieved either from a GET
+argument, or from a HTTP header.
+
+Compilation
+-----------
+
+.. highlight:: bash
+
+The procedure to compile these plugins is similar of that for the
+:ref:`core of Orthanc <binaries>`. The following commands should work
+for every UNIX-like distribution (including GNU/Linux)::
+
+  $ mkdir Build
+  $ cd Build
+  $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
+  $ make
+
+The compilation will produce a shared library ``OrthancAuthorization``
+that contains the authorization plugin.
+
+Usage
+-----
+
+.. highlight:: json
+
+You of course first have to :ref:`install Orthanc <compiling>`. Once
+Orthanc is installed, you must change the :ref:`configuration file
+<configuration>` to tell Orthanc where it can find the plugin: This is
+done by properly modifying the ``Plugins`` option. You could for
+instance use the following configuration file::
+
+  {
+    "Name" : "MyOrthanc",
+    [...]
+    "Plugins" : [
+      "/home/user/OrthancAuthorization/Build/libOrthancAuthorization.so"
+    ]
+  }
+
+.. highlight:: text
+
+Orthanc must of course be restarted after the modification of its
+configuration file.
+
+Configuration
+-------------
+
+WIP
+