Proposed initial structure.

NLnetLabs · Nov 23, 2018 · 63d3a7b · 63d3a7b
1 parent 79f675c
commit 63d3a7b
Show file tree

Hide file tree

Showing 26 changed files with 232 additions and 0 deletions.
diff --git a/source/getting-started/configuration.rst b/source/getting-started/configuration.rst
@@ -0,0 +1,9 @@
+Configuration
+-------------
+
+Minimal "sane" config:
+
+* ACL
+* unbound-control-setup
+* unbound-anchor
+
diff --git a/source/getting-started/index.rst b/source/getting-started/index.rst
@@ -0,0 +1,11 @@
+Getting Started
+===============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   configuration
+
+
diff --git a/source/getting-started/installation.rst b/source/getting-started/installation.rst
@@ -0,0 +1,8 @@
+Installation
+------------
+
+Describes installation for various systems: Linux, Windows, Mac, The BSDs,
+OpenWRT, Docker.
+
+Describes installation from source.
+
diff --git a/source/index.rst b/source/index.rst
@@ -7,6 +7,12 @@ Welcome to the Unbound User Manual!
    :maxdepth: 2
    :caption: Contents:
 
+   getting-started/index
+   use-cases/index
+   topics/index
+   internals/index
+   libunbound
+   reference
 
 
 Indices and tables

diff --git a/source/internals/architecture.rst b/source/internals/architecture.rst
@@ -0,0 +1,4 @@
+Architecture
+------------
+
+How is Unbound structured, how does it process queries, etc.
diff --git a/source/internals/code-structure.rst b/source/internals/code-structure.rst
@@ -0,0 +1,3 @@
+The Structure of the Source Code
+--------------------------------
+
diff --git a/source/internals/compliance.rst b/source/internals/compliance.rst
@@ -0,0 +1,6 @@
+Standards Compliance
+--------------------
+
+This section lists the RFCs and other standards that Unbound implements and
+where, how, and why it deviates from the standards.
+
diff --git a/source/internals/index.rst b/source/internals/index.rst
@@ -0,0 +1,17 @@
+Internals
+=========
+
+This chapter contains information about the internal workings of Unbound.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   server-selection
+   compliance
+   architecture
+   code-structure
+   python-modules
+   trust-anchors
+
diff --git a/source/internals/python-modules.rst b/source/internals/python-modules.rst
@@ -0,0 +1,6 @@
+Python Modules
+--------------
+
+This section talks about Python modules for Unbound. Using Unbound from
+Python is discussed in the libunbound section.
+
diff --git a/source/internals/server-selection.rst b/source/internals/server-selection.rst
@@ -0,0 +1,3 @@
+Server Selection
+----------------
+
diff --git a/source/internals/trust-anchors.rst b/source/internals/trust-anchors.rst
@@ -0,0 +1,4 @@
+DNSSEC Trust Anchor Management
+------------------------------
+
+This will talk about unbound-anchor and 5011.
diff --git a/source/libunbound.rst b/source/libunbound.rst
@@ -0,0 +1,4 @@
+Embedding Unbound: libunbound
+=============================
+
+Information about using libunbound both from C and Python.
diff --git a/source/reference.rst b/source/reference.rst
@@ -0,0 +1,8 @@
+Reference
+=========
+
+This section will basically contain what is in the manpage currently. We
+need to figure out a smart way to either generate this from the manpage or
+have a common source from which we generate both this and the manpage
+version.
+
diff --git a/source/topics/ecs.rst b/source/topics/ecs.rst
@@ -0,0 +1,7 @@
+EDNS Client Subnet
+------------------
+
+.. todo
+
+   We didn’t quite find a topic to put this in, so we put it here.
+
diff --git a/source/topics/filtering.rst b/source/topics/filtering.rst
@@ -0,0 +1,16 @@
+Filtering and Adding Data
+-------------------------
+
+.. todo
+
+   Adding Data is not quite the best term here. Find a better one!
+
+Local Zones and Local Data
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Tags
+^^^^
+
+Views
+^^^^^
+
diff --git a/source/topics/index.rst b/source/topics/index.rst
@@ -0,0 +1,17 @@
+Topics
+======
+
+This chapter provides an in-depth look into the features of Unbound that
+are important to perform various functions.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   privacy
+   performance
+   filtering
+   monitoring
+   ecs
+   resiliency
+
diff --git a/source/topics/monitoring.rst b/source/topics/monitoring.rst
@@ -0,0 +1,15 @@
+Monitoring and Reporting
+------------------------
+
+.. todo
+
+   Possible additional topics: integration of Unbound in commonly used
+   setups for monitoring and alerting
+
+
+Statistics via `unbound-control`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+DNS TAP
+^^^^^^^
+
diff --git a/source/topics/performance.rst b/source/topics/performance.rst
@@ -0,0 +1,15 @@
+Performance
+-----------
+
+Tuning of General Settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Tuning of the Cache
+^^^^^^^^^^^^^^^^^^^
+
+Shared Cache
+^^^^^^^^^^^^
+
+Auth Zone
+^^^^^^^^^
+
diff --git a/source/topics/privacy.rst b/source/topics/privacy.rst
@@ -0,0 +1,15 @@
+Privacy
+-------
+
+Encryption
+^^^^^^^^^^
+
+Qname Minimization
+^^^^^^^^^^^^^^^^^^
+
+Agressive NSEC
+^^^^^^^^^^^^^^
+
+Auth Zone
+^^^^^^^^^
+
diff --git a/source/topics/resiliency.rst b/source/topics/resiliency.rst
@@ -0,0 +1,10 @@
+Resiliency
+----------
+
+AKA: How to deal with attacks etc.
+
+Rate Limiting
+^^^^^^^^^^^^^
+
+ACLs
+^^^^
diff --git a/source/use-cases/enterprise-resolver.rst b/source/use-cases/enterprise-resolver.rst
@@ -0,0 +1,6 @@
+Resolver for Enterprise Networks
+--------------------------------
+
+Using Unbound as the resolver for the local network of businesses of all
+sizes.
+
diff --git a/source/use-cases/home-resolver.rst b/source/use-cases/home-resolver.rst
@@ -0,0 +1,6 @@
+Resolver for Home Networks
+--------------------------
+
+Using Unbound as the resolver for a home network.
+
+
diff --git a/source/use-cases/index.rst b/source/use-cases/index.rst
@@ -0,0 +1,18 @@
+Use Cases
+=========
+
+This chapter describes how to optimize Unbound for common use cases. It
+provides a configuration that should be good to start with and provides
+pointers to the topics in the next chapter that one should consider
+becoming familiar with.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   enterprise-resolver
+   home-resolver
+   isp-resolver
+   local-stub
+   privacy-aware-resolver
+
diff --git a/source/use-cases/isp-resolver.rst b/source/use-cases/isp-resolver.rst
@@ -0,0 +1,4 @@
+Resolver for ISP Networks
+-------------------------
+
+Using Unbound as the resolver in a network of an ISP.
diff --git a/source/use-cases/local-stub.rst b/source/use-cases/local-stub.rst
@@ -0,0 +1,9 @@
+Stub Resolver of a Single Machine
+---------------------------------
+
+(Is this even a stub resolver or rather a local forwarder?)
+
+.. todo
+
+   Mention that Stubby might be a better option for mobile machines.
+
diff --git a/source/use-cases/privacy-aware-resolver.rst b/source/use-cases/privacy-aware-resolver.rst
@@ -0,0 +1,5 @@
+Maximum Privacy Resolver
+------------------------
+
+Make Unbound as privacy-friendly as possible.
+