b780f49ccf
each readme starts with the plugin's name as a header, this needs to be chopped off to provide a good manual page. Signed-off-by: Miek Gieben <miek@miek.nl>
78 lines
1.3 KiB
Groff
78 lines
1.3 KiB
Groff
.\" Generated by Mmark Markdown Processer - mmark.nl
|
|
.TH "COREDNS-CHAOS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
|
|
|
.SH NAME
|
|
.PP
|
|
\fIchaos\fP - allows for responding to TXT queries in the CH class.
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
This is useful for retrieving version or author information from the server by querying a TXT record
|
|
for a special domainname in the CH class.
|
|
|
|
.SH SYNTAX
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
chaos [VERSION] [AUTHORS...]
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.IP \(bu 4
|
|
\fBVERSION\fP is the version to return. Defaults to \fB\fCCoreDNS-<version>\fR, if not set.
|
|
.IP \(bu 4
|
|
\fBAUTHORS\fP is what authors to return. This defaults to all GitHub handles in the OWNERS files.
|
|
|
|
|
|
.PP
|
|
Note that you have to make sure that this plugin will get actual queries for the
|
|
following zones: \fB\fCversion.bind\fR, \fB\fCversion.server\fR, \fB\fCauthors.bind\fR, \fB\fChostname.bind\fR and
|
|
\fB\fCid.server\fR.
|
|
|
|
.SH EXAMPLES
|
|
.PP
|
|
Specify all the zones in full.
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
version.bind version.server authors.bind hostname.bind id.server {
|
|
chaos CoreDNS\-001 info@coredns.io
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.PP
|
|
Or just default to \fB\fC.\fR:
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
\&. {
|
|
chaos CoreDNS\-001 info@coredns.io
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.PP
|
|
And test with \fB\fCdig\fR:
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
% dig @localhost CH TXT version.bind
|
|
\&...
|
|
;; ANSWER SECTION:
|
|
version.bind. 0 CH TXT "CoreDNS\-001"
|
|
\&...
|
|
|
|
.fi
|
|
.RE
|
|
|