LANCache-TDNSApp

Technitium DNS App for LANCache.NET

This DNS App, will use a specified set of domains to cache. And intercept requests for those domains with configured lancache addresses.
This implements the functionality of Lancache-DNS and is intended to be used with LANCache Monolithic.

Requirements

1. Technitium DNS server
2. LANCache Monolithic instance(s) (Or other compatible implementation.)
3. The cache server should ideally be accessible using a address in the ULA/RFC1918 IP address range.

Installation

1. Download the ZIP file from Github Releases
2. Go to 'Apps' in Technitium DNS
3. Click the 'Install' button
4. Specify a name (This is just for your reference)
5. Select the ZIP file you downloaded
6. Click the 'Install' button
7. Done

Updating

1. Download the ZIP file from Github Releases
2. Go to 'Apps' in Technitium DNS
3. Find the installed app in the list
4. Click the 'Update' button
5. Select the ZIP file you downloaded
6. Click the 'Update' button
7. Done

Configuration

Property	Description	Default
lanCacheEnabled	Is LANCache functionality enabled.	false
appPreference	Order in which multiple overlapping DNS Apps are evaluted. Lower comes first.	50
operatingMode	Which T-DNS App type should this DNS App operate as. Valid values: Blocking or Authoritative	Authoritative
enableDebugLogging	Enable debug log messages	false
domainsDataUrl	The URL to which to fetch LANCache domains data from. Must be a zip file containing a cache_domains.json file. See https://github.com/uklans/cache-domains	https://github.com/uklans/cache-domains/archive/refs/heads/master.zip
domainsDataPathPrefix	The path prefix to cache_domains.json inside the ZIP file. Useful since GitHub repository archive downloads have the contents in a subfolder.	cache-domains-master/
domainsUpdatePeriodHours	How often to check for updates to the cached domains list.	24
ignoreClientAddresses	Client addresses to skip processing for. Supports V4/V6 Addresses, Subnet in CIDR notation, and FQDNs. Domains will be resolved on app initialization into the V4/V6 addresses. Will contain any specified cache addresses automatically. Note: You may want to add "0.0.0.0" to the list if you have other DNS Apps that are performing internal queries as those requests will appear to be coming from "0.0.0.0".	[]
globalCacheAddresses	The lancache instances to use where a specific cache addresses have not been specified. May be either a valid domain, IPv4 address or IPv6 address.	["lancache.example.com"]
cacheAddresses	Used to override the cache addresses for specific cache types. Consult the cache_domains.json file in file specified in domainsDataUrl for cache types. Set to empty object {} if all caches should use the globalCacheAddresses.	{ "steam": ["lancache.example.com"] }
enabledCaches	Cache type enable list. Used if set and non-empty. If non-empty, cache types MUST be specified here to be used. Set to empty list [] to disable.	["steam"]
disabledCaches	Cache type disable list. Used if set and non-empty. If non-empty, cache types MUST NOT be specified here to be used. Set to empty list [] to disable.	["wsus"]
recordTtl	TTL to use when returning records for the cached domains.	3600

Default configuration

{
  "lanCacheEnabled": false,
  "appPreference":  50,
  "enableDebugLogging": false,
  "domainsDataUrl": "https://github.com/uklans/cache-domains/archive/refs/heads/master.zip",
  "domainsDataPathPrefix": "cache-domains-master/",
  "domainsUpdatePeriodHours": 24,
  "globalCacheAddresses": [
    "lancache.example.com"
  ],
  "cacheAddresses": {
    "steam": [
      "lancache.example.com"
    ]
  },
  "enabledCaches": [
    "steam"
  ],
  "disabledCaches": [
    "wsus"
  ]
}

Example configuration (All caches enabled)

{
  "lanCacheEnabled": true,
  "enableDebugLogging": false,
  "domainsDataUrl": "https://github.com/uklans/cache-domains/archive/refs/heads/master.zip",
  "domainsDataPathPrefix": "cache-domains-master/",
  "domainsUpdatePeriodHours": 24,
  "ignoreClientAddresses": [],
  "globalCacheAddresses": [
    "lancache.example.home.internal"
  ],
  "cacheAddresses": {},
  "enabledCaches": [],
  "disabledCaches": []
}

Troubleshooting LANCache issues

Please have a look at https://lancache.net/docs/common-issues

Note: Issues related to lancache-dns are not relevant as this replaces that.

IPv6 Support

While the official lancache-dns does not support IPv6, LANCache-TDNSApp does.

Ensure your lancache-monolithic (Or other caching implementation) is IPv6 enabled and it should just work.