summaryrefslogtreecommitdiffstats
path: root/doc/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst63
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..f5d9d42
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,63 @@
+.. SPDX-License-Identifier: GPL-3.0-or-later
+
+#############
+Knot Resolver
+#############
+
+Knot Resolver is a minimalistic implementation of a caching validating DNS resolver.
+Modular architecture keeps the core tiny and efficient,
+and it provides a state-machine like API for extensions.
+
+.. toctree::
+ :caption: Quick Start
+ :name: quickstart
+ :maxdepth: 1
+
+ quickstart-install
+ quickstart-startup
+ quickstart-config
+
+.. _configuration-chapter:
+
+.. toctree::
+ :caption: Configuration
+ :name: users
+ :maxdepth: 3
+
+ config-overview
+ config-network
+ config-performance
+ config-policy
+ config-logging-monitoring
+ config-dnssec
+ config-experimental
+ config-no-systemd
+
+.. _operation-chapter:
+
+.. toctree::
+ :caption: Operation
+ :maxdepth: 1
+
+ upgrading
+ NEWS
+
+.. toctree::
+ :caption: Developers
+ :name: developers
+ :maxdepth: 2
+
+ build
+ modules-http-custom-services
+ lib
+ modules_api
+ worker_api
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+