From: Tomas Krizek Date: Mon, 8 Jul 2019 15:33:10 +0000 (+0200) Subject: doc: add Quick Reference section to User guide X-Git-Tag: v4.2.0~1^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7aa9d796f8e047c078a5aeb4b1dea65d0e6cc296;p=thirdparty%2Fknot-resolver.git doc: add Quick Reference section to User guide --- diff --git a/doc/index.rst b/doc/index.rst index 45d7c8f97..b8b56ccec 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -11,6 +11,7 @@ and it provides a state-machine like API for extensions. :name: users :maxdepth: 2 + quickref daemon modules diff --git a/doc/quickref.rst b/doc/quickref.rst new file mode 100644 index 000000000..9ef275069 --- /dev/null +++ b/doc/quickref.rst @@ -0,0 +1,8 @@ +*************** +Quick Reference +*************** + +* `Installation `_ +* :ref:`TLS Forwarding ` +* :ref:`network-configuration` +* :ref:`Module: policy ` diff --git a/modules/policy/README.rst b/modules/policy/README.rst index d71efe556..77ce89700 100644 --- a/modules/policy/README.rst +++ b/modules/policy/README.rst @@ -75,6 +75,8 @@ Also, it is possible to write your own action (i.e. Lua function). It is possibl .. note:: The module (and ``kres``) expects domain names in wire format, not textual representation. So each label in name is prefixed with its length, e.g. "example.com" equals to ``"\7example\3com"``. You can use convenience function ``todname('example.com')`` for automatic conversion. +.. _tls-forwarding: + Forwarding over TLS protocol (DNS-over-TLS) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Policy `TLS_FORWARD` allows you to forward queries using `Transport Layer Security`_ protocol, which hides the content of your queries from an attacker observing the network traffic. Further details about this protocol can be found in :rfc:`7858` and `IETF draft dprive-dtls-and-tls-profiles`_.