NDTS Installation: Difference between revisions

From Network for Advanced NMR
Jump to navigationJump to search
VisualWikitext
Created page with "= Installing and Updating Daemon and Gateway = This page explains how to install, update, uninstall, and roll back the two local NDTS components: * The '''Daemon''' – installed on each spectrometer workstation * The '''Gateway''' – installed on a facility-level server These components are responsible for harvesting experiment data and transferring it securely to the NAN Repository. == '''Acquiring Installation Packages''' == Installation packages are provided as `..."
 
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Installing and Updating Daemon and Gateway =
{{NDTS_Navbox}}


This page explains how to install, update, uninstall, and roll back the two local NDTS components:
== Installation Workflow ==
* The '''Daemon''' – installed on each spectrometer workstation
* The '''Gateway''' – installed on a facility-level server


These components are responsible for harvesting experiment data and transferring it securely to the NAN Repository.
The typical installation and setup workflow consists of the following steps. See the NDTS User Guide Navigation for links to the various installation, configuration, and usage pages.


== '''Acquiring Installation Packages''' ==
* Install Gateway on dedicated gateway computer in NMR facility network
Installation packages are provided as `.tar.gz` archives and are available for download from the Facility Dashboard.
* Configure Gateway
* Install NDTS Daemon and GUI on all spectrometer workstations
* Configure NDTS Daemon on the spectrometer workstations
* Monitor NDTS daemon and gateway (log files, Slack, and vNOC)
* User management through portal
** add NAN users to the facility
** map local workstation user to NAN user
** set default NDTS settings for each NAN user
** set default NDTS behavior for unassigned user
*[[Enabling TopSpin Accounting|Enable TopSpin accounting]] for TopSpin versions prior to TopSpin 4.x


If a package is missing or access is restricted, submit a support ticket to the NAN Repository team.
== How to Obtain Software ==


== '''Gateway Installation''' ==
Software packages are available from the NAN portal:
=== Prerequisites ===
Before beginning installation:
* Obtain a '''Gateway UUID''' from the NAN Repository administrator
* Use a dedicated Linux machine (Ubuntu 20.04 recommended)
* Ensure TCP port '''60195''' is open to NDTS spectrometer workstations


=== Installation Steps ===
https://usnan.nmrhub.org/facility/downloads
<pre>
# Copy the .gz archive to the gateway system
tar xf filename
cd dtgateway-installer
sudo ./install.sh
# When prompted:
#  Enter the Gateway UUID
</pre>
 
=== Post-Installation ===
<pre>
# Check if the gateway is running
sudo systemctl status data-transport-gateway
 
# If needed, start the service
sudo systemctl start data-transport-gateway
</pre>
 
=== Updating the Gateway ===
<pre>
# Run the same installer script from a newer package
cd dtgateway-installer
sudo ./install.sh
# No prompts are shown during update
</pre>
 
=== Uninstalling the Gateway ===
<pre>
# Run the uninstall script included in the archive
sudo ./uninstall.sh
</pre>
 
=== Rolling Back the Gateway ===
<pre>
# Use the older version’s installer to roll back
tar xf old-version.tar.gz
cd dtgateway-installer
sudo ./install.sh
</pre>
 
== '''Daemon Installation (Spectrometer Workstation)''' ==
=== Prerequisites ===
* IP address of the Gateway
* Exact instrument name (as entered in the Facility Dashboard)
* Workstation UUID (from Facility Dashboard)
* For AlmaLinux, ensure `chkconfig` is installed
 
=== Installation Steps ===
<pre>
# Copy the .gz archive to the workstation
tar xf filename
cd dtdaemon-installer
sudo ./install.sh
# When prompted:
#  Enter Gateway IP address
#  Enter instrument name (e.g., nmr600)
#  Enter workstation UUID
</pre>
 
=== Updating the Daemon ===
<pre>
# Run the same install script
cd dtdaemon-installer
sudo ./install.sh
 
# Note:
# - Best to update when no acquisition is running
# - The installer will close any running UI automatically
</pre>
 
=== Uninstalling the Daemon ===
<pre>
# Run the uninstall script
sudo ./uninstall.sh
</pre>
 
=== Rolling Back the Daemon ===
<pre>
# Use the older install package
tar xf old-version.tar.gz
cd dtdaemon-installer
sudo ./install.sh
</pre>
 
== '''Next Step: Configure the Daemon''' ==
Once installation is complete, continue with: [[NDTS_Daemon_Configuration|Configuring the Daemon]]

Latest revision as of 19:59, 9 June 2025

Installation Workflow

The typical installation and setup workflow consists of the following steps. See the NDTS User Guide Navigation for links to the various installation, configuration, and usage pages.

  • Install Gateway on dedicated gateway computer in NMR facility network
  • Configure Gateway
  • Install NDTS Daemon and GUI on all spectrometer workstations
  • Configure NDTS Daemon on the spectrometer workstations
  • Monitor NDTS daemon and gateway (log files, Slack, and vNOC)
  • User management through portal
    • add NAN users to the facility
    • map local workstation user to NAN user
    • set default NDTS settings for each NAN user
    • set default NDTS behavior for unassigned user
  • Enable TopSpin accounting for TopSpin versions prior to TopSpin 4.x

How to Obtain Software

Software packages are available from the NAN portal:

https://usnan.nmrhub.org/facility/downloads

Retrieved from "https://wiki.usnan.org/index.php?title=NDTS_Installation&oldid=733"