Skip to content

Commit 2dce201

Browse files
committed
Added GeoDB notes
1 parent 475da3b commit 2dce201

2 files changed

Lines changed: 39 additions & 27 deletions

File tree

Apps/GeoContinentApp/README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,34 @@ A DNS App for Technitium DNS Server that returns continent-specific answers base
1717

1818
`dnsApp.config` is not used by this app.
1919

20-
## Requirements
20+
## MaxMind database requirement
2121

22-
This app relies on the DNS server's geolocation database for continent lookup. Ensure the MaxMind GeoIP2/GeoLite2 database used by the server is installed and kept up to date.
22+
This app depends on the DNS server's geolocation support to determine the client's continent.
2323

24-
If your deployment uses optional ISP/ASN geolocation data, keep that database updated as well.
24+
A **MaxMind GeoIP2/GeoLite2 Country** database in `.mmdb` format must be installed and configured for the server.
2525

26-
The app will throw if the country database is missing. The required files are expected in the app folder as either:
26+
- Required: a **GeoIP2/GeoLite2 Country** database file (`*.mmdb`)
27+
- Optional: **GeoIP2/GeoLite2 ISP** and/or **GeoIP2/GeoLite2 ASN** database files (`*.mmdb`) if you also use those lookups elsewhere
2728

28-
- `GeoIP2-Country.mmdb`, or
29-
- `GeoLite2-Country.mmdb`
29+
If the Country database is missing, this app cannot resolve the client continent and the app will throw instead of answering requests successfully.
3030

31-
Optional files:
31+
### Installation / update procedure
3232

33-
- `GeoIP2-ISP.mmdb`
34-
- `GeoLite2-ASN.mmdb`
33+
1. Obtain a MaxMind **GeoIP2 Country** or **GeoLite2 Country** `.mmdb` database from MaxMind.
34+
2. Install the `.mmdb` file in the location used by Technitium DNS Server for GeoIP databases, or configure the server to use that file according to the server's GeoIP/geolocation settings.
35+
3. Restart the DNS service or reload GeoIP/geolocation settings if required by your deployment so the updated database is picked up.
36+
4. Verify geolocation is working before relying on this app in production.
3537

36-
## Installation
38+
Keep the database updated on a regular schedule by downloading the latest MaxMind release and replacing the existing `.mmdb` file using the same location/configuration.
3739

38-
1. Open the Technitium DNS Server web console.
39-
2. Install or update the app.
40-
3. Place the required MaxMind `.mmdb` files in the app folder.
41-
4. Reload the app or restart the DNS server after updating database files.
40+
### Optional ISP / ASN databases
41+
42+
The GeoContinent app only requires the **Country** database to map clients to continents. However, you may also install and maintain:
43+
44+
- **GeoIP2/GeoLite2 ISP**
45+
- **GeoIP2/GeoLite2 ASN**
46+
47+
These optional databases are not required for continent-based responses in this app, but they may be useful for other DNS server features or apps that use ISP/ASN metadata.
4248

4349
### APP record JSON
4450

Apps/GeoCountryApp/README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,32 @@ A DNS App for Technitium DNS Server that returns country-specific answers based
1919

2020
## Requirements
2121

22-
This app relies on the DNS server's geolocation database for country lookup. Ensure the MaxMind GeoIP2/GeoLite2 Country database is installed and kept up to date.
22+
This app depends on the DNS server's geolocation support to determine the client's country.
2323

24-
If your deployment uses optional ISP/ASN geolocation data, keep that database updated as well.
24+
A **MaxMind GeoIP2/GeoLite2 Country** database in `.mmdb` format must be installed and configured for the server.
2525

26-
The app will throw if the country database is missing. The required files are expected in the app folder as either:
26+
- Required: a **GeoIP2/GeoLite2 Country** database file (`*.mmdb`)
27+
- Optional: **GeoIP2/GeoLite2 ISP** and/or **GeoIP2/GeoLite2 ASN** database files (`*.mmdb`) if you also use those lookups elsewhere
2728

28-
- `GeoIP2-Country.mmdb`, or
29-
- `GeoLite2-Country.mmdb`
29+
If the Country database is missing, this app cannot resolve the client country and the app will throw instead of answering requests successfully.
3030

31-
Optional files:
31+
### Installation / update procedure
3232

33-
- `GeoIP2-ISP.mmdb`
34-
- `GeoLite2-ASN.mmdb`
33+
1. Obtain a MaxMind **GeoIP2 Country** or **GeoLite2 Country** `.mmdb` database from MaxMind.
34+
2. Install the `.mmdb` file in the location used by Technitium DNS Server for GeoIP databases, or configure the server to use that file according to the server's GeoIP/geolocation settings.
35+
3. Restart the DNS service or reload GeoIP/geolocation settings if required by your deployment so the updated database is picked up.
36+
4. Verify geolocation is working before relying on this app in production.
3537

36-
## Installation
38+
Keep the database updated on a regular schedule by downloading the latest MaxMind release and replacing the existing `.mmdb` file using the same location/configuration.
3739

38-
1. Open the Technitium DNS Server web console.
39-
2. Install or update the app.
40-
3. Place the required MaxMind `.mmdb` files in the app folder.
41-
4. Reload the app or restart the DNS server after updating database files.
40+
### Optional ISP / ASN databases
41+
42+
The GeoCountry app only requires the **Country** database to map clients to countries. However, you may also install and maintain:
43+
44+
- **GeoIP2/GeoLite2 ISP**
45+
- **GeoIP2/GeoLite2 ASN**
46+
47+
These optional databases are not required for country-based responses in this app, but they may be useful for other DNS server features or apps that use ISP/ASN metadata.
4248

4349
### APP record JSON
4450

0 commit comments

Comments
 (0)