.. SPDX-License-Identifier: GPL-3.0-or-later

.. _quickstart-intro:

Welcome to Knot Resolver Quick Start Guide! This chapter will guide you through first installation and basic setup recommended for your use-case.

Before we start let us explain basic conventions used in this text:

This is Linux/Unix shell command to be executed and an output from this command:

.. code-block:: bash

    $ echo "This is output!"
    This is output!
    $ echo "We use sudo to execute commands as root:"
    We use sudo to execute commands as root:
    $ sudo id
    uid=0(root) gid=0(root) groups=0(root)

Snippets from Knot Resolver's configuration file **do not start with $ sign** and look like this:

.. code-block:: lua

    -- this is a comment
    -- following line will start listening on IP address 192.0.2.1 port 53
    net.listen('192.0.2.1')


.. _quickstart-install:

************
Installation
************

As a first step, configure your system to use upstream repositories which have
the **latest version** of Knot Resolver. Follow the instructions below for your
distribution.

**Debian/Ubuntu**

.. note:: Please note that the packages available in distribution repositories
   of Debian and Ubuntu are outdated. Make sure to follow these steps to use
   our upstream repositories.

.. code-block:: bash

    $ wget https://secure.nic.cz/files/knot-resolver/knot-resolver-release.deb
    $ sudo dpkg -i knot-resolver-release.deb
    $ sudo apt update
    $ sudo apt install -y knot-resolver

**CentOS 7+**

.. code-block:: bash

    $ sudo yum install -y epel-release
    $ sudo yum install -y knot-resolver

**Fedora**

.. code-block:: bash

    $ sudo dnf install -y knot-resolver

**Arch Linux**

.. code-block:: bash

   $ sudo pacman -S knot-resolver


**openSUSE Leap / Tumbleweed**
Add the `OBS <https://en.opensuse.org/Portal:Build_Service>`_ package repository `home:CZ-NIC:knot-resolver-latest <https://software.opensuse.org/download.html?project=home%3ACZ-NIC%3Aknot-resolver-latest&package=knot-resolver>`_ to your system.
