Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fixes and improvements #466

Merged
merged 25 commits into from
Mar 4, 2022
Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
0a4012f
Grafana instructions for adding influxdb datasource
ukkopahis Dec 12, 2021
f897bf1
Pi-hole: docs to setup DNS for esphome devices
ukkopahis Dec 16, 2021
c06c08a
Fix docs on how to update containers
ukkopahis Dec 17, 2021
9e97ee3
docs: fix syntax and cleanup
ukkopahis Dec 11, 2021
2459ef9
docs: move developer documentation to subfolder
ukkopahis Jan 15, 2022
067995b
docs: add dark and light theme
Willem-Dekker Jul 12, 2020
a81573f
docs: fix unsupported absolute links
ukkopahis Jan 15, 2022
1eacd40
docs: Add how to write documentation
ukkopahis Jan 16, 2022
6be71a5
docs: Add top navigation tabs
ukkopahis Jan 25, 2022
1fc5105
docs: autogenerate heading link anchors
ukkopahis Jan 25, 2022
d38a122
docs: keep top tabs always visible and hide footer
ukkopahis Jan 25, 2022
b05029c
homeassistant: add docs for https reverse proxy setup
ukkopahis Jan 20, 2022
118648d
docs: fix to reflect network change
ukkopahis Jan 29, 2022
0d9b982
Wireguard: better document how PEERDNS works with host resolv.conf
ukkopahis Jan 29, 2022
4f52cf0
docs: fix container menu order
ukkopahis Jan 30, 2022
c614c20
influxdb: document basic usage
ukkopahis Feb 2, 2022
383d213
Merge remote-tracking branch 'upstream/master' into HEAD
ukkopahis Feb 24, 2022
a15ae1f
Pi-hole: improve docs
Paraphraser Feb 18, 2022
6e499db
Octoprint: change doc to use shorter menu title
ukkopahis Feb 24, 2022
40d17ec
docs: fix edit_uri
ukkopahis Feb 24, 2022
519aaee
docs: define mkdocs dependencies in requirements-mkdocs.txt
ukkopahis Feb 24, 2022
179c633
docs: add "stack" logo and favicon
ukkopahis Feb 24, 2022
fd0340c
docs: improve Wiki home page friendliness
ukkopahis Feb 23, 2022
3f9bcea
docs: move Updates/ from subfolder to top-level tab
ukkopahis Feb 24, 2022
4d69183
docs: improve "Getting Started"
ukkopahis Feb 24, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Wireguard: better document how PEERDNS works with host resolv.conf
Fix script comment to properly describe how th bridge gateway works.
ukkopahis committed Feb 1, 2022
commit 0d9b9820d3576df07ca7181351db1d14559ca570
7 changes: 4 additions & 3 deletions .templates/wireguard/use-container-dns.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Forward DNS requests from remote WireGuard clients to the default
# gateway on the internal bridged network that the WireGuard container
# is attached to. This results in queries being sent to any other
# container on the same internal bridged network that is listening
# on port 53 (eg PiHole, AdGuardHome or bind9).
# is attached to. The gateway routes queries out from the bridged network to
# the host's network. This results in queries being sent to any daemon or
# container that is listening on host port 53 (eg PiHole, AdGuardHome, dnsmasq
# or bind9).
#
# Acknowledgement: @ukkopahis

22 changes: 20 additions & 2 deletions docs/Containers/WireGuard.md
Original file line number Diff line number Diff line change
@@ -106,11 +106,26 @@ You have several options for how your remote peers resolve DNS requests:

* `PEERDNS=auto`

The default value of `auto` instructs the WireGuard *service* running within the WireGuard *container* to use the same DNS as the WireGuard *container* when resolving requests from connected peers. In practice, that means the *service* directs queries to 127.0.0.11, which Docker intercepts and forwards to whichever resolvers are specified in the Raspberry Pi's `/etc/resolv.conf`.
DNS queries made on connected WireGuard clients should work as if they were
made on the host. If you [configure](Pi-hole.md#pi-hole-as-dns-server) your
ad-blocker into the host's `resolveconf.conf`, Wireguard clients will also
automatically use it.

Details: The default value of `auto` instructs the WireGuard *service*
running within the WireGuard *container* to use a DNS-service, coredns,
also running in the Wireguard container. Coredns by default directs queries
to 127.0.0.11, which Docker intercepts and forwards to whichever resolvers
are specified in the Raspberry Pi's `/etc/resolv.conf`.

* `PEERDNS=auto` with `custom-cont-init` <a name="customContInit"></a>

This configuration instructs WireGuard to forward DNS queries from remote peers to any **container** which is listening on port 53. This is the option you will want to choose if you are running an ad-blocking DNS server (eg *PiHole* or *AdGuardHome*) in a container on the same host as WireGuard, and you want your remote clients to obtain DNS resolution via the ad-blocker.
This configuration instructs WireGuard to forward DNS queries from remote
peers to any host daemon or **container** which is listening on port 53.
This is the option you will want to choose if you are running an
ad-blocking DNS server (eg *PiHole* or *AdGuardHome*) in a container on the
same host as WireGuard, and you want your remote clients to obtain DNS
resolution via the ad-blocker, but don't want your Raspberry Pi host to use
it.

> Acknowledgement: thanks to @ukkopahis for developing this option.

@@ -160,6 +175,9 @@ You have several options for how your remote peers resolve DNS requests:
```yml
- PEERDNS=192.168.203.65
```
Do note that changes to `PEERDNS` will not be updated to existing clients,
and as such you may want to use `PEERDNS=auto` unless you have a very
specific requirement.

#### Optional configuration - WireGuard ports