TechnitiumSoftware-DnsServer/build.md

Build Instructions

For Windows

To build the Technitium DNS Server Windows Setup, you need to install Microsoft Visual Studio Community 2022 (VS2022) and Inno Setup on your computer. Once you have it installed, follow the steps below:

1. Open VS2022 and use the "Clone a repository" option to clone the TechnitiumLibrary project using the https://github.com/TechnitiumSoftware/TechnitiumLibrary.git URL. Once the repository is cloned and opened in VS2022, select the build mode to "Release" from the dropdown box in the toolbar and use the Build > Build Solution menu to build it.

2. Open VS2022 and use the "Clone a repository" option to clone the DnsServer project using the https://github.com/TechnitiumSoftware/DnsServer.git URL in the same parent folder that you had cloned the TechnitiumLibrary repository in previous step. Once the repository is cloned and opened in VS2022, right click on the DnsServerSystemTrayApp project and click on the Publish menu to open the publish page. Click the Publish button on it to publish the project in DnsServer\DnsServerWindowsSetup\publish folder. Similarly, right click on the DnsServerWindowsService project and click on the Publish menu to open publish page and use the Publish button to publish the project in the same folder as that of the previous project.

3. Open the DnsServer\DnsServerWindowsSetup\DnsServerSetup.iss file in Inno Setup and click on the Build > Compile menu to generate a Windows setup in DnsServerWindowsSetup\Release folder that you can then use to install Technitium DNS Server on Windows.

For Linux

Follow the instructions given below to build and install the DNS server from source. These instructions are written for Ubuntu and Raspberry Pi OS but, you can easily follow similar steps on your favorite distro.

1. Install prerequisites like curl and git.

   sudo apt update
   sudo apt install curl git -y
   

2. Configure Microsoft Software Repository to be able to install ASP.NET Core SDK. You can follow the instructions given in the link to add the software repository on your distro as shown in examples below:

• Ubuntu 22.04

  curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo tee /etc/apt/trusted.gpg.d/microsoft.asc
  sudo apt-add-repository https://packages.microsoft.com/ubuntu/22.04/prod
  sudo apt update
  

• Raspberry Pi OS

  curl -sSL https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
  sudo apt-add-repository https://packages.microsoft.com/debian/11/prod
  sudo apt update
  

1. Install ASP.NET Core 7 SDK and libmsquic for DNS-over-QUIC support.

   sudo apt install dotnet-sdk-7.0 libmsquic -y
   

Note! The libmsquic package requires openssl v1.1.1 and is not yet compatible with openssl v3.x. You can follow this blog post to know how to get it configured correctly. If you do not plan to use DNS-over-QUIC or HTTP/3 support, or you intend to build a docker image then you can skip installing libmsquic altogether.

1. Clone the source code for both TechnitiumLibrary and DnsServer into the current folder.

   git clone --depth 1 https://github.com/TechnitiumSoftware/TechnitiumLibrary.git TechnitiumLibrary
   git clone --depth 1 https://github.com/TechnitiumSoftware/DnsServer.git DnsServer
   

2. Build the TechnitiumLibrary source.

   dotnet build TechnitiumLibrary/TechnitiumLibrary.ByteTree/TechnitiumLibrary.ByteTree.csproj -c Release
   dotnet build TechnitiumLibrary/TechnitiumLibrary.Net/TechnitiumLibrary.Net.csproj -c Release
   

3. Build the DnsServer source.

   dotnet publish DnsServer/DnsServerApp/DnsServerApp.csproj -c Release
   

4. Install the DNS server as a systemd service.

Note! Skip this step if you wish to build and use docker image.

sudo mkdir -p /opt/technitium/dns
sudo cp -r DnsServer/DnsServerApp/bin/Release/publish/* /opt/technitium/dns
sudo cp /opt/technitium/dns/systemd.service /etc/systemd/system/dns.service
sudo systemctl stop systemd-resolved
sudo systemctl disable systemd-resolved
sudo systemctl enable dns.service
sudo systemctl start dns.service
sudo rm /etc/resolv.conf
echo "nameserver 127.0.0.1" | sudo tee /etc/resolv.conf

1. Build and run docker image.

Note! Skip this step if you have already installed the DNS server as a systemd service in previous step.

Note! Before proceeding to build a docker image, it is required that you have installed docker and docker-compose on your computer.

Follow the commands given below to build a docker image for the DNS server.

cd DnsServer
sudo docker build -t technitium/dns-server:latest .

You can now run the image that you have build using docker-compose as shown below. You should edit the docker-compose.yml file if you wish to edit the container's configuration before running it.

sudo systemctl stop systemd-resolved
sudo systemctl disable systemd-resolved
sudo docker-compose up -d

1. Open the DNS server web console in a web browser using http://<server-ip-address>:5380/ URL and set a login password to complete the installation.