Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zekker6 committed Dec 16, 2023
1 parent eda4238 commit 44b4433
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# external-dns adguard provider
# AdguardHome provider for ExternalDNS

This is an early attempt to add support for AdguardHome to external-dns via plugin system introduced in [this PR](https://github.com/kubernetes-sigs/external-dns/pull/3063).
Note that this PR is still in progress and may change in the future.
A [webhook plugin](https://github.com/kubernetes-sigs/external-dns/pull/3063) for [ExternalDNS](https://github.com/kubernetes-sigs/external-dns) to support AdguardHome DNS provider.

This provider implementation is based on using AdguardHome [filtering rules](https://adguard.com/kb/general/ad-filtering/create-own-filters/).
It takes ownership only for rules which are created by this provider, so existing rules are not touched.

## Setting up ExternalDNS for AdguardHome

Expand Down Expand Up @@ -32,15 +34,15 @@ spec:
spec:
containers:
- name: external-dns
image: registry.k8s.io/external-dns/external-dns:v0.13.2
image: registry.k8s.io/external-dns/external-dns:v0.14.0
args:
- --source=service # ingress is also possible
- --domain-filter=example.com # (optional) limit to only example.com domains; change to match the zone created above.
- --provider=plugin
- --plugin-provider-url=http://localhost:8888

- name: adguardhome-provider
image: ghcr.io/zekker6/external-dns-provider-adguard:latest
image: ghcr.io/zekker6/external-dns-provider-adguard:v0.0.8
env:
- name: ADGUARD_HOME_URL
value: "YOUR_ADGUARD_HOME_URL" # Note: URL should be in the format of http://adguard.home:3000/control/
Expand Down Expand Up @@ -104,15 +106,15 @@ spec:
serviceAccountName: external-dns
containers:
- name: external-dns
image: registry.k8s.io/external-dns/external-dns:v0.13.2
image: registry.k8s.io/external-dns/external-dns:v0.14.0
args:
- --source=service # ingress is also possible
- --domain-filter=example.com # (optional) limit to only example.com domains; change to match the zone created above.
- --provider=plugin
- --plugin-provider-url=http://localhost:8888

- name: adguardhome-provider
image: ghcr.io/zekker6/external-dns-provider-adguard:latest
image: ghcr.io/zekker6/external-dns-provider-adguard:v0.0.8
env:
- name: ADGUARD_HOME_URL
value: "YOUR_ADGUARD_HOME_URL" # Note: URL should be in the format of http://adguard.home:3000/control/
Expand Down

0 comments on commit 44b4433

Please sign in to comment.