mirror of
https://github.com/uklans/cache-domains
synced 2025-08-02 14:21:22 +02:00
This change adds [LeftHook](https://lefthook.dev/) as a GitHub hook management tool alongside [MegaLinter](https://megalinter.io/) to lint all relevant files within the repository. For users that don't end up installing LeftHook for pre-commit hooks, megalinter picks up the necessary formatting changes and reports them. * feat: add lefthook, megalinter and update editorconfig * fix: lint commit ordering * refactor: adjust megalinter reporters * refactor: adjust description for cache domains * refactor: single - for passing options * refactor: add repo-specific fmt in megalinter pre-commands too |
||
---|---|---|
.. | ||
config.example.json | ||
create-adguardhome.sh | ||
create-dnsmasq.sh | ||
create-rpz.sh | ||
create-squid.sh | ||
create-unbound.sh | ||
README.md |
DNS Generation Scripts
Introduction
The respective shell scripts contained within this directory can be utilised to generate application specific compliant configuration which can be utilised with:
- AdGuard Home
- BIND9
- Dnsmasq/Pi-hole
- Squid
- Unbound
Usage
- Copy
config.example.json
toconfig.json
. - Modify
config.json
to include your Cacheserver's IP(s) and the CDNs you plan to cache.
The following example assumes a single shared Cacheserver IP:
{
"combined_output": false,
"ips": {
"monolithic": ["10.10.10.200"]
},
"cache_domains": {
"blizzard": "monolithic",
"epicgames": "monolithic",
"nintendo": "monolithic",
"origin": "monolithic",
"riot": "monolithic",
"sony": "monolithic",
"steam": "monolithic",
"uplay": "monolithic",
"wsus": "monolithic"
}
}
- Run generation script relative to your DNS implementation:
bash create-dnsmasq.sh
. - If
combined_output
is set totrue
this will result in a single output file:lancache.conf
with all your enabled services (applies to Adguard Home, Dnsmasq or Unbound). - Copy files from
output/{adguardhome,dnsmasq,rpz,squid,unbound}/*
to the respective locations for Dnsmasq/Unbound. - Restart the appropriate service.
Notes for Dnsmasq users
This also applies to users utilising the script alongside Pi-hole.
Multi-IP Lancache setups are only supported with Dnsmasq or Pi-hole versions >= 2.86 or 2021.09 respectively.
Notes for AdGuard Home users
- Utilising
"combined_output": true
is more convenient. - Once you have run the script and uploaded the file to the appropriate location, you should navigate to Adguard Home -> Filters -> DNS blocklists -> Add blocklist -> Add a custom list.