openwrt / openwrt/packages

stubby: Inconsistent documentation - DNS forwarders and Stubby Listeners - Which setup is correct?

Open
#17,256 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

release/21.02 stale
Dominant language
Makefile
Stars
4.6k
Forks
4k
Avg merge
3d 12h
Merged PRs (30d)
134

Description

Maintainer: @jamesmacwhite
Environment:

Item Value
Model BT Home Hub 5A
Architecture xRX200 rev 1.2
Firmware Version OpenWrt 21.02.1 r16325-88151b8303 / LuCI openwrt-21.02 branch git-21.295.67054-13df80d
Kernel Version 5.4.154

Description:

The instructions on https://github.com/openwrt/packages/blob/master/net/stubby/files/README.md

uci add_list dhcp.@dnsmasq[-1].server='127.0.0.1#5453'
uci set dhcp.@dnsmasq[-1].noresolv=1
uci commit && reload_config

Do not match with https://openwrt.org/docs/guide-user/services/dns/dot_dnsmasq_stubby

# Install packages
opkg update
opkg install stubby
 
# Enable DNS encryption
/etc/init.d/dnsmasq stop
uci set dhcp.@dnsmasq[0].noresolv="1"
uci -q delete dhcp.@dnsmasq[0].server
uci get stubby.global.listen_address \
| sed -e "s/\s/\n/g;s/@/#/g" \
| while read -r STUBBY_SERV
do uci add_list dhcp.@dnsmasq[0].server="${STUBBY_SERV}"
done
uci commit dhcp
/etc/init.d/dnsmasq start

The reason is that in the stubby config file there are 2 listeners defined and then UCI script above uses this to create the DNS forwarders in the dhcp config file.
https://github.com/openwrt/packages/blob/04b82e9da01e8c067702867e3ad2a604f481b169/net/stubby/files/stubby.conf#L18-L19

In the instructions of the readme it says only to create a listener on 127.0.0.1#5453

Questions:

Which stubby listener setup is correct?

127.0.0.1#5453
or
127.0.0.1#5453
0::1#53

Which dnsmasq forwarder setup is correct?

127.0.0.1#5453
or
127.0.0.1#5453
0::1#53

Depending on the answer 1 set of documentation needs to be changed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare net/stubby/files/README.md with the OpenWrt DNS-over-TLS documentation and the referenced stubby.conf listener definitions at lines 18-19. Determine which Stubby listener and dnsmasq forwarder setup is intended, then update the inconsistent documentation so both sources describe the same configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation, networking
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.