... | ... | @@ -51,6 +51,13 @@ The first `-f` option (prior to the `logs` sub-command) specifies the manifest f |
|
|
docker-compose -f compose/sonador.yaml restart
|
|
|
```
|
|
|
|
|
|
#### Next Steps
|
|
|
The Imaging Development Environment provides a self-contained deployment of the platform with object storage, data streaming, and database systems; in addition to the Sonador Web Application and Orthanc Imaging Database services.
|
|
|
|
|
|
* [Interacting With the Imaging Development Environment](dev.env-management) provides information on how to interact with and manage the environment, including details on how to initialize the database and create test users.
|
|
|
* [Sonador Web Application Architecture](dev.archtiecture-sonador) describes the Sonador Web Application internal application, dependencies, and patterns.
|
|
|
* [Orthanc Sonador Plugin Architecture](dev.orthanc-plugin) looks at the Orthanc Sonador Cloud Plugin, how it builds on the [Orthanc Python Plugin](https://book.orthanc-server.com/plugins/python.html), extends the database schema using SQLAlchemy, and interfaces with the Sonador Web Application for [authentication, authorization, and user management](https://www.oak-tree.tech/blog/sonador-security-auth).
|
|
|
|
|
|
|
|
|
### Container Images
|
|
|
Server deployed components within Sonador are packaged as [Docker container images](https://www.oak-tree.tech/blog/container-driven-development). Container images provide a clean and isolated runtime with a consistent, well-defined environment in a format that is portable and can be shared.
|
... | ... | @@ -146,7 +153,7 @@ Using Docker to develop Sonador and Orthanc involves: |
|
|
4. Reload source files from the local source folder by restarting the Docker containers (via the Compose manifest for the application group). _Alternatively, it is possible to update/restart services by using [Compose Watch](https://docs.docker.com/compose/file-watch/)._
|
|
|
|
|
|
##### Step 0: Create `src` folder in Imaging Environment
|
|
|
For local development, it is suggested that you create a folder within a clone of the Sonador Imaging Environment called `src`.
|
|
|
For local development, it is suggested that you create a folder within a clone of the Sonador Imaging Environment called `src`. _The instructions and examples on this page will reference `src` as the base folder for Orthanc and Sonador clones._
|
|
|
|
|
|
```bash
|
|
|
# Run commands from the root of the Sonador Imaging Environment
|
... | ... | @@ -155,7 +162,7 @@ For local development, it is suggested that you create a folder within a clone o |
|
|
mkdir src
|
|
|
```
|
|
|
|
|
|
Desired repository layout:
|
|
|
Desired Imaging Environment repository layout:
|
|
|
|
|
|
```
|
|
|
|- compose: Docker Compose Manifests
|
... | ... | @@ -169,9 +176,11 @@ Desired repository layout: |
|
|
|- <code repositories go here>
|
|
|
```
|
|
|
|
|
|
_Refer to [Interacting With the Imaging Development Environment](dev.env-management) for additional detail._
|
|
|
|
|
|
|
|
|
#### Sonador Web Application
|
|
|
The Sonador Web Application is a Django app written in Python. _Refer to [Sonador Web Application Architecture](dev.architecture-sonador) for additional detail._
|
|
|
The Sonador Web Application is a Django app written in Python. _Refer to [Sonador Web Application Architecture](dev.architecture-sonador) for architecture and additional detail._
|
|
|
|
|
|
##### Step 1: Create clone of Orthanc Sonador Plugin
|
|
|
Check out [Sonador Web Application](https://code.oak-tree.tech/oak-tree/medical-imaging/sonador) sources:
|
... | ... | @@ -203,6 +212,6 @@ TODO:Describe modifications needed to Sonador Compose manifest. |
|
|
|
|
|
|
|
|
#### Orthanc Sonador Plugin
|
|
|
The Orthanc Sonador Plugin integrates Orthanc with the Sonador web application and extends the medical imaging database with a number of useful API extensions. _Refer to [Orthanc Sonador Plugin Architecture](dev.orthanc-plugin) for additional detail._
|
|
|
The Orthanc Sonador Plugin integrates Orthanc with the Sonador web application and extends the medical imaging database with a number of useful API extensions. _Refer to [Orthanc Sonador Plugin Architecture](dev.orthanc-plugin) for architecture and additional detail._
|
|
|
|
|
|
TODO:Describe how to create a local (host) checkout of Orthanc dependencies which can be run from the container images via `volume` annotations. |