NDTS Installation: Difference between revisions

From Network for Advanced NMR
Jump to navigationJump to search
Line 9: Line 9:


Packages are provided as <code>.tar.gz</code> archives on the Facility Dashboard.
Packages are provided as <code>.tar.gz</code> archives on the Facility Dashboard.
== '''Gateway Installation''' ==
=== Prerequisites ===
* A '''Gateway UUID''' supplied by the NAN Repository administrator
* A Linux host (Ubuntu 20.04 or later recommended) reachable by all workstations
* TCP port '''60195''' open inbound from those workstations
=== Installation Steps ===
<pre>
# Copy the .gz file to the gateway computer
tar xf data-transport-gateway-<version>.tar.gz
cd dtgateway-installer
sudo ./install.sh
# → You will be prompted only for the Gateway UUID
</pre>
=== Firewall Note ===
Open port 60195 to each NDTS workstation; no other inbound ports are required.
=== Verifying the Service ===
<pre>
sudo systemctl status data-transport-gateway      # should show “active (running)”
sudo systemctl start  data-transport-gateway      # start if not running
</pre>
=== Updating the Gateway ===
<pre>
# Run the same installer script from a newer package
cd dtgateway-installer
sudo ./install.sh            # auto-detects an existing install; no prompts
</pre>Follow the directions above for verifying the service after updating the Gateway to ensure that the service is running.
=== Uninstalling the Gateway ===
<pre>
sudo ./uninstall.sh          # script is included inside every package
</pre>
=== Rolling Back the Gateway ===
Obtain the desired older package and run its <code>install.sh</code>. 
Rolling back more than one or two versions is not recommended.
----


== '''Daemon Installation (Workstation)''' ==
== '''Daemon Installation (Workstation)''' ==

Revision as of 13:23, 3 June 2025

← Back to NAN Data Transport System Overview

Installing and Updating Daemon and Gateway

This page guides Facility Managers through installing, updating, uninstalling, and rolling back the two local NDTS components:

  • Gateway – facility-level server that receives data from all workstations
  • Daemon – runs on every spectrometer workstation

Packages are provided as .tar.gz archives on the Facility Dashboard.

Daemon Installation (Workstation)

Prerequisites

  1. Gateway IP address
  2. Exact Instrument Name (set in the Facility Dashboard – no spaces)
  3. Workstation UUID (generated when the spectrometer was added)

WARNING: If you are installing on Alma Linux make sure that the chkconfig package is installed before proceeding. Without this service package, the NDTS Workstation will not properly install or run on Alma.

Installation Steps

# Copy the .gz file to the workstation
tar xf data-transport-daemon.<distro>-<version>.tar.gz
cd dtdaemon-installer
sudo ./install.sh
# → Prompts:
#   • Gateway IP address
#   • Instrument name  (e.g., nmr600)
#   • Workstation UUID

Updating the Daemon

# Best practice: ensure no acquisition is running and the UI is closed
cd dtdaemon-installer
sudo ./install.sh              # updates binaries and restarts the daemon

Uninstalling the Daemon

# Download the latest installation package and execute uninstall.sh
sudo ./uninstall.sh

Rolling Back the Daemon

# The system is designed to allow roll-back to any previous version
# However, best practice would be to only roll-back one version in the event that a new version was causing issues.
# Download previous version and install
tar xf data-transport-daemon.<distro>-<old-version>.tar.gz
cd dtdaemon-installer
sudo ./install.sh

What’s Next?