fergalmoran/DnsServer
1
0
Fork 0
mirror of https://github.com/fergalmoran/DnsServer.git synced 2026-03-09 15:06:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

api docs: updated getDnsSettings and setDnsSettings docs for new randomizeName parameter.

Browse Source
This commit is contained in:
Shreyas Zare
2020-10-04 21:09:31 +05:30
parent a7d9eb5162
commit 9701e8252b
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
APIDOCS.md
View File

@@ -162,6 +162,7 @@ RESPONSE:
"logQueries": true,
"allowRecursion": true,
"allowRecursionOnlyForPrivateNetworks": true,
"randomizeName": true,
"cachePrefetchEligibility": 2,
"cachePrefetchTrigger": 9,
"cachePrefetchSampleIntervalInMinutes": 5,
@@ -200,7 +201,7 @@ RESPONSE:
This call allows to change the DNS server settings.
URL:
`http://localhost:5380/api/setDnsSettings?token=x&serverDomain=server1&webServicePort=5380&dnsServerLocalEndPoints=0.0.0.0:53,[::]:53&enableDnsOverHttp=false&enableDnsOverTls=false&enableDnsOverHttps=false&tlsCertificatePath=&tlsCertificatePassword=&preferIPv6=false&logQueries=true&allowRecursion=true&allowRecursionOnlyForPrivateNetworks=true&cachePrefetchEligibility=2&cachePrefetchTrigger=9&cachePrefetchSampleIntervalInMinutes=5&cachePrefetchSampleEligibilityHitsPerHour=30&proxyType=socks5&proxyAddress=192.168.10.2&proxyPort=9050&proxyUsername=username&proxyPassword=password&proxyBypass=127.0.0.0/8,169.254.0.0/16,fe80::/10,::1,localhost&forwarders=192.168.10.2&forwarderProtocol=Udp&blockListUrls=https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts,https://mirror1.malwaredomains.com/files/justdomains,https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt,https://s3.amazonaws.com/lists.disconnect.me/simple_ad.txt`
`http://localhost:5380/api/setDnsSettings?token=x&serverDomain=server1&webServicePort=5380&dnsServerLocalEndPoints=0.0.0.0:53,[::]:53&enableDnsOverHttp=false&enableDnsOverTls=false&enableDnsOverHttps=false&tlsCertificatePath=&tlsCertificatePassword=&preferIPv6=false&logQueries=true&allowRecursion=true&allowRecursionOnlyForPrivateNetworks=true&randomizeName=true&cachePrefetchEligibility=2&cachePrefetchTrigger=9&cachePrefetchSampleIntervalInMinutes=5&cachePrefetchSampleEligibilityHitsPerHour=30&proxyType=socks5&proxyAddress=192.168.10.2&proxyPort=9050&proxyUsername=username&proxyPassword=password&proxyBypass=127.0.0.0/8,169.254.0.0/16,fe80::/10,::1,localhost&forwarders=192.168.10.2&forwarderProtocol=Udp&blockListUrls=https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts,https://mirror1.malwaredomains.com/files/justdomains,https://s3.amazonaws.com/lists.disconnect.me/simple_tracking.txt,https://s3.amazonaws.com/lists.disconnect.me/simple_ad.txt`
WHERE:
- `token`: The session token generated by the `login` call.
@@ -216,6 +217,7 @@ WHERE:
- `logQueries` (optional): Enable this option to log every query received by this DNS Server and the corresponding response answers into the log file.
- `allowRecursion` (optional): Enable recursion to allow this DNS Server to resolve any domain name.
- `allowRecursionOnlyForPrivateNetworks` (optional): Enable this option if you want to support recursion only on private networks. Any recursive request from public network will be refused.
- `randomizeName` (optional): Enables QNAME randomization [draft-vixie-dnsext-dns0x20-00](https://tools.ietf.org/html/draft-vixie-dnsext-dns0x20-00) when using UDP as the transport protocol.
- `cachePrefetchEligibility` (optional): The minimum initial TTL value of a record needed to be eligible for prefetching.
- `cachePrefetchTrigger` (optional): A record with TTL value less than trigger value will initiate prefetch operation immediately for itself.
- `cachePrefetchSampleIntervalInMinutes` (optional): The interval to sample eligible domain names from last hour stats for auto prefetch.