From 053415a24963516f554ae4b6a9786be070c2f283 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 16:37:46 +0545 Subject: [PATCH 01/39] update description of the app --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8540d6a9..d48d98d2 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://github.com/owncloud/web) to preview DICOM files (medical images and their corresponding metadata) in the browser. The preview of the medical images is based on MIT licensed [cornerstone3D](https://github.com/cornerstonejs/cornerstone3D). -The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom, rotate, flip, invert and reset of the image preview. The UI is implemented in responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. +The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. + ## Quick reference From ecc4b6158aea921e988c19901b59a9cf85ccd228 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 16:43:58 +0545 Subject: [PATCH 02/39] adding pics to the description --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d48d98d2..8f587fa3 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,12 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. +![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png) +All corresponding metadata of the DICOM file are displayed in the sidebar. + +![app functionalities](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/3.png) +The extension allows to zoom, rotate, flip and even invert the colours of the preview of the DICOM image. + ## Quick reference From 57d83759fafc06aef7265614fb9aea57fbdb01d8 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 16:46:48 +0545 Subject: [PATCH 03/39] formatting of pictures --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 8f587fa3..37dfbd4e 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,9 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. +![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png "title-1") ![app functionalities](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/3.png "title-2") + + ![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png) All corresponding metadata of the DICOM file are displayed in the sidebar. From 8208e9b9d8f9b58fb43753acfe74967d7f93de5d Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 16:48:50 +0545 Subject: [PATCH 04/39] display pics in one row --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 37dfbd4e..61c339d5 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. -![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png "title-1") ![app functionalities](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/3.png "title-2") +![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png "title-1" =50%x) ![app functionalities](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/3.png "title-2" =50%x) ![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png) From 786c2055cd02874d456d452e779b188ad1c56112 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 16:52:52 +0545 Subject: [PATCH 05/39] formatting of images --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 61c339d5..b32e200c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,9 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. -![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png "title-1" =50%x) ![app functionalities](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/3.png "title-2" =50%x) +display of metadata +app functionalities + ![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png) From 1c2f2c2e921e1e9aac99fd89c16cc361b3ad3f56 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 17:02:04 +0545 Subject: [PATCH 06/39] update styling of pictures --- README.md | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b32e200c..f52bd285 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,9 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. -display of metadata -app functionalities +app functionalities     display of metadata - - -![display of metadata](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/4.png) -All corresponding metadata of the DICOM file are displayed in the sidebar. - -![app functionalities](https://github.com/owncloud/awesome-ocis/blob/main/webApps/owncloud/web-app-dicom-viewer/screenshots/3.png) -The extension allows to zoom, rotate, flip and even invert the colours of the preview of the DICOM image. +_The extension allows to zoom, rotate, flip and invert the colours of the preview of the DICOM image and all corresponding metadata of the DICOM file are displayed in the sidebar._ ## Quick reference From 4e955d537cbb831dd058bf2a2d081086034caca7 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 17:08:03 +0545 Subject: [PATCH 07/39] add table of content --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index f52bd285..5a006d15 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,14 @@ The current implementation allows to preview .dcm files and display their corres _The extension allows to zoom, rotate, flip and invert the colours of the preview of the DICOM image and all corresponding metadata of the DICOM file are displayed in the sidebar._ +## Table of Contents + +* [Functionalities of the app](#) +* [Installation instructions for developers](#) +* [Installation instructions](#) +* [Contribution](#) + + ## Quick reference - **Where to file issues:**\ From 00c6c51bc11831ca9c4c10b11f7116a7f12c465d Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 17:25:32 +0545 Subject: [PATCH 08/39] add more screenshots and move detail description down --- README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5a006d15..4209e438 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,29 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://github.com/owncloud/web) to preview DICOM files (medical images and their corresponding metadata) in the browser. The preview of the medical images is based on MIT licensed [cornerstone3D](https://github.com/cornerstonejs/cornerstone3D). -The current implementation allows to preview .dcm files and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. - -app functionalities     display of metadata - -_The extension allows to zoom, rotate, flip and invert the colours of the preview of the DICOM image and all corresponding metadata of the DICOM file are displayed in the sidebar._ - ## Table of Contents -* [Functionalities of the app](#) +* [Functionalities of the app](#Functionalities of the DICOM Viewer Web Extension) * [Installation instructions for developers](#) * [Installation instructions](#) * [Contribution](#) +TODO: update TOC! + + +## Functionalities of the DICOM Viewer Web Extension + +The current release allows to preview .dcm files within oCIS and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. + +app functionalities     display of metadata + +_The extension allows to preview a DICOM image and it's most important meta data. On request, all corresponding metadata of the file are displayed in the sidebar._ + +app functionalities     display of metadata + +_The extension allows to zoom, rotate and flip the preview of the image. Inverting the colors of the preview is also supported._ + ## Quick reference @@ -29,6 +38,8 @@ _The extension allows to zoom, rotate, flip and invert the colours of the previe - **Supported architectures:**\ `amd64` + + ## Installation ### 1. Install dependencies From f707b5f063ff632983df51b772b15d97470e346c Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 17:26:03 +0545 Subject: [PATCH 09/39] add draft for installation instructions --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 4209e438..ecab0554 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,14 @@ _The extension allows to zoom, rotate and flip the preview of the image. Inverti `amd64` +## Installation instructions - Add the app to your server +As administrator of an environment you can add custom web applications for your users. By adding DICOM Viewer you enable your users to take advantage of this web extension. + +TODO: following text is taken from general installation instructions, insert specific steps? + +Please follow the steps provided in our [developer documentation](https://owncloud.dev/services/web/#web-apps) if you want to install any of the + following apps and extensions. For some of them there are released artifacts, others still need to be built from source code. + ## Installation From 492d29d2e9272dcbdfa43b0b8f677d0f074e6f0b Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 17:28:12 +0545 Subject: [PATCH 10/39] update anchor link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ecab0554..6eb139ee 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith ## Table of Contents -* [Functionalities of the app](#Functionalities of the DICOM Viewer Web Extension) +* [Functionalities of the app](#Functionalities-of-the-DICOM-Viewer-Web-Extension) * [Installation instructions for developers](#) * [Installation instructions](#) * [Contribution](#) From 54b7028a3948561a69c7697cff457e56b01b012f Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Tue, 19 Nov 2024 17:32:28 +0545 Subject: [PATCH 11/39] updating TOC --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6eb139ee..d2196303 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,10 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith ## Table of Contents -* [Functionalities of the app](#Functionalities-of-the-DICOM-Viewer-Web-Extension) +* [Functionalities of the DICOM Viewer Web Extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension) +* [Adding DICOM Viewer to your oCIS installation](#) * [Installation instructions for developers](#) -* [Installation instructions](#) -* [Contribution](#) +* [Contributing to this app](#) TODO: update TOC! @@ -39,7 +39,7 @@ _The extension allows to zoom, rotate and flip the preview of the image. Inverti `amd64` -## Installation instructions - Add the app to your server +## Adding DICOM Viewer to your oCIS installation As administrator of an environment you can add custom web applications for your users. By adding DICOM Viewer you enable your users to take advantage of this web extension. TODO: following text is taken from general installation instructions, insert specific steps? From 616040f73462cbdc183f89decc7b2767c9ee3d48 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 11:01:35 +0545 Subject: [PATCH 12/39] Update README.md Co-authored-by: Martin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d2196303..ff277474 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ _The extension allows to zoom, rotate and flip the preview of the image. Inverti ## Adding DICOM Viewer to your oCIS installation -As administrator of an environment you can add custom web applications for your users. By adding DICOM Viewer you enable your users to take advantage of this web extension. +As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of this web extension. TODO: following text is taken from general installation instructions, insert specific steps? From 697c82088aaa481d54f8f17a4b469aa65ea373c1 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 11:05:20 +0545 Subject: [PATCH 13/39] moving quick reference section down and minor text updates --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ff277474..9dcba983 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith ## Table of Contents * [Functionalities of the DICOM Viewer Web Extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension) -* [Adding DICOM Viewer to your oCIS installation](#) +* [Adding DICOM Viewer to your oCIS installation](#Adding-DICOM-Viewer-to-your-oCIS-installation) * [Installation instructions for developers](#) * [Contributing to this app](#) @@ -23,24 +23,15 @@ The current release allows to preview .dcm files within oCIS and display their c app functionalities     display of metadata -_The extension allows to preview a DICOM image and it's most important meta data. On request, all corresponding metadata of the file are displayed in the sidebar._ +_The extension allows to preview a DICOM image and it's most important metadata. On request, all corresponding metadata of the file are displayed in the sidebar._ app functionalities     display of metadata _The extension allows to zoom, rotate and flip the preview of the image. Inverting the colors of the preview is also supported._ -## Quick reference - -- **Where to file issues:**\ - [owncloud/web-app-dicom-viewer](https://github.com/owncloud/web-app-dicom-viewer/issues) - -- **Supported architectures:**\ - `amd64` - - ## Adding DICOM Viewer to your oCIS installation -As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of this web extension. +As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of the functionalities of this web extension. TODO: following text is taken from general installation instructions, insert specific steps? @@ -48,6 +39,15 @@ Please follow the steps provided in our [developer documentation](https://ownclo following apps and extensions. For some of them there are released artifacts, others still need to be built from source code. +## Quick reference + +- **Where to file issues:**\ + [owncloud/web-app-dicom-viewer](https://github.com/owncloud/web-app-dicom-viewer/issues) + +- **Supported architectures:**\ + `amd64` + + ## Installation ### 1. Install dependencies From f190fcb591fe422b7647c55f56a7eed38a5a8d15 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 11:27:24 +0545 Subject: [PATCH 14/39] add paragraph about how to add web app to installation --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9dcba983..970487c4 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,12 @@ _The extension allows to zoom, rotate and flip the preview of the image. Inverti ## Adding DICOM Viewer to your oCIS installation -As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of the functionalities of this web extension. +As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of the [functionalities of this web extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension). + +Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). + + + TODO: following text is taken from general installation instructions, insert specific steps? From 5638390e2d92714924dc08fa1f7990ebbd0859c0 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 11:38:21 +0545 Subject: [PATCH 15/39] add links to assets --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 970487c4..662a717b 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,10 @@ As oCIS administrator, you can add custom web applications for your users. By ad Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). +- 'WEB_ASSET_APPS_PATH' for Dicom Viewer: ? +- 'manifest.json' for DICOM Viewer can be found [here](public/manifest.json), https://github.com/owncloud/web-app-dicom-viewer/blob/main/public/manifest.json - +TODO: provide corresponding apps.yml file and link to it? TODO: following text is taken from general installation instructions, insert specific steps? From eda9d10939985ecf1b90bc938a0b366e75f3993f Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 13:19:03 +0545 Subject: [PATCH 16/39] adding draft for yaml & fix link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 662a717b..becd1245 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,9 @@ As oCIS administrator, you can add custom web applications for your users. By ad Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). - 'WEB_ASSET_APPS_PATH' for Dicom Viewer: ? -- 'manifest.json' for DICOM Viewer can be found [here](public/manifest.json), https://github.com/owncloud/web-app-dicom-viewer/blob/main/public/manifest.json +- 'manifest.json' for DICOM Viewer can be found [here](public/manifest.json) -TODO: provide corresponding apps.yml file and link to it? +TODO: provide corresponding apps.yml file and link to it? see https://github.com/owncloud/web-app-dicom-viewer/tree/yaml for draft TODO: following text is taken from general installation instructions, insert specific steps? From 5b32f02cd9f172b9dde6c1f77128f1c86d97d69f Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 13:58:44 +0545 Subject: [PATCH 17/39] update installation section --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index becd1245..8cb80d30 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith * [Functionalities of the DICOM Viewer Web Extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension) * [Adding DICOM Viewer to your oCIS installation](#Adding-DICOM-Viewer-to-your-oCIS-installation) +* [Prerequisites for installation](#) * [Installation instructions for developers](#) * [Contributing to this app](#) @@ -35,15 +36,12 @@ As oCIS administrator, you can add custom web applications for your users. By ad Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). -- 'WEB_ASSET_APPS_PATH' for Dicom Viewer: ? -- 'manifest.json' for DICOM Viewer can be found [here](public/manifest.json) +DICOM Viewer's 'manifest.json' can be found [here](public/manifest.json). -TODO: provide corresponding apps.yml file and link to it? see https://github.com/owncloud/web-app-dicom-viewer/tree/yaml for draft - -TODO: following text is taken from general installation instructions, insert specific steps? - -Please follow the steps provided in our [developer documentation](https://owncloud.dev/services/web/#web-apps) if you want to install any of the - following apps and extensions. For some of them there are released artifacts, others still need to be built from source code. +TODO: +- find out if apps.yaml file is needed (seems to be optional) +- if so, provide corresponding file and link to it? +- see draft PR https://github.com/owncloud/web-app-dicom-viewer/pull/67 ## Quick reference @@ -55,6 +53,7 @@ Please follow the steps provided in our [developer documentation](https://ownclo `amd64` + ## Installation ### 1. Install dependencies @@ -75,7 +74,7 @@ pnpm build:w We can load the app into the oCIS server in two different ways, depending on the version of oCIS: -#### 1. For oCIS 5.0.0 (Seperate extension server) +#### 1. For oCIS 5.0.0 (Separate extension server) Configure the extension in `web.config.json` From aecaf1c6096c7403a6d045d20525eb9b23eaad32 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 14:08:47 +0545 Subject: [PATCH 18/39] update contributing and copyright section --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8cb80d30..a1e2db28 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith * [Adding DICOM Viewer to your oCIS installation](#Adding-DICOM-Viewer-to-your-oCIS-installation) * [Prerequisites for installation](#) * [Installation instructions for developers](#) -* [Contributing to this app](#) +* [Contributing to this app](#Contributing-to-this-app) +* [Copyright](#Copyright) TODO: update TOC! @@ -46,9 +47,6 @@ TODO: ## Quick reference -- **Where to file issues:**\ - [owncloud/web-app-dicom-viewer](https://github.com/owncloud/web-app-dicom-viewer/issues) - - **Supported architectures:**\ `amd64` @@ -113,18 +111,24 @@ docker compose up - [`latest`](https://github.com/owncloud/web-app-dicom-viewer/blob/master/docker/Dockerfile) available as `registry.owncloud.com/internal/web-app-dicom-viewer:latest` -## Default volumes +### Default volumes None -## Exposed ports +### Exposed ports - 8080 -## Environment variables +### Environment variables None + +## Contributing to this app + +Contribution in the form of bug reports, user feedback or actual code is always welcome! Please file issues [here](https://github.com/owncloud/web-app-dicom-viewer/issues). + + ## Copyright ```Text From a34ba623c4e533c1de5970981317dac0000bc4f7 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 14:14:52 +0545 Subject: [PATCH 19/39] update prerequisites --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a1e2db28..68dda665 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,9 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith * [Functionalities of the DICOM Viewer Web Extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension) * [Adding DICOM Viewer to your oCIS installation](#Adding-DICOM-Viewer-to-your-oCIS-installation) -* [Prerequisites for installation](#) -* [Installation instructions for developers](#) +* [Prerequisites](#Prerequisites) +* [Installation instructions](#) +* [Development](#) * [Contributing to this app](#Contributing-to-this-app) * [Copyright](#Copyright) @@ -45,11 +46,14 @@ TODO: - see draft PR https://github.com/owncloud/web-app-dicom-viewer/pull/67 -## Quick reference +## Prerequisites -- **Supported architectures:**\ - `amd64` +### Supported oCIS and Web Versions + oCIS (>= 6.2.x) + Web (>= 9.x.x) +### Supported architectures: + `amd64` ## Installation From 2baf550ef1d35a375d443b7b6526f7ef7f5d636f Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 14:31:48 +0545 Subject: [PATCH 20/39] update Development section --- README.md | 50 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 68dda665..f64e080b 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith * [Functionalities of the DICOM Viewer Web Extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension) * [Adding DICOM Viewer to your oCIS installation](#Adding-DICOM-Viewer-to-your-oCIS-installation) * [Prerequisites](#Prerequisites) -* [Installation instructions](#) -* [Development](#) +* [App Installation](#App-Installation) +* [Development](#Development) * [Contributing to this app](#Contributing-to-this-app) * [Copyright](#Copyright) @@ -56,23 +56,37 @@ TODO: `amd64` -## Installation +## App Installation -### 1. Install dependencies +TODO -``` + +## Development + +### Prerequisites for development + +- [Node.js `v18`](https://nodejs.org/en/) +- [pnpm `v8`](https://pnpm.io/) +- [Docker Compose](https://docs.docker.com/compose/) + +TODO: taken from presentation viewer, check if this is correct + + +### 1. Install dependencies: + +```bash pnpm install ``` -### 2. Build extension +### 2. Build the extension Build the extension using watch for development. -``` +```bash pnpm build:w ``` -### 3. Load apps +### 3. Load the extension We can load the app into the oCIS server in two different ways, depending on the version of oCIS: @@ -105,27 +119,23 @@ Configure the extension in `web.config.json` Copy `docker-compose.override.example.yml` to `docker-compose.override.yml`. + ### 4. Run oCIS server -``` +```bash docker compose up ``` -## Docker Tags and respective Dockerfile links - -- [`latest`](https://github.com/owncloud/web-app-dicom-viewer/blob/master/docker/Dockerfile) available as `registry.owncloud.com/internal/web-app-dicom-viewer:latest` - -### Default volumes +access oCIS through the following URL: [localhost:9200](https://localhost:9200) -None -### Exposed ports +### Docker Tags and respective Dockerfile links -- 8080 - -### Environment variables +- [`latest`](https://github.com/owncloud/web-app-dicom-viewer/blob/master/docker/Dockerfile) available as `registry.owncloud.com/internal/web-app-dicom-viewer:latest` -None +- Default volumes: None +- Exposed ports: 8080 +- Environment variables: None ## Contributing to this app From 94d9db9732d40dbfb0f71600307c2a196d97de88 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 14:49:04 +0545 Subject: [PATCH 21/39] add app installation --- README.md | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f64e080b..70734f34 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,12 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith ## Table of Contents -* [Functionalities of the DICOM Viewer Web Extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension) +* [Functionalities of DICOM Viewer Web Extension](#Functionalities-of-DICOM-Viewer-Web-Extension) * [Adding DICOM Viewer to your oCIS installation](#Adding-DICOM-Viewer-to-your-oCIS-installation) -* [Prerequisites](#Prerequisites) -* [App Installation](#App-Installation) -* [Development](#Development) +* [Build and run DICOM Viewer for development](#Build-and-run-for-development) * [Contributing to this app](#Contributing-to-this-app) * [Copyright](#Copyright) -TODO: update TOC! - ## Functionalities of the DICOM Viewer Web Extension @@ -38,32 +34,31 @@ As oCIS administrator, you can add custom web applications for your users. By ad Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). -DICOM Viewer's 'manifest.json' can be found [here](public/manifest.json). +DICOM Viewer's `manifest.json` can be found [here](public/manifest.json). TODO: - find out if apps.yaml file is needed (seems to be optional) - if so, provide corresponding file and link to it? - see draft PR https://github.com/owncloud/web-app-dicom-viewer/pull/67 +### Prerequisites -## Prerequisites - -### Supported oCIS and Web Versions - oCIS (>= 6.2.x) - Web (>= 9.x.x) +#### Supported oCIS and Web Versions +- oCIS (>= 6.2.x) +- Web (>= 9.x.x) -### Supported architectures: +#### Supported architectures: `amd64` +### App Installation -## App Installation - -TODO +1. Download the zip file from the [releases page](https://github.com/owncloud/web-app-dicom-viewer/releases) +2. Extract the zip file to the `apps` directory of the oCIS server. Apps directory is set using the `WEB_ASSET_APPS_PATH` environment variable, see https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications -## Development +## Build and run DICOM Viewer for development -### Prerequisites for development +### Prerequisites - [Node.js `v18`](https://nodejs.org/en/) - [pnpm `v8`](https://pnpm.io/) From 23b28788e07bd30041ced8507596d8e0fe9e0f04 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 14:49:41 +0545 Subject: [PATCH 22/39] remove internal comments --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 70734f34..30cadbf3 100644 --- a/README.md +++ b/README.md @@ -34,13 +34,17 @@ As oCIS administrator, you can add custom web applications for your users. By ad Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). -DICOM Viewer's `manifest.json` can be found [here](public/manifest.json). +--- + +DICOM Viewer's `manifest.json` (referenced in `application structure`) can be found [here](public/manifest.json). TODO: -- find out if apps.yaml file is needed (seems to be optional) +- find out if `apps.yaml` file is needed (seems to be optional) - if so, provide corresponding file and link to it? - see draft PR https://github.com/owncloud/web-app-dicom-viewer/pull/67 +--- + ### Prerequisites #### Supported oCIS and Web Versions @@ -53,7 +57,7 @@ TODO: ### App Installation 1. Download the zip file from the [releases page](https://github.com/owncloud/web-app-dicom-viewer/releases) -2. Extract the zip file to the `apps` directory of the oCIS server. Apps directory is set using the `WEB_ASSET_APPS_PATH` environment variable, see https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications +2. Extract the zip file to the `apps` directory of the oCIS server. The `apps` directory is set using the `WEB_ASSET_APPS_PATH` environment variable. ## Build and run DICOM Viewer for development @@ -64,8 +68,6 @@ TODO: - [pnpm `v8`](https://pnpm.io/) - [Docker Compose](https://docs.docker.com/compose/) -TODO: taken from presentation viewer, check if this is correct - ### 1. Install dependencies: From da283c3050ae1aeb0dc24b4e5ae962afaead2606 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 14:52:51 +0545 Subject: [PATCH 23/39] remove internal notes regarding TODOs --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 30cadbf3..5692b08f 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,6 @@ Have a look at the ownCloud Infinite Scale Deployment documentation to learn how DICOM Viewer's `manifest.json` (referenced in `application structure`) can be found [here](public/manifest.json). -TODO: -- find out if `apps.yaml` file is needed (seems to be optional) -- if so, provide corresponding file and link to it? -- see draft PR https://github.com/owncloud/web-app-dicom-viewer/pull/67 - --- ### Prerequisites From 67249689927901b3adb671af973eee0b1b064da9 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 14:58:05 +0545 Subject: [PATCH 24/39] upadte contribution section --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5692b08f..2027e719 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith * [Functionalities of DICOM Viewer Web Extension](#Functionalities-of-DICOM-Viewer-Web-Extension) * [Adding DICOM Viewer to your oCIS installation](#Adding-DICOM-Viewer-to-your-oCIS-installation) * [Build and run DICOM Viewer for development](#Build-and-run-for-development) -* [Contributing to this app](#Contributing-to-this-app) +* [Contributing to DICOM Viewer Web Extension](#Contributing-to-DICOM-Viewer-Web-Extension) * [Copyright](#Copyright) @@ -130,7 +130,7 @@ access oCIS through the following URL: [localhost:9200](https://localhost:9200) - Environment variables: None -## Contributing to this app +## Contributing to DICOM Viewer Web Extension Contribution in the form of bug reports, user feedback or actual code is always welcome! Please file issues [here](https://github.com/owncloud/web-app-dicom-viewer/issues). From 0c9d943da5f679df01245944509c2ad005107d92 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 15:06:30 +0545 Subject: [PATCH 25/39] Apply suggestions from code review Co-authored-by: Martin --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2027e719..4fb2841b 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ _The extension allows to preview a DICOM image and it's most important metadata. _The extension allows to zoom, rotate and flip the preview of the image. Inverting the colors of the preview is also supported._ -## Adding DICOM Viewer to your oCIS installation +## Adding DICOM Viewer to Your oCIS Installation As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of the [functionalities of this web extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension). Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). @@ -46,7 +46,7 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo - oCIS (>= 6.2.x) - Web (>= 9.x.x) -#### Supported architectures: +#### Supported Architectures: `amd64` ### App Installation @@ -55,7 +55,7 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo 2. Extract the zip file to the `apps` directory of the oCIS server. The `apps` directory is set using the `WEB_ASSET_APPS_PATH` environment variable. -## Build and run DICOM Viewer for development +## Build and run DICOM Viewer for Development ### Prerequisites @@ -64,13 +64,13 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo - [Docker Compose](https://docs.docker.com/compose/) -### 1. Install dependencies: +### 1. Install Dependencies: ```bash pnpm install ``` -### 2. Build the extension +### 2. Build the Extension Build the extension using watch for development. @@ -78,11 +78,11 @@ Build the extension using watch for development. pnpm build:w ``` -### 3. Load the extension +### 3. Load the Extension We can load the app into the oCIS server in two different ways, depending on the version of oCIS: -#### 1. For oCIS 5.0.0 (Separate extension server) +#### 1. For oCIS 5.0.0 (Separate Extension Server) Configure the extension in `web.config.json` @@ -112,7 +112,7 @@ Configure the extension in `web.config.json` Copy `docker-compose.override.example.yml` to `docker-compose.override.yml`. -### 4. Run oCIS server +### 4. Run oCIS Server ```bash docker compose up @@ -121,7 +121,7 @@ docker compose up access oCIS through the following URL: [localhost:9200](https://localhost:9200) -### Docker Tags and respective Dockerfile links +### Docker Tags and Respective Dockerfile Links - [`latest`](https://github.com/owncloud/web-app-dicom-viewer/blob/master/docker/Dockerfile) available as `registry.owncloud.com/internal/web-app-dicom-viewer:latest` From 2afde28d77bc28b98863b70ed748f6deaffa93f1 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 15:10:01 +0545 Subject: [PATCH 26/39] minor corrections --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4fb2841b..cfc21af1 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith ## Table of Contents * [Functionalities of DICOM Viewer Web Extension](#Functionalities-of-DICOM-Viewer-Web-Extension) -* [Adding DICOM Viewer to your oCIS installation](#Adding-DICOM-Viewer-to-your-oCIS-installation) -* [Build and run DICOM Viewer for development](#Build-and-run-for-development) +* [Adding DICOM Viewer to Your oCIS Installation](#Adding-DICOM-Viewer-to-Your-oCIS-Installation) +* [Build and run DICOM Viewer for Development](#Build-and-run-for-development) * [Contributing to DICOM Viewer Web Extension](#Contributing-to-DICOM-Viewer-Web-Extension) * [Copyright](#Copyright) @@ -51,7 +51,7 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo ### App Installation -1. Download the zip file from the [releases page](https://github.com/owncloud/web-app-dicom-viewer/releases) +1. Download the zip file from the [releases page](https://github.com/owncloud/web-app-dicom-viewer/releases). 2. Extract the zip file to the `apps` directory of the oCIS server. The `apps` directory is set using the `WEB_ASSET_APPS_PATH` environment variable. @@ -64,7 +64,7 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo - [Docker Compose](https://docs.docker.com/compose/) -### 1. Install Dependencies: +### 1. Install Dependencies ```bash pnpm install @@ -82,7 +82,7 @@ pnpm build:w We can load the app into the oCIS server in two different ways, depending on the version of oCIS: -#### 1. For oCIS 5.0.0 (Separate Extension Server) +#### For oCIS 5.0.0 (Separate Extension Server) Configure the extension in `web.config.json` @@ -107,7 +107,7 @@ Configure the extension in `web.config.json` ``` -#### 2. For oCIS >= 5.1 +#### For oCIS >= 5.1 Copy `docker-compose.override.example.yml` to `docker-compose.override.yml`. @@ -118,7 +118,7 @@ Copy `docker-compose.override.example.yml` to `docker-compose.override.yml`. docker compose up ``` -access oCIS through the following URL: [localhost:9200](https://localhost:9200) +You can access oCIS through the following URL: [localhost:9200](https://localhost:9200) ### Docker Tags and Respective Dockerfile Links From e22ed0cfad4f75b77072c801218d57b8502dab4a Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Wed, 20 Nov 2024 15:15:36 +0545 Subject: [PATCH 27/39] fix minor typos and update table of content --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cfc21af1..5b0717ea 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,12 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith * [Functionalities of DICOM Viewer Web Extension](#Functionalities-of-DICOM-Viewer-Web-Extension) * [Adding DICOM Viewer to Your oCIS Installation](#Adding-DICOM-Viewer-to-Your-oCIS-Installation) -* [Build and run DICOM Viewer for Development](#Build-and-run-for-development) +* [Build and Run DICOM Viewer for Development](#Build-and-Run-DICOM-Viewer-for-Development) * [Contributing to DICOM Viewer Web Extension](#Contributing-to-DICOM-Viewer-Web-Extension) * [Copyright](#Copyright) -## Functionalities of the DICOM Viewer Web Extension +## Functionalities of DICOM Viewer Web Extension The current release allows to preview .dcm files within oCIS and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. @@ -46,7 +46,7 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo - oCIS (>= 6.2.x) - Web (>= 9.x.x) -#### Supported Architectures: +#### Supported Architectures `amd64` ### App Installation @@ -55,7 +55,7 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo 2. Extract the zip file to the `apps` directory of the oCIS server. The `apps` directory is set using the `WEB_ASSET_APPS_PATH` environment variable. -## Build and run DICOM Viewer for Development +## Build and Run DICOM Viewer for Development ### Prerequisites From 1080a2b399887bd73e8836ee82c5b8bc69763208 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Thu, 21 Nov 2024 11:14:42 +0545 Subject: [PATCH 28/39] update order of steps for development --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5b0717ea..3f43a255 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,13 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo pnpm install ``` -### 2. Build the Extension +### 2. Run oCIS Server + +```bash +docker compose up +``` + +### 3. Build the Extension Build the extension using watch for development. @@ -78,7 +84,7 @@ Build the extension using watch for development. pnpm build:w ``` -### 3. Load the Extension +### 4. Load the Extension We can load the app into the oCIS server in two different ways, depending on the version of oCIS: @@ -112,13 +118,9 @@ Configure the extension in `web.config.json` Copy `docker-compose.override.example.yml` to `docker-compose.override.yml`. -### 4. Run oCIS Server - -```bash -docker compose up -``` +### 5. Have Fun -You can access oCIS through the following URL: [localhost:9200](https://localhost:9200) +You can access oCIS WebUI with the DICOM Viewer extension through [localhost:9200](https://localhost:9200). ### Docker Tags and Respective Dockerfile Links @@ -126,7 +128,7 @@ You can access oCIS through the following URL: [localhost:9200](https://localhos - [`latest`](https://github.com/owncloud/web-app-dicom-viewer/blob/master/docker/Dockerfile) available as `registry.owncloud.com/internal/web-app-dicom-viewer:latest` - Default volumes: None -- Exposed ports: 8080 +- Exposed ports: `8080` - Environment variables: None From 58da163b59db79c7083cff7736ca982b31f7835a Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Thu, 21 Nov 2024 11:15:57 +0545 Subject: [PATCH 29/39] update links in TOC --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3f43a255..199c6272 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith ## Table of Contents -* [Functionalities of DICOM Viewer Web Extension](#Functionalities-of-DICOM-Viewer-Web-Extension) -* [Adding DICOM Viewer to Your oCIS Installation](#Adding-DICOM-Viewer-to-Your-oCIS-Installation) -* [Build and Run DICOM Viewer for Development](#Build-and-Run-DICOM-Viewer-for-Development) -* [Contributing to DICOM Viewer Web Extension](#Contributing-to-DICOM-Viewer-Web-Extension) -* [Copyright](#Copyright) +* [Functionalities of DICOM Viewer Web Extension](#functionalities-of-dicom-viewer-web-extension) +* [Adding DICOM Viewer to Your oCIS Installation](#adding-dicom-viewer-to-your-ocis-installation) +* [Build and Run DICOM Viewer for Development](#build-and-run-dicom-viewer-for-development) +* [Contributing to DICOM Viewer Web Extension](#contributing-to-dicom-viewer-web-extension) +* [Copyright](#copyright) ## Functionalities of DICOM Viewer Web Extension From 61e1b88c462a2d38a8f45d2f75dfc806f71331ec Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Thu, 21 Nov 2024 11:17:57 +0545 Subject: [PATCH 30/39] update styling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 199c6272..f8066722 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ DICOM Viewer's `manifest.json` (referenced in `application structure`) can be fo - Web (>= 9.x.x) #### Supported Architectures - `amd64` +- `amd64` ### App Installation From b96dbae78e788bc286f4d2014e5e6611b0d6a4cd Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Thu, 21 Nov 2024 11:30:49 +0545 Subject: [PATCH 31/39] remove line about location of manifest.json --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index f8066722..10ee8ff8 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,6 @@ As oCIS administrator, you can add custom web applications for your users. By ad Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). ---- - -DICOM Viewer's `manifest.json` (referenced in `application structure`) can be found [here](public/manifest.json). - ---- ### Prerequisites From ea40d25dbebeaba41823790442c529be43cb4c41 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Thu, 21 Nov 2024 15:24:04 +0545 Subject: [PATCH 32/39] adding section on how to add dicom viewer to the ocis deployment example --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 48 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 10ee8ff8..10384253 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith * [Functionalities of DICOM Viewer Web Extension](#functionalities-of-dicom-viewer-web-extension) * [Adding DICOM Viewer to Your oCIS Installation](#adding-dicom-viewer-to-your-ocis-installation) + * [Adding DICOM Viewer to the oCIS Deployment Example](#adding-dicom-viewer-to-the-ocis-deployment-example) + * [Manual App Installation](#manual-app-installation) * [Build and Run DICOM Viewer for Development](#build-and-run-dicom-viewer-for-development) * [Contributing to DICOM Viewer Web Extension](#contributing-to-dicom-viewer-web-extension) * [Copyright](#copyright) @@ -32,22 +34,59 @@ _The extension allows to zoom, rotate and flip the preview of the image. Inverti ## Adding DICOM Viewer to Your oCIS Installation As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of the [functionalities of this web extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension). -Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). +### Adding DICOM Viewer to the oCIS Deployment Example +oCIS provides some [Deployment Examples](https://github.com/owncloud/ocis/tree/master/deployments/examples/) including detailed configuration step by step guides for [local production setup](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-prod.html) and [deployment of Infinite Scale on the Hetzner Cloud](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.html). +In both cases, it only takes three very small and simple steps to add the DICOM Viewer Web Extension to the [oCIS Deployment Example](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/) of your own installation: -### Prerequisites +1. Navigate to the `/opt/compose/ocis/ocis_full` folder of your installation and copy [`dicom-viewer.yml`](TODO: insert path to file!!!) into the [`web_extensions`](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/web_extensions) subfolder. + +2. Add `DICOMVIEWER=:web_extensions/dicom-viewer.yml` to the `## oCIS Web Extensions ##` section of the `.env` file (file is located in `/opt/compose/ocis/ocis_full`) of your own installation. + +Your `.env` file should look like this: + +``` +## oCIS Web Extensions ## +# It is possible to use the oCIS Web Extensions to add custom functionality to the oCIS frontend. +# For more details see https://github.com/owncloud/web-extensions/blob/main/README.md -#### Supported oCIS and Web Versions -- oCIS (>= 6.2.x) -- Web (>= 9.x.x) + -#### Supported Architectures -- `amd64` +DICOMVIEWER=:web_extensions/dicom-viewer.yml -### App Installation +``` + +3. Append `${DICOMVIEWER:-}` to the `COMPOSE_FILE` variable at the very end of the last line of the `.env` file. This variable combines the configs of all the components that need to be loaded. + +`COMPOSE_FILE=docker-compose.yml${OCIS:-} ... ... ${DICOMVIEWER:-}` + +After appending, your `.env` file should look like this: + +``` +## IMPORTANT ## +# This MUST be the last line as it assembles the supplemental compose files to be used. +# ALL supplemental configs must be added here, whether commented or not. +# Each var must either be empty or contain :path/file.yml +COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${DICOMVIEWER:-} + +``` + +Done! Have fun using the [functionalities of the DICOM Viewer web extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension) on your installation! + + +### Manual App Installation 1. Download the zip file from the [releases page](https://github.com/owncloud/web-app-dicom-viewer/releases). -2. Extract the zip file to the `apps` directory of the oCIS server. The `apps` directory is set using the `WEB_ASSET_APPS_PATH` environment variable. +2. Extract the zip file to the `apps` directory of your oCIS server. The `apps` directory is set using the `WEB_ASSET_APPS_PATH` environment variable. + +#### Prerequisites + +- Supported oCIS and Web Versions: oCIS (>= 6.2.x), Web (>= 9.x.x) +- Supported Architectures: `amd64` + +#### Additional Information + +Have a look at the ownCloud Infinite Scale Deployment documentation to learn how to [extend the WebUI with apps](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#extend-web-ui-with-apps). You will find instructions how to [load custom applications](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#loading-applications) into your installation and get a better understanding of the web extension [application structure](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-structure) and [application configuration](https://doc.owncloud.com/ocis/next/deployment/webui/webui-customisation.html#application-configuration). ## Build and Run DICOM Viewer for Development @@ -121,7 +160,6 @@ You can access oCIS WebUI with the DICOM Viewer extension through [localhost:920 ### Docker Tags and Respective Dockerfile Links - [`latest`](https://github.com/owncloud/web-app-dicom-viewer/blob/master/docker/Dockerfile) available as `registry.owncloud.com/internal/web-app-dicom-viewer:latest` - - Default volumes: None - Exposed ports: `8080` - Environment variables: None From cb1ddaeb4d9e330176814c9b1b8a1cfb06d0145b Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Thu, 21 Nov 2024 15:32:36 +0545 Subject: [PATCH 33/39] adding path to yml file file still needs to be correctly configured and corresponding branch (https://github.com/owncloud/web-app-dicom-viewer/pull/67) needs to be merged --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 10384253..f5af8a8c 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ As oCIS administrator, you can add custom web applications for your users. By ad oCIS provides some [Deployment Examples](https://github.com/owncloud/ocis/tree/master/deployments/examples/) including detailed configuration step by step guides for [local production setup](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-prod.html) and [deployment of Infinite Scale on the Hetzner Cloud](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.html). In both cases, it only takes three very small and simple steps to add the DICOM Viewer Web Extension to the [oCIS Deployment Example](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/) of your own installation: -1. Navigate to the `/opt/compose/ocis/ocis_full` folder of your installation and copy [`dicom-viewer.yml`](TODO: insert path to file!!!) into the [`web_extensions`](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/web_extensions) subfolder. +1. Navigate to the `/opt/compose/ocis/ocis_full` folder of your installation and copy [`dicom-viewer.yml`](https://github.com/owncloud/web-app-dicom-viewer/blob/main/dicom-viewer.yml) into the [`web_extensions`](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/web_extensions) subfolder. 2. Add `DICOMVIEWER=:web_extensions/dicom-viewer.yml` to the `## oCIS Web Extensions ##` section of the `.env` file (file is located in `/opt/compose/ocis/ocis_full`) of your own installation. From b9d89e0969009d52d70ad926351f435577688602 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Thu, 21 Nov 2024 15:40:43 +0545 Subject: [PATCH 34/39] minor text changes and fixing anchor links --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f5af8a8c..b05cdb8f 100644 --- a/README.md +++ b/README.md @@ -32,18 +32,18 @@ _The extension allows to zoom, rotate and flip the preview of the image. Inverti ## Adding DICOM Viewer to Your oCIS Installation -As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of the [functionalities of this web extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension). +As oCIS administrator, you can add custom web applications for your users. By adding the DICOM Viewer to the oCIS WebUI, you enable your users to take advantage of the [functionalities of this web extension](#functionalities-of-dicom-viewer-web-extension). ### Adding DICOM Viewer to the oCIS Deployment Example -oCIS provides some [Deployment Examples](https://github.com/owncloud/ocis/tree/master/deployments/examples/) including detailed configuration step by step guides for [local production setup](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-prod.html) and [deployment of Infinite Scale on the Hetzner Cloud](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.html). -In both cases, it only takes three very small and simple steps to add the DICOM Viewer Web Extension to the [oCIS Deployment Example](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/) of your own installation: +oCIS provides some [deployment examples](https://github.com/owncloud/ocis/tree/master/deployments/examples/) including detailed configuration step by step guides for [local production setup](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-prod.html) and [deployment of Infinite Scale on the Hetzner Cloud](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.html). +In both cases, it only takes three very small and simple steps to add the DICOM Viewer Web Extension to the [`ocis_full` deployment example](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/) of your own installation: 1. Navigate to the `/opt/compose/ocis/ocis_full` folder of your installation and copy [`dicom-viewer.yml`](https://github.com/owncloud/web-app-dicom-viewer/blob/main/dicom-viewer.yml) into the [`web_extensions`](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/web_extensions) subfolder. -2. Add `DICOMVIEWER=:web_extensions/dicom-viewer.yml` to the `## oCIS Web Extensions ##` section of the `.env` file (file is located in `/opt/compose/ocis/ocis_full`) of your own installation. +2. Add `DICOMVIEWER=:web_extensions/dicom-viewer.yml` to the `## oCIS Web Extensions ##` section of the `.env` file of your installation (file is located in `/opt/compose/ocis/ocis_full`). -Your `.env` file should look like this: +Your `.env` file should now look like this: ``` ## oCIS Web Extensions ## @@ -60,7 +60,7 @@ DICOMVIEWER=:web_extensions/dicom-viewer.yml `COMPOSE_FILE=docker-compose.yml${OCIS:-} ... ... ${DICOMVIEWER:-}` -After appending, your `.env` file should look like this: +After appending `${DICOMVIEWER:-}`, your `.env` file should look like this: ``` ## IMPORTANT ## @@ -71,7 +71,7 @@ COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLA ``` -Done! Have fun using the [functionalities of the DICOM Viewer web extension](#Functionalities-of-the-DICOM-Viewer-Web-Extension) on your installation! +Done! Have fun using the [functionalities of the DICOM Viewer web extension](#functionalities-of-dicom-viewer-web-extension) on your installation! ### Manual App Installation From 1a926614f01cc5f21d969bf85eea921c5c8d823b Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Thu, 21 Nov 2024 16:25:36 +0545 Subject: [PATCH 35/39] Apply suggestions from code review Co-authored-by: Martin --- README.md | 43 +++++++++++++++++++------------------------ 1 file changed, 19 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index b05cdb8f..8bc41c67 100644 --- a/README.md +++ b/README.md @@ -41,35 +41,30 @@ In both cases, it only takes three very small and simple steps to add the DICOM 1. Navigate to the `/opt/compose/ocis/ocis_full` folder of your installation and copy [`dicom-viewer.yml`](https://github.com/owncloud/web-app-dicom-viewer/blob/main/dicom-viewer.yml) into the [`web_extensions`](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/web_extensions) subfolder. -2. Add `DICOMVIEWER=:web_extensions/dicom-viewer.yml` to the `## oCIS Web Extensions ##` section of the `.env` file of your installation (file is located in `/opt/compose/ocis/ocis_full`). - +2. Add `DICOMVIEWER=:web_extensions/dicom-viewer.yml` to the `## oCIS Web Extensions ##` section of the `.env` file of your installation (file is located in `/opt/compose/ocis/ocis_full`).\ Your `.env` file should now look like this: - -``` -## oCIS Web Extensions ## -# It is possible to use the oCIS Web Extensions to add custom functionality to the oCIS frontend. -# For more details see https://github.com/owncloud/web-extensions/blob/main/README.md - - - -DICOMVIEWER=:web_extensions/dicom-viewer.yml - -``` + ``` + ## oCIS Web Extensions ## + # It is possible to use the oCIS Web Extensions to add custom functionality to the oCIS frontend. + # For more details see https://github.com/owncloud/web-extensions/blob/main/README.md + + + + DICOMVIEWER=:web_extensions/dicom-viewer.yml + ``` 3. Append `${DICOMVIEWER:-}` to the `COMPOSE_FILE` variable at the very end of the last line of the `.env` file. This variable combines the configs of all the components that need to be loaded. -`COMPOSE_FILE=docker-compose.yml${OCIS:-} ... ... ${DICOMVIEWER:-}` - -After appending `${DICOMVIEWER:-}`, your `.env` file should look like this: + `COMPOSE_FILE=docker-compose.yml${OCIS:-} ... ... ${DICOMVIEWER:-}` -``` -## IMPORTANT ## -# This MUST be the last line as it assembles the supplemental compose files to be used. -# ALL supplemental configs must be added here, whether commented or not. -# Each var must either be empty or contain :path/file.yml -COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${DICOMVIEWER:-} - -``` + After appending `${DICOMVIEWER:-}`, your `.env` file should look like this: + ``` + ## IMPORTANT ## + # This MUST be the last line as it assembles the supplemental compose files to be used. + # ALL supplemental configs must be added here, whether commented or not. + # Each var must either be empty or contain :path/file.yml + COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${DICOMVIEWER:-} + ``` Done! Have fun using the [functionalities of the DICOM Viewer web extension](#functionalities-of-dicom-viewer-web-extension) on your installation! From 16b68caee3a6864cf6a750a176f7ea89004bbe30 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Mon, 25 Nov 2024 12:39:04 +0545 Subject: [PATCH 36/39] Apply suggestions from code review Co-authored-by: Phil Davis --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8bc41c67..f04e6083 100644 --- a/README.md +++ b/README.md @@ -20,15 +20,15 @@ The ownCloud Web DICOM Viewer app is an extension of [ownCloud Web](https://gith ## Functionalities of DICOM Viewer Web Extension -The current release allows to preview .dcm files within oCIS and display their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way how metadata is displayed to the screen size of the device. +The current release allows previewing .dcm files within oCIS and displaying their corresponding metadata in a sidebar on request. It offers image manipulation operations such as zoom in and out, rotation, flipping, colour inversion and reset on the image preview. The app UI is implemented in a responsive manner and adapts the size of the image preview and the way that metadata is displayed to the screen size of the device. app functionalities     display of metadata -_The extension allows to preview a DICOM image and it's most important metadata. On request, all corresponding metadata of the file are displayed in the sidebar._ +_The extension allows previewing a DICOM image and it's most important metadata. On request, all corresponding metadata of the file are displayed in the sidebar._ app functionalities     display of metadata -_The extension allows to zoom, rotate and flip the preview of the image. Inverting the colors of the preview is also supported._ +_The extension allows the user to zoom, rotate and flip the preview of the image. Inverting the colors of the preview is also supported._ ## Adding DICOM Viewer to Your oCIS Installation From 05425e0129e8f8bc035332594f5e83e9e14caac5 Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Fri, 6 Dec 2024 14:11:45 +0545 Subject: [PATCH 37/39] adding point about CSP --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f04e6083..3fb1f6e6 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ As oCIS administrator, you can add custom web applications for your users. By ad ### Adding DICOM Viewer to the oCIS Deployment Example oCIS provides some [deployment examples](https://github.com/owncloud/ocis/tree/master/deployments/examples/) including detailed configuration step by step guides for [local production setup](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-prod.html) and [deployment of Infinite Scale on the Hetzner Cloud](https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-hetzner.html). -In both cases, it only takes three very small and simple steps to add the DICOM Viewer Web Extension to the [`ocis_full` deployment example](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/) of your own installation: +In both cases, it only takes a few very small and simple steps to add the DICOM Viewer Web Extension to the [`ocis_full` deployment example](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/) of your own installation: 1. Navigate to the `/opt/compose/ocis/ocis_full` folder of your installation and copy [`dicom-viewer.yml`](https://github.com/owncloud/web-app-dicom-viewer/blob/main/dicom-viewer.yml) into the [`web_extensions`](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/web_extensions) subfolder. @@ -65,6 +65,7 @@ Your `.env` file should now look like this: # Each var must either be empty or contain :path/file.yml COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${DICOMVIEWER:-} ``` +4. Update the `csp.yaml` file located in `/config/ocis/csp.yaml` according to the description in https://github.com/owncloud/awesome-ocis/blob/main/webApps/apps.json#L374 Done! Have fun using the [functionalities of the DICOM Viewer web extension](#functionalities-of-dicom-viewer-web-extension) on your installation! From 6984a38554a17e8fa2de3aaf5640d36ab642ad5e Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Fri, 6 Dec 2024 14:12:48 +0545 Subject: [PATCH 38/39] add blank line --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3fb1f6e6..d0d815ae 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ Your `.env` file should now look like this: # Each var must either be empty or contain :path/file.yml COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${DICOMVIEWER:-} ``` + 4. Update the `csp.yaml` file located in `/config/ocis/csp.yaml` according to the description in https://github.com/owncloud/awesome-ocis/blob/main/webApps/apps.json#L374 Done! Have fun using the [functionalities of the DICOM Viewer web extension](#functionalities-of-dicom-viewer-web-extension) on your installation! From 434611f3acb060a044d360d7aa2fac10fe9536be Mon Sep 17 00:00:00 2001 From: Kathrin Koebel Date: Fri, 6 Dec 2024 14:48:22 +0545 Subject: [PATCH 39/39] Apply suggestions from code review Co-authored-by: Martin --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0d815ae..4196a8b1 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,8 @@ Your `.env` file should now look like this: COMPOSE_FILE=docker-compose.yml${OCIS:-}${TIKA:-}${S3NG:-}${S3NG_MINIO:-}${COLLABORA:-}${MONITORING:-}${IMPORTER:-}${CLAMAV:-}${ONLYOFFICE:-}${INBUCKET:-}${EXTENSIONS:-}${UNZIP:-}${DRAWIO:-}${JSONVIEWER:-}${PROGRESSBARS:-}${EXTERNALSITES:-}${DICOMVIEWER:-} ``` -4. Update the `csp.yaml` file located in `/config/ocis/csp.yaml` according to the description in https://github.com/owncloud/awesome-ocis/blob/main/webApps/apps.json#L374 +4. Update the `csp.yaml` file located in `/config/ocis/csp.yaml` by adding the +`"id": "com.github.owncloud.web-app-dicom-viewer"` block as shown in the [webApps/apps.json](https://github.com/owncloud/awesome-ocis/blob/main/webApps/apps.json) example. Done! Have fun using the [functionalities of the DICOM Viewer web extension](#functionalities-of-dicom-viewer-web-extension) on your installation!