NDTS Installation: Difference between revisions

From Network for Advanced NMR
Jump to navigationJump to search
Line 81: Line 81:
=== Uninstalling the Daemon ===
=== Uninstalling the Daemon ===
<pre>
<pre>
# Download the latest installation package and execute uninstall.sh
sudo ./uninstall.sh
sudo ./uninstall.sh
</pre>
</pre>
Line 86: Line 87:
=== Rolling Back the Daemon ===
=== Rolling Back the Daemon ===
<pre>
<pre>
# 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
tar xf data-transport-daemon.<distro>-<old-version>.tar.gz
cd dtdaemon-installer
cd dtdaemon-installer
sudo ./install.sh             # not advised to roll back >2 versions
sudo ./install.sh
</pre>
</pre>


== '''Managing the Daemon Service''' ==
== '''Managing the Daemon Service''' ==
The daemon uses '''SysV service scripts''' for maximum compatibility:
The daemon uses '''SysV service scripts''' for maximum compatibility
 
The system is designed to be running at all times. The NDTS GUI may be used to turn off data harvesting when needed. If the daemon must be existed, use the stop command below.
 
Note that starting the daemon while it is running will not start a new instance and will not cause issues.
<pre>
<pre>
sudo /sbin/service data-transport-daemon start
sudo /sbin/service data-transport-daemon start

Revision as of 19:09, 2 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.

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

# 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

Firewall Note

Open port 60195 to each NDTS workstation; no other inbound ports are required.

Verifying the Service

sudo systemctl status data-transport-gateway      # should show “active (running)”
sudo systemctl start  data-transport-gateway      # start if not running

Updating the Gateway

# Run the same installer script from a newer package
cd dtgateway-installer
sudo ./install.sh             # auto-detects an existing install; no prompts

Follow the directions above for verifying the service after updating the Gateway to ensure that the service is running.

Uninstalling the Gateway

sudo ./uninstall.sh           # script is included inside every package

Rolling Back the Gateway

Obtain the desired older package and run its install.sh. Rolling back more than one or two versions is not recommended.


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

Managing the Daemon Service

The daemon uses SysV service scripts for maximum compatibility

The system is designed to be running at all times. The NDTS GUI may be used to turn off data harvesting when needed. If the daemon must be existed, use the stop command below.

Note that starting the daemon while it is running will not start a new instance and will not cause issues.

sudo /sbin/service data-transport-daemon start
sudo /sbin/service data-transport-daemon stop
sudo /sbin/service data-transport-daemon restart
sudo /sbin/service data-transport-daemon status

What’s Next?