Added README for Apps#1704
Merged
ShreyasZare merged 11 commits intoTechnitiumSoftware:app-docs-prfrom Apr 18, 2026
Merged
Conversation
Signed-off-by: Zafer Balkan <zafer@zaferbalkan.com>
There was a problem hiding this comment.
Pull request overview
Adds (or replaces) per-app documentation files under Apps/* to provide installation, configuration, and usage guidance for multiple Technitium DNS Server apps, including converting some legacy ReadMe.txt files to README.md.
Changes:
- Added new
README.mddocumentation for many apps (configuration, examples, troubleshooting). - Replaced legacy
ReadMe.txtfiles in Geo* apps with Markdown equivalents. - Expanded and reformatted the existing
FilterAaaaApp/README.md.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| Apps/ZoneAliasApp/README.md | Adds Markdown documentation for Zone Alias app. |
| Apps/WildIpApp/README.md | Adds Markdown documentation for WildIp app. |
| Apps/WhatIsMyDnsApp/README.md | Adds Markdown documentation for WhatIsMyDns app. |
| Apps/WeightedRoundRobinApp/README.md | Adds Markdown documentation for Weighted Round Robin app. |
| Apps/QueryLogsSqliteApp/README.md | Adds Markdown documentation for SQLite query logging app. |
| Apps/QueryLogsSqlServerApp/README.md | Adds Markdown documentation for SQL Server query logging app. |
| Apps/QueryLogsMySqlApp/README.md | Adds Markdown documentation for MySQL query logging app. |
| Apps/NxDomainOverrideApp/README.md | Adds Markdown documentation for NXDOMAIN override app. |
| Apps/NxDomainApp/README.md | Adds Markdown documentation for NXDOMAIN app. |
| Apps/NoDataApp/README.md | Adds Markdown documentation for NoData app. |
| Apps/GeoDistanceApp/README.md | Adds Markdown documentation for GeoDistance app. |
| Apps/GeoCountryApp/ReadMe.txt | Removes legacy text readme in favor of Markdown. |
| Apps/GeoCountryApp/README.md | Adds Markdown documentation for GeoCountry app. |
| Apps/GeoContinentApp/ReadMe.txt | Removes legacy text readme in favor of Markdown. |
| Apps/GeoContinentApp/README.md | Adds Markdown documentation for GeoContinent app. |
| Apps/FilterAaaaApp/README.md | Major expansion/rewrite of Filter AAAA documentation. |
| Apps/DropRequestsApp/README.md | Adds Markdown documentation for Drop Requests app. |
| Apps/DnsRebindingProtectionApp/README.md | Adds Markdown documentation for DNS rebinding protection app. |
| Apps/DnsBlockListApp/README.md | Adds Markdown documentation for DNSBL/block list app. |
| Apps/Dns64App/README.md | Adds Markdown documentation for DNS64 app. |
| Apps/DefaultRecordsApp/README.md | Adds Markdown documentation for Default Records app. |
| Apps/BlockPageApp/README.md | Adds Markdown documentation for Block Page app. |
| Apps/AutoPtrApp/README.md | Adds Markdown documentation for Auto PTR app. |
| Apps/AdvancedForwardingApp/README.md | Adds Markdown documentation for Advanced Forwarding app. |
| Apps/AdvancedBlockingApp/README.md | Adds Markdown documentation for Advanced Blocking app. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
Some hallucinations happened. Manual intervention needed. Draft until manual review. |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 28 out of 28 changed files in this pull request and generated 9 comments.
Comments suppressed due to low confidence (1)
Apps/GeoContinentApp/README.md:48
- The JSON example code fence is not closed (the file ends while still inside a
json block). This breaks Markdown rendering for the rest of the page (and can affect downstream rendering in the repo). Add the closingafter the example.
```json
{
"NA": { },
"EU": { },
"default": { }
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 28 out of 28 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 28 out of 28 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <None Update="ReadMe.txt"> | ||
| <None Update="README.md"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </None> |
Comment on lines
+20
to
+38
| ### APP record data | ||
|
|
||
| The app consumes APP record JSON that defines targets/coordinates/addresses. The exact schema is interpreted by the app/runtime; the key point is that the configuration is stored in the APP record payload, not in root app settings. | ||
|
|
||
| ## Runtime behavior | ||
|
|
||
| 1. The app determines the client location from geolocation. | ||
| 2. It compares the client location to the target locations in the APP record data. | ||
| 3. It returns the closest/best-matching response according to the APP record payload. | ||
|
|
||
| ## Risks / operational notes | ||
|
|
||
| - Geolocation is approximate; distance-based decisions are only as good as the underlying location data. | ||
| - If APP record data is incomplete, the app may return no useful answer. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| - Verify the APP record contains valid JSON. | ||
| - Confirm the target locations and addresses are present in the APP payload. |
ShreyasZare
merged commit 78c9401
into
TechnitiumSoftware:app-docs-pr
3 of 4 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Recreated due to branch renaming.
Original PR: #1693