Commit 82ea1075 authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

[master] update documentation for trac811 (Xfrin/zones) configurations

Some configurations are removed.
And introduce new configurations.

Also mentioned deprecated configs in the ChangeLog so they are noticed
easily. There is a bug related to this... see Trac #948.
parent 358e2303
......@@ -13,7 +13,9 @@
Updated configuration options to Xfrin, so that you can specify
a master address, port, and TSIG key per zone. Still only one per
zone at this point, and TSIG keys are (currently) only specified
by their full string representation.
by their full string representation. This replaces the
Xfrin/master_addr, Xfrin/master_port, and short-lived
Xfrin/tsig_key configurations with a Xfrin/zones list.
(Trac #811, git 88504d121c5e08fff947b92e698a54d24d14c375)
239. [bug] jerry
......
......@@ -2,12 +2,12 @@
.\" Title: b10-xfrin
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: September 8, 2010
.\" Date: May 19, 2011
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-XFRIN" "8" "September 8, 2010" "BIND10" "BIND10"
.TH "B10\-XFRIN" "8" "May 19, 2011" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -61,15 +61,34 @@ receives its configurations from
.PP
The configurable settings are:
.PP
\fImaster_addr\fR
The default is 127\&.0\&.0\&.1\&.
.PP
\fImaster_port\fR
The default is 53\&.
.PP
\fItransfers\-in\fR
defines the maximum number of inbound zone transfers that can run concurrently\&. The default is 10\&.
.PP
\fIzones\fR
is a list of zones known to the
\fBb10\-xfrin\fR
daemon\&. The list items are:
\fIname\fR
(the zone name),
\fImaster_addr\fR
(the zone master to transfer from),
\fImaster_port\fR
(defaults to 53), and
\fItsig_key\fR
(optional TSIG key to use)\&. The
\fItsig_key\fR
is specified using a full string colon\-delimited name:key:algorithm representation (e\&.g\&.
\(lqfoo\&.example\&.org:EvABsfU2h7uofnmqaRCrhHunGsd=:hmac\-sha1\(rq)\&.
.PP
(The site\-wide
\fImaster_addr\fR
and
\fImaster_port\fR
configurations are deprecated; use the
\fIzones\fR
list configuration instead\&.)
.PP
The configuration commands are:
.PP
......@@ -106,7 +125,9 @@ to define the class (defaults to
\fImaster\fR
to define the IP address of the authoritative server to transfer from, and
\fIport\fR
to define the port number on the authoritative server (defaults to 53)\&.
to define the port number on the authoritative server (defaults to 53)\&. If the address or port is not specified, it will use the values previously defined in the
\fIzones\fR
configuration\&.
.PP
\fBshutdown\fR
......@@ -143,5 +164,5 @@ The
daemon was implemented in March 2010 by Zhang Likun of CNNIC for the ISC BIND 10 project\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2010 Internet Systems Consortium, Inc. ("ISC")
Copyright \(co 2010-2011 Internet Systems Consortium, Inc. ("ISC")
.br
......@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]>
<!--
- Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
- Copyright (C) 2010-2011 Internet Systems Consortium, Inc. ("ISC")
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
......@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
<date>September 8, 2010</date>
<date>May 19, 2011</date>
</refentryinfo>
<refmeta>
......@@ -36,7 +36,7 @@
<docinfo>
<copyright>
<year>2010</year>
<year>2010-2011</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
......@@ -92,20 +92,33 @@ in separate zonemgr process.
The configurable settings are:
</para>
<para><varname>master_addr</varname>
<!-- TODO: how can there be a single setting for this? -->
The default is 127.0.0.1.
<para><varname>transfers-in</varname>
defines the maximum number of inbound zone transfers
that can run concurrently. The default is 10.
</para>
<para><varname>master_port</varname>
<!-- TODO: what if custom is needed per zone? -->
The default is 53.
<!-- TODO: is name okay for master_addr or just IP? -->
<para>
<varname>zones</varname> is a list of zones known to the
<command>b10-xfrin</command> daemon.
The list items are:
<varname>name</varname> (the zone name),
<varname>master_addr</varname> (the zone master to transfer from),
<varname>master_port</varname> (defaults to 53), and
<varname>tsig_key</varname> (optional TSIG key to use).
The <varname>tsig_key</varname> is specified using a full string
colon-delimited name:key:algorithm representation (e.g.
<quote>foo.example.org:EvABsfU2h7uofnmqaRCrhHunGsd=:hmac-sha1</quote>).
</para>
<!-- TODO: document this better -->
<!-- TODO: the tsig_key format may change -->
<para><varname>transfers-in</varname>
defines the maximum number of inbound zone transfers
that can run concurrently. The default is 10.
<para>
(The site-wide <varname>master_addr</varname> and
<varname>master_port</varname> configurations are deprecated;
use the <varname>zones</varname> list configuration instead.)
</para>
<!-- NOTE: also tsig_key but not mentioning since so short lived. -->
<!-- TODO: formating -->
<para>
......@@ -154,6 +167,9 @@ in separate zonemgr process.
the authoritative server to transfer from,
and <varname>port</varname> to define the port number on the
authoritative server (defaults to 53).
If the address or port is not specified, it will use the
values previously defined in the <varname>zones</varname>
configuration.
</para>
<!-- TODO: later hostname for master? -->
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment