NDTS Installation: Difference between revisions

From Network for Advanced NMR
Jump to navigationJump to search
No edit summary
Line 10: Line 10:


== '''Acquiring Installation Packages''' ==
== '''Acquiring Installation Packages''' ==
Installation packages are provided as `.tar.gz` archives and are available for download from the Facility Dashboard.
Installation packages are provided as `.tar.gz` archives and are available for [[Download Software|download]] from the Facility Dashboard.


If a package is missing or access is restricted, submit a support ticket to the NAN Repository team.
If a package is missing or access is restricted, submit a support ticket to the NAN Repository team.
Line 17: Line 17:
=== Prerequisites ===
=== Prerequisites ===
Before beginning installation:
Before beginning installation:
* Obtain a '''Gateway UUID''' from the NAN Repository administrator
* Obtain a '''Gateway UUID''' from the NAN support team
* Use a dedicated Linux machine (Ubuntu 20.04 recommended)
* Use a dedicated Linux machine (Ubuntu 20.04 or later recommended)
* Ensure TCP port '''60195''' is open to NDTS spectrometer workstations
* Ensure TCP port '''60195''' is open to NDTS spectrometer workstations


Line 65: Line 65:
=== Prerequisites ===
=== Prerequisites ===
* IP address of the Gateway
* IP address of the Gateway
* Exact instrument name (as entered in the Facility Dashboard)
* Exact instrument name (as entered in the [[Spectrometers]] section of the Facility Dashboard)
* Workstation UUID (from Facility Dashboard)
* Workstation UUID (from the [[Spectrometers]] section of the Facility Dashboard)
* For AlmaLinux, ensure `chkconfig` is installed
* For AlmaLinux, ensure `chkconfig` is installed



Revision as of 17:59, 2 June 2025

← Back to NAN Data Transport System Overview

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 `.tar.gz` archives and are available for download from the Facility Dashboard.

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

Gateway Installation

Prerequisites

Before beginning installation:

  • Obtain a Gateway UUID from the NAN support team
  • Use a dedicated Linux machine (Ubuntu 20.04 or later recommended)
  • Ensure TCP port 60195 is open to NDTS spectrometer workstations

Installation Steps

# Copy the .gz archive to the gateway system
tar xf filename
cd dtgateway-installer
sudo ./install.sh
# When prompted:
#   Enter the Gateway UUID

Post-Installation

# Check if the gateway is running
sudo systemctl status data-transport-gateway

# If needed, start the service
sudo systemctl start data-transport-gateway

Updating the Gateway

# Run the same installer script from a newer package
cd dtgateway-installer
sudo ./install.sh
# No prompts are shown during update

Uninstalling the Gateway

# Run the uninstall script included in the archive
sudo ./uninstall.sh

Rolling Back the Gateway

# Use the older version’s installer to roll back
tar xf old-version.tar.gz
cd dtgateway-installer
sudo ./install.sh

Daemon Installation (Spectrometer Workstation)

Prerequisites

  • IP address of the Gateway
  • Exact instrument name (as entered in the Spectrometers section of the Facility Dashboard)
  • Workstation UUID (from the Spectrometers section of the Facility Dashboard)
  • For AlmaLinux, ensure `chkconfig` is installed

Installation Steps

# 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

Updating the Daemon

# 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

Uninstalling the Daemon

# Run the uninstall script
sudo ./uninstall.sh

Rolling Back the Daemon

# Use the older install package
tar xf old-version.tar.gz
cd dtdaemon-installer
sudo ./install.sh

Next Step: Configure the Daemon

Once installation is complete, continue with: Configuring the Daemon