Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderBand committed Dec 21, 2021
1 parent 09b81bb commit d10008e
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 24 deletions.
12 changes: 6 additions & 6 deletions source/developer/python-modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Unbound supports bindings for Python which we call 'pyunbound'. We enable this
functionility in the :command:`configure` step of the installation using the
following command.

.. code:: bash
.. code-block:: bash
./configure --with-pyunbound
We can then generate the documentation for this using:

.. code:: bash
.. code-block:: bash
make doc
Expand All @@ -24,7 +24,7 @@ browsed in a webbrowser by opening ``index.html``.
Another option of gereating the files is available if you are using
:command:`sphinx`.

.. code:: bash
.. code-block:: bash
sphinx-build -b html libunbound/python/doc doc/html/pyunbound/
Expand All @@ -36,15 +36,15 @@ supplied Python code has to follow module operation semantics. This module is
enabled in the :command:`configure` step of the installation using the following
command.

.. code:: bash
.. code-block:: bash
./configure --with-pythonmodule
The full documentation for it can be build using:

We can then generate the documentation for this using:

.. code:: bash
.. code-block:: bash
make doc
Expand All @@ -54,6 +54,6 @@ browsed in a webbrowser by opening ``index.html``.
Another option of gereating the files is available if you are using
:command:`sphinx`.

.. code:: bash
.. code-block:: bash
sphinx-build -b html pythonmod/doc/ doc/html/pythonmod/
16 changes: 8 additions & 8 deletions source/getting-started/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Unbound has a vast array of configuration options for advanced use cases, which

The basic configuration which you can use out of the box is shown below. To use it, you need to create a file with this config as its content (or copy the config to the default config file which can be found during the installation process).

.. code:: bash
.. code-block:: bash
server:
# can be uncommented if you do not need user privilige protection
Expand All @@ -36,7 +36,7 @@ The basic configuration which you can use out of the box is shown below. To use
By default the Unbound config uses `chroot <https://wiki.archlinux.org/title/chroot>`_ to provide an extra layer of defence against remote exploits. If Unbound is not starting because it cannot access files due to permission errors caused by :command:`chroot`, a solution can be to enter file paths as full pathnames starting at the root of the filesystem (``/``). Otherwise, if :command:`chroot` is not required you can disable it in the config.

.. code:: bash
.. code-block:: bash
# disable chroot
chroot: ""
Expand All @@ -51,7 +51,7 @@ Set up Remote Control

A useful functionality to enable is the use of the :command:`unbound-control` command. This allows command makes starting, stopping, and reloading Unbound easier. To enable this functionality we need to add :option:`remote-control` to the config and enable it.

.. code:: bash
.. code-block:: bash
remote-control:
# enable remote-control
Expand All @@ -67,14 +67,14 @@ To use the :command:`unbound-control` command, we need to invoke the :command:`u

Apart from an extensive config file, with just about all the possible configuration options, :command:`unbound-control-setup` creates the cryptographic keys necessary for the control option.

.. code:: bash
.. code-block:: bash
unbound-control-setup
If you use a username like ``unbound`` in the config to run the daemon (which is the default setting), you can use :command:`sudo` to create the files in that user's name, so that the user running Unbound is allowed to read the keys.
This is also a solution if the ``/usr/local/etc/unbound/`` (or any other default direcotry) directory is write-protected, which is the case for some distributions.

.. code:: bash
.. code-block:: bash
sudo -u unbound unbound-control-setup
Expand All @@ -89,14 +89,14 @@ To enable `DNSSEC <https://www.sidn.nl/en/cybersecurity/dnssec-explained>`_, whi
To help, we can use the :command:`unbound-anchor` command. :command:`unbound-anchor` performs the setup by configuring a trust anchor. This trust anchor will only serve as the initial anchor from builtin values. To keep this anchor up to date, Unbound must be able to read and write to this file.
The default location that :command:`unbound-anchor` creates this in is determined by your installation method. Usually the default directory is ``/usr/local/etc/unbound/``.

.. code::bash
.. code-block::bash
unbound-anchor
Note that using a package manager to install Unbound, on some distributions, creates the root key during installation. On Ubuntu 20.04.1 LTS for example, this location is ``/var/lib/unbound/root.key``. On macOS Big Sur this location is ``/opt/homebrew/etc/unbound/root.key`` If you create the root key yourself (by using the :command:`unbound-anchor` command), then the path to the anchor file in the configuration file should be changed to the correct location. To find out the default location you can use the :command:`unbound-anchor` command again with the ``-vvv`` option enabled.
To enable DNSSEC, we add ``auto-trust-anchor-file`` under the ``server`` options in the config.

.. code:: bash
.. code-block:: bash
# enable DNSSEC
auto-trust-anchor-file: "/var/lib/unbound/root.key"
Expand All @@ -105,7 +105,7 @@ Note that on some systems the ``/usr/local/etc/unbound/`` directory might be wri

If the :command:`unbound-control-setup` command fails due to the insufficient permissions, run the command as the correct user, here we use the user ``unbound`` as this is the default user.

.. code:: bash
.. code-block:: bash
sudo -u unbound unbound-anchor
Expand Down
4 changes: 2 additions & 2 deletions source/reference/history/info-timeout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ ping-times of the servers on the internet that unbound has contacted.

The output of a ``lookup`` command can look like this:

.. code:: bash
.. code-block:: bash
$ unbound-control lookup nlnetlabs.nl
The following name servers are used for lookup of nlnetlabs.nl.
Expand Down Expand Up @@ -295,7 +295,7 @@ is also printed (in msec). The infra-cache also contains EDNS status
and lameness information which is also shown. In the above example,
the ping time is very low as most servers are on the same subnet.

.. code:: bash
.. code-block:: bash
192.0.2.1 ttl 316 ping 0 var 94 rtt 376 rto 120000 ednsknown 0 edns 0 delay 0
Expand Down
2 changes: 1 addition & 1 deletion source/reference/history/patch-announce102.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ in total 44 bits of randomness.

Sample config file items to enable this amount of randomness:

.. code:: bash
.. code-block:: bash
server:
# configures 4 static public IP addresses.
Expand Down
2 changes: 1 addition & 1 deletion source/reference/history/prototype-resolver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Source:
The above is the link to the whole prototype area, which you probably don't want
to check out directly. Instead, either check out the trunk or a single branch:

.. code:: bash
.. code-block:: bash
svn co http://svn.verisignlabs.com/unbound/proto/trunk unbound-prototype
Expand Down
2 changes: 1 addition & 1 deletion source/reference/history/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ volunteered to write this implementation.
- If a client makes a query without RD bit, in the case of a returned
message from cache which is:

.. code:: bash
.. code-block:: bash
answer section: empty
auth section: NS record present, no SOA record, no DS record,
Expand Down
10 changes: 5 additions & 5 deletions source/use-cases/local-stub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ The steps go as follows:
Once the IP address is added we can test our Unbound instance (assuming it's running) with :command:`dig`. Note that the Unbound instance cannot be reached before it has been added in the DNS tab in System Preferences.

.. code:: bash
.. code-block:: bash
dig example.com @127.0.0.1
Expand All @@ -124,7 +124,7 @@ Homebrew

If you installed Unbound using Homebrew, the XML file required by :command:`launchctl` is already supplied during installation. The file can be found at ``/Library/LaunchDaemons/homebrew.mxcl.unbound.plist``. To load this file we invoke the following command.

.. code:: bash
.. code-block:: bash
sudo launchctl load /Library/LaunchDaemons/homebrew.mxcl.unbound.plist
Expand All @@ -137,7 +137,7 @@ If you installed Unbound by compiling it yourself, we need to create an XML file

.. zet XML in unbound/contrib (contributed code)
.. code:: bash
.. code-block:: bash
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
Expand Down Expand Up @@ -168,13 +168,13 @@ The main components that interest us, are the items in the ``<array>`` which exe

Using the text editor of choice, we then create the file ``/Library/LaunchDaemons/nl.nlnetlabs.unbound.plist`` and insert the above supplied XML code. To be able to use the file, we need to change the permissions of the file using :command:`chmod`

.. code:: bash
.. code-block:: bash
sudo chmod 644 /Library/LaunchDaemons/nl.nlnetlabs.unbound.plist
We can then load the file with the following command.

.. code:: bash
.. code-block:: bash
sudo launchctl load /Library/LaunchDaemons/nl.nlnetlabs.unbound.plist
Expand Down

0 comments on commit d10008e

Please sign in to comment.