Commit f0672848 authored by Daniel Salzman's avatar Daniel Salzman

doc: update module scopes

parent 384624a9
......@@ -589,8 +589,9 @@ by the module or even changed altogether.
Each module is configured in the corresponding module section and is
identified for the subsequent usage. Then the identifier is referenced
through :ref:`zone_module` option (in the form of ``module_name/module_id``)
in the zone section or in the ``default`` template if it used for all queries.
in the form of ``module_name/module_id`` through a zone/template :ref:`zone_module`
option or through the *default* template :ref:`template_global-module` option
if it is used for all queries.
``dnstap`` – dnstap-enabled query logging
-----------------------------------------
......@@ -607,7 +608,7 @@ a UNIX socket::
template:
- id: default
module: mod-dnstap/capture_all
global-module: mod-dnstap/capture_all
.. _dnstap: http://dnstap.info/
......@@ -729,7 +730,7 @@ required::
template:
- id: default
module: mod-dnsproxy/default
global-module: mod-dnsproxy/default
zone:
- domain: local.zone
......@@ -832,7 +833,7 @@ Here is an example on how to use the module:
template:
- id: default
module: mod-rosedb/default
global-module: mod-rosedb/default
*Note: The module accepts just one parameter – the path to the directory where
the database will be stored.*
......
......@@ -451,7 +451,7 @@ Default: empty
.sp
A template is a shareable zone setting which can be used for configuration of
many zones in one place. A special default template (with the \fIdefault\fP identifier)
can be used for general querying configuration or as an implicit configuration
can be used for global querying configuration or as an implicit configuration
if a zone doesn\(aqt have another template specified.
.INDENT 0.0
.INDENT 3.5
......@@ -460,6 +460,7 @@ if a zone doesn\(aqt have another template specified.
.ft C
template:
\- id: STR
global\-module: STR/STR ...
# All zone options (excluding \(aqtemplate\(aq item)
.ft P
.fi
......@@ -468,6 +469,14 @@ template:
.SS id
.sp
A template identifier.
.SS global\-module
.sp
An ordered list of references to query modules in the form
\fImodule_name/module_id\fP\&. These modules apply to all queries.
.sp
\fICaution:\fP This option is available only for the \fIdefault\fP template.
.sp
Default: empty
.SH ZONE SECTION
.sp
Definition of zones served by the server.
......@@ -687,7 +696,7 @@ Default: increment
.SS module
.sp
An ordered list of references to query modules in the form
\fImodule_name/module_id\fP\&.
\fImodule_name/module_id\fP\&. These modules apply only to the current zone queries.
.sp
Default: empty
.SH LOGGING SECTION
......
......@@ -523,13 +523,14 @@ Template section
A template is a shareable zone setting which can be used for configuration of
many zones in one place. A special default template (with the *default* identifier)
can be used for general querying configuration or as an implicit configuration
can be used for global querying configuration or as an implicit configuration
if a zone doesn't have another template specified.
::
template:
- id: STR
global-module: STR/STR ...
# All zone options (excluding 'template' item)
.. _template_id:
......@@ -539,6 +540,18 @@ id
A template identifier.
.. _template_global-module:
global-module
-------------
An ordered list of references to query modules in the form
*module_name/module_id*. These modules apply to all queries.
*Caution:* This option is available only for the *default* template.
Default: empty
.. _Zone section:
Zone section
......@@ -799,7 +812,7 @@ module
------
An ordered list of references to query modules in the form
*module_name/module_id*.
*module_name/module_id*. These modules apply only to the current zone queries.
Default: empty
......
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