NovaStar Program Reference / System / Overview

System programs perform core NovaStar functionality including system startup and shutdown, diagnostics, and system processes.

• Summary
• NovaStar Administration - control NovaStar start, stop, etc.
• System Processes (continuous) - processes that run continuously
• System Processes (cron) - processes that run on a schedule
• Utilities, Backup and Restore
• Utilities, General
• Utilities, Lock Files
• Utilities, Log Files
• Utilities, Modem
• Utilities, Shell
• Utilities, Time
• Utilities, Tomcat
• Utilities, Updating NovaStar
• Utilities, Website

---

Summary

TODO smalers 2017-11-26 Need to insert summary of system processes.

NovaStar Administration

NovaStar administration (or "admin") programs control NovaStar startup, shutdown, restart, etc.

• novastar5 - master program to start, stop, restart, etc. NovaStar core components

System Processes (continuous)

System processes are started automatically when a NovaStar base station restarts and perform important ongoing tasks such as data collection. It may be necessary to troubleshoot the status of these programs if the system is not performing as expected.

• see the ns50386server Data Collection program for HydroLynx stations
• see the nsalerttalk3 Notification program
• see the nsautointer Data Collection program for station polling
• see the nsmapdisplay Display program for HydroLynx hardware map
• nsnetcat - NovaStar network to serial pipe (used to control hardware devices like sirens)
• nssystemcommand - run commands queued up in the NovaStar system commands table
• rsyslog - system logging control

System Processes (cron)

Some processes are run on a scheduler via Linux cron in order to perform regular tasks.

• nshealthcheck - NovaStar system health check and repair
• nslogmaintenance - NovaStar log file maintenance

Utilities, Backup and Restore

• nsfiles-ssh-backup - backup NovaStar files to remote host
• see also Database backup utilities

Utilities, General

General utilities can be run from the command line to provide useful information and perform system administration tasks.

• nsaddsudouser - add a user to have sudo privileges
• nscronupdate - update cron file based on NovaStar database scheduled processes
• nscopysshkey - copy public ssh key to remote host
• nsfoldermaintenance - set ownership permissions in NovaStar folder
• nsversion - print core system version

Utilities, Lock Files

• nsunlock - remove NovaStar lock files

Utilities, Log Files

• nslogfilesearch - search log files for matching string
• see nsloglogmaintenance in System Processes (cron)

Utilities, Modem

• hangup - hangup a modem line
• mdmstate - display/set modem state

Utilities, Shell

• nsh - run command in shell with NovaStar environment
• nspath - set PATH to include NovaStar program folders
• slay - kill a process by name
• waitfor - read input until string matched

Utilities, Time

• dispdate - format and print date/time
• nsprintinterval - TODO smalers need to document
• nstime - display current NovaStar time

Utilities, Tomcat

• nstomcatmaintenance - set /tomcat file ownership and permissions

Utilities, Updating NovaStar

The following utilities are used to update the NovaStar software.

• nsupdate - update NovaStar system to latest version

Utilities, Website

• nswwwmaintenance - set /www ownership and permissions