mirror of
https://bitbucket.org/anguist/ntpa
synced 2025-10-06 11:04:40 +00:00
Updated documentation
This commit is contained in:
18
INSTALL
18
INSTALL
@ -12,16 +12,15 @@ Ubuntu
|
||||
|
||||
Run:
|
||||
# sudo apt-get install mono-complete
|
||||
# sudo apt-get install gtk-sharp2 (only for GUI)
|
||||
# sudo apt-get install libgdiplus (only for graphs)
|
||||
# sudo apt-get install mysql-server
|
||||
# sudo apt-get install ntp (use updated versions)
|
||||
|
||||
Build the solution with:
|
||||
# configure MYSQL PGSQL GRAPH
|
||||
# sh configure MYSQL PGSQL GRAPH
|
||||
# make
|
||||
|
||||
Build a pure server version (no GTK) with:
|
||||
Build a pure server version with:
|
||||
# make server
|
||||
|
||||
Install with:
|
||||
@ -32,10 +31,12 @@ Install with:
|
||||
Windows
|
||||
-------
|
||||
|
||||
Download a copy of ntpq and ntpdc. Make sure .NET is installed and
|
||||
the required MySQL Server is accessible. Download and install MySQL
|
||||
if needed. Minor adjustments is needed to get the code up and running.
|
||||
Download a copy of ntpq and make sure .NET is installed and the required
|
||||
MySQL Server is accessible. Download and install MySQL if needed. Minor
|
||||
adjustments is needed to get the code up and running.
|
||||
|
||||
An excellent NTP distribution is available from:
|
||||
https://www.meinbergglobal.com/english/sw/ntp.htm
|
||||
|
||||
Usage
|
||||
-----
|
||||
@ -64,7 +65,4 @@ Connect to ntpa and get a list of available commands:
|
||||
# ntpac 127.0.0.1 9070 help
|
||||
|
||||
Ask ntpa how long time it has been running:
|
||||
# ntpac 127.0.0.1 9070 uptime
|
||||
|
||||
GTK GUI
|
||||
The GTK GUI is experimental and currently broke.
|
||||
# ntpac 127.0.0.1 9070 uptime
|
||||
17
KNOWNBUGS
17
KNOWNBUGS
@ -1,17 +0,0 @@
|
||||
Known bugs in ntpa 0.6.1
|
||||
------------------------
|
||||
|
||||
- Counter for packets received, Packets received accumulated and Packets
|
||||
received since reset are 32 bit and cannot not handle overflow. Values
|
||||
above 2,147,483,647 are shown as 0.
|
||||
- If a host-page is shown in UTC time but data was recorded in local time
|
||||
graphs and time-stamps mismatch. The same applies for host-pages shown
|
||||
in local time but data is recorded in UTC.
|
||||
- The pid file is not deleted if ntpa is started with a database provider
|
||||
but was build without support for the provider.
|
||||
- Configuration setting which are not recognized are ignored. No errors
|
||||
are shown for faulty keywords.
|
||||
- Due to a thread issue ntpa sometimes crashes upon start up. This happens
|
||||
if too many graph are drawn at the same time.
|
||||
- Build script does not handle missing graph dependencies. No warning is
|
||||
show if graphs are configured but ntpa was build without graph support.
|
||||
13
README
13
README
@ -8,7 +8,7 @@ SYNOPSIS
|
||||
|
||||
DESCRIPTION
|
||||
The ntpa daemon is the core process in the NTP Analyzer system.
|
||||
ntpa(8) is responsible for collecting data from NTP daemons. Data are
|
||||
ntpa(1) is responsible for collecting data from NTP daemons. Data are
|
||||
collected using ntpq(8) and ntpctl(8). The ntpa daemon also generates
|
||||
graphs and web pages and perform other tasks like sending status mails.
|
||||
|
||||
@ -16,9 +16,9 @@ DESCRIPTION
|
||||
directory and can be presented by any web server. Additional JavaScript
|
||||
and CSS files are also located in the ntpa www directory.
|
||||
|
||||
NTP Analyzer uses the Twitter Bootstrap and the jQuery framework to
|
||||
make web pages responsive. Pages can not only be viewed on traditional
|
||||
PC screens but also on mobile devices.
|
||||
Pages can be made responsive by configuring them with Bootstrap and
|
||||
jQuery. This way they are viewable on mobile devices and not only on
|
||||
traditional PC screens.
|
||||
|
||||
ntpa can be started with the following options:
|
||||
|
||||
@ -45,12 +45,9 @@ KNOWN BUGS
|
||||
in local time graphs and time stamps mismatch. The same applies for
|
||||
host pages shown in local time but data is recorded in UTC.
|
||||
|
||||
Due to a thread issue ntpa(8) sometimes make a SEG FAULT upon start up.
|
||||
Due to a thread issue ntpa(1) sometimes make a SEG FAULT upon start up.
|
||||
This apparently happens if too many graph are drawn at the same time.
|
||||
|
||||
Configuration setting which are not recognized are ignored. No errors
|
||||
are shown for faulty keywords.
|
||||
|
||||
SEE ALSO
|
||||
ntpd(8), NTP daemon program
|
||||
ntpq(8), NTP query program
|
||||
|
||||
13
docs/ntpa.1
13
docs/ntpa.1
@ -14,7 +14,7 @@ NTP Analyzer daemon program
|
||||
The
|
||||
.B ntpa
|
||||
daemon is the core process in the NTP Analyzer system.
|
||||
.B ntpa(8)
|
||||
.B ntpa(1)
|
||||
is responsible for collecting data from NTP daemons. Data are collected using
|
||||
\fBntpq(8)\fR and \fBntpctl(8)\fR.
|
||||
The ntpa daemon also generates graphs and web pages and perform other tasks
|
||||
@ -24,9 +24,9 @@ The graphs and HTML files generated by ntpa are placed in the ntpa www
|
||||
directory and can be presented by any web server. Additional JavaScript
|
||||
and CSS files are also located in the ntpa www directory.
|
||||
.PP
|
||||
NTP Analyzer uses the Twitter Bootstrap and the jQuery framework to
|
||||
make web pages responsive. Pages can not only be viewed on traditional
|
||||
PC screens but also on mobile devices.
|
||||
Pages can be made responsive by configuring them with Bootstrap and jQuery.
|
||||
This way they are viewable on mobile devices and not only on traditional PC
|
||||
screens.
|
||||
.PP
|
||||
.B ntpa
|
||||
can be started with the following options:
|
||||
@ -51,12 +51,9 @@ local time graphs and time stamps mismatch. The same applies for host pages
|
||||
shown in local time but data is recorded in UTC.
|
||||
.PP
|
||||
Due to a thread issue
|
||||
.B ntpa(8)
|
||||
.B ntpa(1)
|
||||
sometimes make a SEG FAULT upon start up. This apparently happens if too
|
||||
many graph are drawn at the same time.
|
||||
.PP
|
||||
Configuration setting which are not recognized are ignored. No errors
|
||||
are shown for faulty keywords.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
.na
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
# Not tested with ntpa 0.7.0
|
||||
|
||||
|
||||
########## Host graphs ##########
|
||||
|
||||
HostGraph offset24 {
|
||||
|
||||
@ -3,33 +3,17 @@
|
||||
#########################################################
|
||||
|
||||
Database {
|
||||
# Select either MySQL or PostgreSQL
|
||||
Provider MySQL
|
||||
|
||||
# Address of SQL server
|
||||
Host 127.0.0.1
|
||||
|
||||
# Name of database
|
||||
Name ntpa
|
||||
|
||||
# Database username
|
||||
User ntpau
|
||||
|
||||
# Password for the user
|
||||
Pass password
|
||||
|
||||
# Set to 1 to automatically create all tables and data
|
||||
Create 1
|
||||
|
||||
# NOTICE: This feature is not yet implemented
|
||||
# Set to 1 to monitor the database link
|
||||
#Monitor 1
|
||||
}
|
||||
|
||||
Log {
|
||||
# Levels: error, warn, notice, info, debug and trace
|
||||
Severity info
|
||||
File /var/log/ntpa/ntpa.stat.log
|
||||
File ntpa.log
|
||||
}
|
||||
|
||||
Log {
|
||||
|
||||
@ -2,52 +2,35 @@
|
||||
# OpenNTP configuration for NTP Analyzer statistical recordings #
|
||||
#################################################################
|
||||
|
||||
# Connection parameters to SQL database instance.
|
||||
Database {
|
||||
# Select either MySQL or PostgreSQL
|
||||
Provider MySQL
|
||||
|
||||
# Address of SQL server
|
||||
Host 127.0.0.1
|
||||
|
||||
# Name of database
|
||||
Name ntpa
|
||||
|
||||
# Database username
|
||||
User ntpau
|
||||
|
||||
# Password for the user
|
||||
Pass password
|
||||
|
||||
# Set to 1 to automatically create all tables and data.
|
||||
Create 1
|
||||
}
|
||||
|
||||
Log {
|
||||
# Levels: error, warn, notice, info, debug and trace
|
||||
Severity info
|
||||
File ntpa.log
|
||||
}
|
||||
|
||||
Server {
|
||||
# Primary key in database table 'host'
|
||||
HostID 1
|
||||
|
||||
# Address queried by ntpq and ntpdc. OpenNTP can only query localhost
|
||||
# HostAddress ntp1.example.net
|
||||
|
||||
# The utility used to query ntpd. Use ntpdc for old hosts.
|
||||
# User ntpclt for OpenNTP. You might also
|
||||
# User ntpclt for OpenNTP. You might also:
|
||||
# sudo chown root:ntpa /var/lib/openntpd/run/ntpd.sock
|
||||
HostType ntpctl
|
||||
|
||||
HostStats {
|
||||
Frequency 3
|
||||
TimeStamp UTC
|
||||
}
|
||||
|
||||
PeerStats {
|
||||
Frequency 5
|
||||
TimeStamp UTC
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -3,32 +3,17 @@
|
||||
######################################################################
|
||||
|
||||
Database {
|
||||
# Select either MySQL or PostgreSQL
|
||||
Provider MySQL
|
||||
|
||||
# Address of SQL server
|
||||
Host 127.0.0.1
|
||||
|
||||
# Name of database
|
||||
Name ntpa
|
||||
|
||||
# Database user name
|
||||
User ntpau
|
||||
|
||||
# Password for the user
|
||||
Pass password
|
||||
|
||||
# Set to 1 to automatically create all tables and data.
|
||||
Create 1
|
||||
|
||||
# Set to 1 to automatically upgrade database schema.
|
||||
Upgrade 1
|
||||
}
|
||||
|
||||
Log {
|
||||
# Levels: error, warn, notice, info, debug and trace
|
||||
Severity info
|
||||
File "C:/Program Files/NTP Analyzer/log/ntpa.log"
|
||||
File ntpa.log
|
||||
}
|
||||
|
||||
# Synchronize timestamps for readings across different NTP servers/peers
|
||||
@ -49,11 +34,10 @@ Server {
|
||||
# Primary key in database table 'host'
|
||||
HostID 1
|
||||
|
||||
# Address queried by ntpq and ntpdc
|
||||
# Address queried by ntpq
|
||||
HostAddress 127.0.0.1
|
||||
|
||||
# Install ntpq from:
|
||||
# https://www.meinbergglobal.com/english/sw/ntp.htm
|
||||
# Install ntpq from: https://www.meinbergglobal.com/english/sw/ntp.htm
|
||||
HostType ntpq
|
||||
|
||||
HostStats {
|
||||
|
||||
Reference in New Issue
Block a user