summaryrefslogtreecommitdiffstats
path: root/modules/serve_stale/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'modules/serve_stale/README.rst')
-rw-r--r--modules/serve_stale/README.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/modules/serve_stale/README.rst b/modules/serve_stale/README.rst
new file mode 100644
index 0000000..6d2230c
--- /dev/null
+++ b/modules/serve_stale/README.rst
@@ -0,0 +1,23 @@
+.. SPDX-License-Identifier: GPL-3.0-or-later
+
+.. _mod-serve_stale:
+
+Serve stale
+===========
+
+Demo module that allows using timed-out records in case kresd is
+unable to contact upstream servers.
+
+By default it allows stale-ness by up to one day,
+after roughly four seconds trying to contact the servers.
+It's quite configurable/flexible; see the beginning of the module source for details.
+See also the RFC draft_ (not fully followed) and :any:`cache.ns_tout`.
+
+Running
+-------
+.. code-block:: lua
+
+ modules = { 'serve_stale < cache' }
+
+.. _draft: https://tools.ietf.org/html/draft-ietf-dnsop-serve-stale-00
+