From: Otto Moerbeek Date: Tue, 5 Oct 2021 08:47:42 +0000 (+0200) Subject: Apply suggestions from code review X-Git-Tag: auth-4.6.0-alpha1~4^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F10794%2Fhead;p=thirdparty%2Fpdns.git Apply suggestions from code review Co-authored-by: Remi Gacogne --- diff --git a/pdns/recursordist/docs/lua-config/ztc.rst b/pdns/recursordist/docs/lua-config/ztc.rst index a636c92d54..2ee551647c 100644 --- a/pdns/recursordist/docs/lua-config/ztc.rst +++ b/pdns/recursordist/docs/lua-config/ztc.rst @@ -3,9 +3,9 @@ Zone to Cache ------------- -Zone to Cache is a function to load a zone to the Recursor cache periodically or once at startup. +Zone to Cache is a function to load a zone into the Recursor cache periodically, or every time the Lua configuration is loaded, at startup and whenever ``rec_control reload-lua-config`` is issued. This allows the Recursor to have an always hot cache for these zones. -The zone to cache can be retrieved via zone transfer (AXFR format) or read from a zone file retrieved via http, https or a local file. +The zone content to cache can be retrieved via zone transfer (AXFR format) or read from a zone file retrieved via http, https or a local file. Example ^^^^^^^ @@ -41,16 +41,16 @@ Default is 20 seconds. tsigname ~~~~~~~~ -The name of the TSIG key to authenticate to the server when using the ``axfr`` method +The name of the TSIG key to authenticate to the server and validate the zone content with when using the ``axfr`` method. When this is set, `tsigalgo`_ and `tsigsecret`_ must also be set. tsigalgo ~~~~~~~~ -The name of the TSIG algorithm (like 'hmac-md5') used +The name of the TSIG algorithm (like 'hmac-md5') used. tsigsecret ~~~~~~~~~~ -Base64 encoded TSIG secret +Base64 encoded TSIG secret. refreshPeriod ~~~~~~~~~~~~~