Website

This website is built using Docusaurus 2, a modern static website generator.

main branch is published automatically to https://adguardteam.github.io/KnowledgeBaseDNS/.

How to contribute

You can help by contributing to the Knowledge Base, all details are in this article.

How to develop

Prepare

First of all, you need to install the following:

git
yarn

Second, clone this repo to your local computer:

git clone git@github.com:AdguardTeam/KnowledgeBaseDNS.git

Alternatively, you can use the Github app to do that.

Then you should open Terminal on your computer and navigate to the directory where you cloned this repo and run this command to install the local dependencies:

yarn install

Lint markdown

This command lints the markdown and outputs any errors to the console:

yarn lint:md

Some of errors can be fixed automatically:

yarn lint:md --fix

VSCode users can install the markdownlint extension to see the errors in the editor.

Run it locally

yarn start

This command lints markdown syntax, and if there is no markdownlint errors starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

How to build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

How to translate

Translations are not pushed to the repo and prepared on-the-fly (i18n folder is added to .gitignore).

Here's how you can debug translations locally.

Download translations: CROWDIN_PERSONAL_TOKEN="YOURTOKEN" yarn run crowdin download
Run Docusaurus with the language of your choice: yarn run start -- --locale de

How to generate DNS stamps

If you'd like to update the list of known DNS Providers, you'll need to know how to create and check DNS stamps. Read the brief tutorial below to learn how to do it.

For DNS-over-HTTPS

Go to Online DNS Stamp calculator
Choose DNS-over-HTTPS from the drop-down menu
Fill out the Host name and Path fields of the form
Copy the ready DNS stamp from the Stamp field

For DNS-over-TLS

Go to Online DNS Stamp calculator
Choose DNS-over-TLS from the drop-down menu
Fill out the Host name field
Copy the ready DNS stamp from the Stamp field

For DNS-over-QUIC

Go to Online DNS Stamp calculator
Choose DNS-over-QUIC from the drop-down menu
Fill out the Host name field
Copy the ready DNS stamp from the Stamp field

For Plain DNS

Go to Online DNS Stamp calculator
Choose Plain DNS from the drop-down menu
Fill out the IP address field
Copy the ready DNS stamp from the Stamp field

How to check DNS stamps

Install dnslookup using Homebrew or from source
Run a command. Examples of commands for different protocols are given on this page

merdekaid/KnowledgeBaseDNS