Перейти к основному содержанию

Обзор

What is AdGuard DNS CLI?

A cross-platform lightweight DNS client for AdGuard DNS. Он работает как DNS-сервер, перенаправляющий DNS-запросы соответствующим upstream-резолверам.

Быстрый старт

Поддерживаемые операционные системы:

  • Linux
  • macOS
  • Windows

Поддерживаемые архитектуры процессоров:

  • 64-разрядный ARM
  • AMD64
  • i386

Начало работы

Unix-подобные операционные системы

  1. Скачайте и распакуйте архив .tar.gz или .zip со страницы релизов.

    caution

    On macOS, it’s crucial that globally installed daemons are owned by root (see the launchd documentation), so the adguarddns-cli executable must be placed in the /Applications/ directory or its subdirectory.

  2. Установите его как службу, выполнив:

    ./adguarddns-cli -s install -v
  3. Отредактируйте файл конфигурации config.yaml.

  4. Запустите службу:

    ./adguarddns-cli -s start -v

Чтобы убедиться, что он работает, используйте любую утилиту проверки DNS. Например, с помощью nslookup:

nslookup -debug 'www.example.com' '127.0.0.1'

Windows

Просто скачайте и установите с помощью установщика MSI со страницы релизы.

Чтобы убедиться, что он работает, используйте любую утилиту проверки DNS. Например, с помощью nslookup.exe:

nslookup -debug "www.example.com" "127.0.0.1"

Параметры командной строки

Каждый параметр переопределяет соответствующее значение, предоставленное файлом конфигурации и средой.

Справка

Option -h makes AdGuard DNS CLI print out a help message to standard output and exit with a success status-code.

Сервис

Параметр -s <value> определяет действие службы ОС. Возможные значения:

  • install: installs AdGuard DNS CLI as a service
  • restart: restarts the running AdGuard DNS CLI service
  • start: starts the installed AdGuard DNS CLI service
  • status: shows the status of the installed AdGuard DNS CLI service
  • stop: stops the running AdGuard DNS CLI
  • uninstall: uninstalls AdGuard DNS CLI service

Подробно

Параметр -v включает подробный вывод логов.

Версия

Option --version makes AdGuard DNS CLI print out the version of the application to standard output and exit with a success status-code.

Конфигурация

Файл

Конфигурационный файл YAML описан в отдельной статье, там же есть пример конфигурационного файла config.dist.yaml. Некоторые параметры конфигурации также можно переопределить с помощью среды.

Коды выхода

Существует несколько кодов выхода, которые могут появляться при различных условиях ошибки:

  • 0: успешное завершение и выход, ошибок нет.

  • 1: внутренняя ошибка, скорее всего, неправильная конфигурация.

  • 2: неверный аргумент или значение командной строки.