path: root/doc/ping903.conf.5
diff options
Diffstat (limited to 'doc/ping903.conf.5')
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/ping903.conf.5 b/doc/ping903.conf.5
index cf3432e..a5e9cc4 100644
--- a/doc/ping903.conf.5
+++ b/doc/ping903.conf.5
@@ -10,13 +10,13 @@
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" GNU General Public License for more details.
.\" You should have received a copy of the GNU General Public License
.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>.
-.TH PING903.CONF 5 "March 10, 2020" "PING903.CONF" "File Formats Manual"
+.TH PING903.CONF 5 "September 19, 2020" "PING903.CONF" "File Formats Manual"
ping903.conf \- configuration file for high-performance ICMP monitoring daemon
The file
.B /etc/ping903.conf
is read by
@@ -64,13 +64,13 @@ through
.BR local7.
.SS Monitoring setup
\fBip\-list \fIFILE\fR
Name of the file supplying a list of IP addresses (or hostnames) to
monitor. Each IP must be listed on a separate line. Empty lines,
-leading and trailing whitespace is ignored. Comments are introduced
+leading and trailing whitespace are ignored. Comments are introduced
by a hash sign as the first non-whitespace character on the line.
\fBip\-list <<\fIWORD\fR
A \fIhere-document\fR version of the above statement. \fIWORD\fR is
an arbitrary word. The material following this statement is scanned
up to the line consisting only of \fIWORD\fR (surrounding whitespace
@@ -79,13 +79,13 @@ address or host name to be incorporated into IP list.
Empty lines and comments are allowed within \fIhere-document\fR.
Multiple \fBip\-list\fR statements of any form accumulate.
\fBprobe\-interval \fIN\fR
-Sets interval between subsequent probes, in seconds. Default is 60
+Sets interval (in seconds) between subsequent probes. Default is 60
(one minute).
\fBping\-count \fIN\fR
Configures the number of ICMP echo requests to be sent to each host
within a single probe. Default is 10.
@@ -109,28 +109,28 @@ Listen for incoming HTTP requests on the given IP address and port.
is the port number of
symbolic service name from
.BR /etc/services .
Either \fIIPADDR\fR or \fIPORT\fR (but not both) can be omitted. Missing
\fIIPADDR\fR is equivalent to (note, that in this case the
colon before \fIPORT\fR must be present). Missing \fIPORT\fR means
-use the default port number (8080).
+the default port number (8080).
To summarize, possible arguments are:
Default is \fB0.0.0.0:8080\fR.
\fBhttp\-backlog\-size \fIN\fR
Configures the size of the
-.BR listen(2)
+.BR listen (2)
backlog queue. Default is the platform-dependent value
(128 on most GNU/Linux systems).
\fBaccess\-log \fIBOOL\fR
-Enable apache-style HTTPD access logging. Valid \fIBOOL\fR values are:
+Enables the apache-style HTTP access logging. Valid \fIBOOL\fR values are:
.BR 1 ,
.BR t ,
.BR true ,
.BR yes ,
.BR on ,
@@ -153,13 +153,13 @@ Adds a CIDR to the list of trusted IP networks. This list is used
when determining source IP address of a HTTP connection for the
purpose of logging. By default, each log message contains the client
IP of the connection. If the
.B X\-Forwarded\-For
header is present, its value overrides that IP. If the
header contains a comma-delimited list of IP addresses, this list is
-processed in right-to-left order, until either a not trusted IP or the
+processed from right to left, until either a not trusted IP or the
first IP in the list is encountered, whichever occurs first.
\fICIDR\fR is either an IPv4 address, or an address followed by slash
and the network mask in dotted quad, or the length of the network mask
in decimal.
@@ -167,22 +167,22 @@ in decimal.
A \fIhere-document\fR version of the above statement. See the
description of \fBip\-list\fR above for the description of
\fIhere-document\fR syntax. The collected material must contain a
single CIDR per line.
.SS HTTP Authorization configuration
It is suggested that HTTP entry points be protected by the HTTP
-authorization. This is especially critical for \fB/config\fR and
-below, which allows the requester to modify \fBping903\fR
+authorization. This is especially critical for the \fB/config\fR
+URL and URLs below it, which allow the requester to modify \fBping903\fR
configuration. This version of \fBping903\fR supports HTTP basic
\fBauth basic\fR \fIMETHOD\fR \fIURL\fR \fIPWFILE\fR \fIREALM\fR
This statement enables basic authentication for \fIURL\fR when
accessed using the given HTTP \fIMETHOD\fR.
-\fIMETHOD\fR is either one of HTTP methods (\fBGET\fR, \fBPOST\fR,
+\fIMETHOD\fR is either the name of an HTTP method (\fBGET\fR, \fBPOST\fR,
etc.) or a wildcard \fB*\fR matching any method.
\fIURL\fR is the \fBping903\fR URL. It is treated as a prefix, i.e.
the statement takes effect for anything below that URL as well. The
\fIURL\fR can also contain
.BR glob (7)
@@ -200,13 +200,13 @@ realm is used by the client to determine what user name and password
to send for a given authenticated area. If \fIREALM\fR contains
whitespace, it must be enclosed in double-quotes. Within a
double-quoted string any occurrence of a double-quote or backslash
character must be escaped by prefixing it with a backslash.
These parameters are mandatory only for the very first occurrence of the
-\fBauth\fR statements. The statements that follow it may omit the
+\fBauth\fR statement. The statements that follow it may omit the
\fIIPFILE\fR and/or \fIREALM\fR, if they are the same as in the
preceding statement. For example, the following statements protect
modifications to the \fBping903\fR configuration with basic
@@ -218,14 +218,14 @@ auth basic PUT /config
Disables authorization for this combination of \fIMETHOD\fR and
\fIURL\fR. See \fBauth basic\fR for the description of \fIMETHOD\fR
and \fIURL\fR.
Use this statement to exempt an URL from authorization which is
otherwise required for its parent URL. For example, the two
-statements below require basic authorization for "/config", excepting
+statements below require basic authorization for "/config", but not
+for "/config/ip-list":
auth none GET /config/ip-list
auth basic GET /config /etc/ping903/htpasswd "Config Access"

Return to:

Send suggestions and report system problems to the System administrator.