diff options
Diffstat (limited to 'doc/ping903.conf.5')
| -rw-r--r-- | doc/ping903.conf.5 | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/ping903.conf.5 b/doc/ping903.conf.5 index cf3432e..e66143d 100644 --- a/doc/ping903.conf.5 +++ b/doc/ping903.conf.5 @@ -1,5 +1,5 @@ .\" This file is part of ping903 -*- nroff -*- -.\" Copyright (C) 2020 Sergey Poznyakoff +.\" Copyright (C) 2020-2023 Sergey Poznyakoff .\" .\" Ping903 is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by @@ -13,7 +13,7 @@ .\" .\" 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" .SH NAME ping903.conf \- configuration file for high-performance ICMP monitoring daemon .SH DESCRIPTION @@ -67,7 +67,7 @@ through \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. .TP \fBip\-list <<\fIWORD\fR @@ -82,7 +82,7 @@ Empty lines and comments are allowed within \fIhere-document\fR. Multiple \fBip\-list\fR statements of any form accumulate. .TP \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). .TP \fBping\-count \fIN\fR @@ -112,7 +112,7 @@ symbolic service name from Either \fIIPADDR\fR or \fIPORT\fR (but not both) can be omitted. Missing \fIIPADDR\fR is equivalent to 127.0.0.1 (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: \fIIPADDR\fB:\fIPORT\fR, \fIIPADDR\fR, or \fB:\fIPORT\fR. @@ -121,13 +121,13 @@ Default is \fB0.0.0.0:8080\fR. .TP \fBhttp\-backlog\-size \fIN\fR Configures the size of the -.BR listen(2) +.BR listen (2) backlog queue. Default is the platform-dependent value .BR SOMAXCONN , (128 on most GNU/Linux systems). .TP \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 , @@ -156,7 +156,7 @@ 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 @@ -170,8 +170,8 @@ description of \fBip\-list\fR above for the description of 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 authorization. .TP @@ -179,7 +179,7 @@ authorization. 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. @@ -203,7 +203,7 @@ 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 @@ -221,8 +221,8 @@ 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 -"/config/ip-list": +statements below require basic authorization for "/config", but not +for "/config/ip-list": .sp .nf auth none GET /config/ip-list |