.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "GDNSD-PLUGIN-HTTP_STATUS 8"
.TH GDNSD-PLUGIN-HTTP_STATUS 8 2024-03-15 "gdnsd 3.8.2" gdnsd
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
gdnsd\-plugin\-http_status \- gdnsd HTTP monitoring plugin
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Example http_status service_types config:
.PP
.Vb 10
\&  service_types => {
\&    webcheck => {
\&      plugin => http_status,
\&      port => 8080,             # default 80
\&      url_path => /checkme      # default \*(Aq/\*(Aq
\&      vhost => www.example.com  # default none
\&      ok_codes => [ 200, 301 ], # default [ 200 ]
\&      up_thresh => 20,
\&      ok_thresh => 10,
\&      down_thresh => 10,
\&      interval => 10,
\&      timeout => 3,
\&    }
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBgdnsd\-plugin\-http_status\fR is a monitoring plugin that
checks basic HTTP service.
.SH PARAMETERS
.IX Header "PARAMETERS"
.IP port 4
.IX Item "port"
The numeric port number to connect on, default \f(CW80\fR.
.IP url_path 4
.IX Item "url_path"
The string URL to GET from the remote service, default \f(CW\*(C`/\*(C'\fR
.IP vhost 4
.IX Item "vhost"
The string hostname to supply as a \f(CW\*(C`Host:\*(C'\fR header with the
request.  No default.  If unspecified, no \f(CW\*(C`Host:\*(C'\fR header is
sent at all.
.IP ok_codes 4
.IX Item "ok_codes"
An array of integer HTTP status codes which are acceptable
as positive responses.  The default is \f(CW\*(C`[ 200 ]\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBgdnsd.config\fR\|(5), \fBgdnsd.zonefile\fR\|(5), \fBgdnsd\fR\|(8)
.PP
The gdnsd manual.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2014 Brandon L Black <blblack@gmail.com>
.PP
This file is part of gdnsd.
.PP
gdnsd is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.PP
gdnsd is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with gdnsd.  If not, see
<http://www.gnu.org/licenses/>.