|
|
| (17 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| <span style="display:inline-block; margin-bottom:1em;">[[NAN Data Transport System|← Back to NAN Data Transport System Overview]]</span>
| | {{NDTS_Navbox}} |
|
| |
|
| = Installing and Updating Daemon and Gateway = | | == Installation Workflow == |
|
| |
|
| This page guides Facility Managers through installing, updating, uninstalling, and rolling back the two local NDTS components:
| | 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. |
|
| |
|
| * '''Gateway''' – facility-level server that receives data from all workstations | | * Install Gateway on dedicated gateway computer in NMR facility network |
| * '''Daemon''' – runs on every spectrometer workstation | | * 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 |
|
| |
|
| Packages are provided as <code>.tar.gz</code> archives on the Facility Dashboard.
| | == How to Obtain Software == |
|
| |
|
| == '''Gateway Installation''' ==
| | Software packages are available from the NAN portal: |
|
| |
|
| === Prerequisites ===
| | https://usnan.nmrhub.org/facility/downloads |
| * A '''Gateway UUID''' supplied by the NAN Repository administrator
| |
| * A Linux host (Ubuntu 20.04 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>
| |
| | |
| === 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)''' ==
| |
| | |
| === Prerequisites ===
| |
| # '''Gateway IP address'''
| |
| # Exact '''Instrument Name''' (set in the Facility Dashboard – no spaces)
| |
| # '''Workstation UUID''' (generated when the spectrometer was added)
| |
| | |
| *AlmaLinux only:* install <code>chkconfig</code> before proceeding.
| |
| | |
| === Installation Steps ===
| |
| <pre>
| |
| # 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
| |
| </pre>
| |
| | |
| === Updating the Daemon ===
| |
| <pre>
| |
| # Best practice: ensure no acquisition is running and the UI is closed
| |
| cd dtdaemon-installer
| |
| sudo ./install.sh # updates binaries and restarts the daemon
| |
| </pre>
| |
| | |
| === Uninstalling the Daemon ===
| |
| <pre>
| |
| sudo ./uninstall.sh
| |
| </pre>
| |
| | |
| === Rolling Back the Daemon ===
| |
| <pre>
| |
| tar xf data-transport-daemon.<distro>-<old-version>.tar.gz
| |
| cd dtdaemon-installer
| |
| sudo ./install.sh # not advised to roll back >2 versions
| |
| </pre>
| |
| | |
| == '''Managing the Daemon Service''' ==
| |
| The daemon uses '''SysV service scripts''' for maximum compatibility:
| |
| <pre>
| |
| 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
| |
| </pre>
| |
| | |
| == '''What’s Next?''' ==
| |
| * [[NDTS_Daemon_Configuration|Configuring the Daemon]]
| |
| * [[NDTS_Daemon_Operation|Running and Monitoring the Daemon]]
| |
Navigation of NDTS Documentation
- NAN Data Transport System
- NDTS Overview
- NDTS Installation
- TopSpin 3.x Requirement
- Managing, Monitoring, and Logging
- NDTS Usage Guides
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
