ShanoirUploader Installation - fli-iam/shanoir-ng GitHub Wiki

[English and French version below]

Installation Guide

This page describes the installation of ShanoirUploader, starting from version v6.0.3 (includes v6.0.4 + v7.0.0 + v7.0.1 + v8.0.0 and v9.0.0).

Introduction

ShanoirUploader is written in Java. Following the slogan of Java, write once run everywhere, it runs on Windows, MacOS and Linux.

Requirements

  • You may require Administrator rights on your machine to do the installation.
  • ShanoirUploader 9.0.0 requires Java 21 installed.
  • ShanoirUploader 8.0.0 requires Java 17 installed.
  • ShanoirUploader 7.0.1 requires Java 8 or 11 (depending on date).
  • ShanoirUploader 6.0.0 requires Java 8.
  • Until today the choice of the Java Runtime Environment (JRE) from OpenJDK is recommended as it supports our SSL certificates provider. See here an example how to install: OpenJDK Installation.
  • ATTENTION: for the OFSEP project, using version "shanoir-uploader-v7.0.1_2021_04_13" of ShanoirUploader PLEASE INSTALL Java 8!!! Java 21 is required for the latest version on GitHub. The OFSEP version will not work with Java 11; and require extra configuration with Java 9 or Java 10 ("--add-modules java.xml.bind"). This is related to the evolution of Java: JAXB libraries, used by ShUp, have been deactivated by default in Java 9 and Java 10 and entirely removed in Java 11+.
  • Please set your JAVA_HOME (System Preferences - Env variables) to the folder of the Java installation.
  • Please verify, e.g. with java -version, that you are using a supported version.

Installation Package (replace x.x.x with your version)

ShanoirUploader is shared in the file: shanoir-uploader-x.x.x.zip. The zip file contains 3 files:

  • shanoir-uploader-x.x.x-jar-with-dependencies.jar
  • start-shup-linux-mac-java.sh
  • start-shup-windows-java.bat

Installation Procedure

The installation procedure is very easy and does normally not require administration rights. Just copy the folder with the 3 files to any place on your machine, as examples:

  • Windows: C:∖Users∖your_user∖
  • MacOS: /Applications

Depending on your operating system you can now run ShanoirUploader using either:

  • Windows: start-shup-windows-java.bat (double-click on .bat)
  • MacOS/Linux: start-shup-linux-mac-java.sh

ATTENTION: on Windows!! do not click on JAR shanoir-uploader-6.0.3-jar-with-dependencies.jar, but on .BAT

Special: for the OFSEP study and for users with Mac OSX or Linux, please use the command:

/{user.home}/.su_v6.0.x/pseudonymus/MacOSX/chmod 755 PseudonymusShanoir

Now you should see the StartupDialog of ShanoirUploader. The installation is finished, now the configuration starts.

Configuration

All configurations for ShUp can be done using the graphical user interface.

Proxy

While starting ShUp tries to reach an outside URL, e.g. https://shanoir-ofsep.irisa.fr to access to Shanoir server. If this access fails (error found) the proxy configuration window appears:

Please enter your proxy properties and click on save.

Profile Selection

Profile OFSEP: https://shanoir-ofsep.irisa.fr Profile Neurinfo: https://shanoir.irisa.fr

We can configure a default profile to use every time by adding e.g. "profile=Neurinfo" to basic.properties.

Shanoir Server

Please enter the login and password of your Shanoir server account depending on the profile selected. Now ShUp is up and running and you will see the full window.

PACS

If you want to connect to the PACS use the following steps:

Your PACS admin will have to enter a new AET on using either your IP address OR the name of your local machine. The name of the local machine is better in case of dynamic IP usage. Please do not forget to activate "c-move", that ShanoirUploader can actually download the images from the Pacs.

Hint: always set the local IP address as local.dicom.server.host, instead of localhost!

Hint: if your PACS does not support PatientRoot queries, e.g. like Telemis PACS, please use studyDescription or studyDate for the query. ShanoirUploader sends a StudyRoot query in case study attributes only are used, PatientRoot otherwise.

Hint: for GE Healthcare PACS it might happen, that the DICOM server echo does NOT work, even with the correct configuration. In that case please edit the file dicom_server.properties and test with querying the pacs directly.

Guide d'installation

Cette page décrit l'installation de ShanoirUploader, à partir de la version v6.0.3 (v6.0.4 + v7.0.0 + v7.0.1 + v8.0.0 + v9.0.0 inclus).

Introduction

ShanoirUploader est écrit en Java. Suivant le slogan de Java, "write once run everywhere", il fonctionne sur Windows, MacOS et Linux.

Prérequis

  • Vous pouvez avoir besoin des droits d'administrateur sur votre machine pour effectuer l'installation
  • ShanoirUploader 9.0.0 nécessite maintenant Java 21 installé.
  • ShanoirUploader 8.0.0 nécessite Java 17.
  • ShanoirUploader 7.0.1 nécessite Java 8 ou 11 (en fonction de date).
  • ShanoirUploader 6.0.0 nécessite Java 8.
  • JIl est recommandé d'installer un Java Runtime Environement (JRE) OpenJDK car il supporte nativement notre fournisseur de certificats SSL. Voir ici un exemple comment installer: OpenJdk Installation.
  • ATTENTION : pour le projet OFSEP, en utilisant la version "shanoir-uploader-v7.0.1_2021_04_13" de ShanoirUploader VEUILLEZ INSTALLER Java 8 !!! Java 17 est requis pour la dernière version sur GitHub. La version OFSEP ne fonctionnera pas avec Java 11 ; et nécessitent une configuration supplémentaire avec Java 9 ou Java 10 ("--add-modules java.xml.bind"). Ceci est lié à l'évolution de Java : les bibliothèques JAXB, utilisées par ShUp, ont été désactivées par défaut dans Java 9 et Java 10 et entièrement supprimées dans Java 11+.
  • Veuillez définir votre JAVA_HOME (System Preferences - Env variables) vers le dossier d'installation de Java.
  • Veuillez vérifier, par ex. avec java -version, que vous utilisez la bonne version

Package d'installation (x.x.x à remplacer avec la version)

ShanoirUploader est envoyé dans le fichier: shanoir-uploader-x.x.x.zip. Le fichier zip contient 3 fichiers:

  • shanoir-uploader-x.x.x-jar-with-dependencies.jar
  • start-shup-linux-mac-java.sh
  • start-shup-windows-java.bat

Procédure d'installation

La procédure d'installation est très simple et ne nécessite normalement pas de droits d'administration. Copiez simplement le dossier contenant les 3 fichiers à n'importe quel endroit de votre machine, comme exemples:

  • Windows: C:∖Users∖nom_de_utilisateur∖
  • MacOS: /Applications

En fonction de votre système d'exploitation, vous pouvez désormais exécuter ShanoirUploader en utilisant:

  • Windows: start-shup-windows-java.bat (double-clique sur Windows)
  • MacOS/Linux: start-shup-linux-mac-java.sh

ATTENTION : sous Windows !! ne cliquez pas sur JAR shanoir-uploader-6.0.3-jar-with-dependencies.jar, mais sur .BAT

Spécial: pour l'étude OFSEP et pour les utilisateurs avec Mac OSX ou Linux, veuillez utiliser la commande:

/{user.home}/.su_v6.0.x/pseudonymus/MacOSX/chmod 755 PseudonymusShanoir

Vous devriez maintenant voir le StartupDialog de ShanoirUploader. L'installation est terminée, maintenant la configuration démarre.

Configuration

Toutes les configurations pour ShUp peuvent être effectuées à l'aide de l'interface utilisateur graphique.

Proxy

Lors du démarrage de ShUp, il essaie d'atteindre une URL externe, par ex. https://shanoir-ofsep.irisa.fr pour accéder à Serveur Shanoir. Si cet accès échoue (erreur trouvé), la fenêtre de configuration du proxy apparaît:

Veuillez entrer vos propriétés de proxy et cliquez sur enregistrer.

Selection de profile

Profile OFSEP: https://shanoir-ofsep.irisa.fr Profile Neurinfo: https://shanoir.irisa.fr

Nous pouvons configurer un profil par défaut à utiliser à chaque fois en ajoutant par ex. "profile=Neurinfo" vers basic.properties.

Shanoir Server

Veuillez saisir l'identifiant et le mot de passe de votre compte serveur Shanoir en fonction du profil sélectionné. Maintenant, ShUp est opérationnel et vous verrez la fenêtre complète.

PACS

Si vous souhaitez vous connecter au PACS, procédez comme suit:

Votre administrateur PACS devra entrer un nouvel AET en utilisant soit votre adresse IP OU le nom de votre machine locale. Le nom de la machine locale est meilleur en cas d'utilisation IP dynamique. N'oubliez pas d'activer "c-move" pour que ShanoirUploader puisse réellement télécharger les images depuis les Pacs.

Astuce: définissez toujours l'adresse IP locale comme local.dicom.server.host, au lieu de localhost!

Astuce: si votre PACS ne prend pas en charge les requêtes PatientRoot, par ex. comme Telemis PACS, veuillez utiliser studyDescription ou studyDate pour la requête. ShanoirUploader envoie une requête StudyRoot dans le cas où seuls les attributs d'étude sont utilisés, PatientRoot autrement.

Astuce : pour GE Healthcare PACS, il peut arriver que l'écho du serveur DICOM ne fonctionne PAS, même avec le bon configuration. Dans ce cas, veuillez éditer le fichier dicom_server.properties et tester en interrogeant directement les pacs.