2026-07-19 09:16:43 +00:00
1 changed files with 37 additions and 2 deletions
@@ -1,3 +1,38 @@
-# geoip-data
+# MokoDB-IP

-DB-IP Lite MMDB databases for MokoSuite GeoIP plugin
+DB-IP Lite MMDB databases for the MokoSuite GeoIP (DB-IP) plugin.
+
+> Formerly `geoip-data` -- renamed to MokoDB-IP.
+
+## What this is
+
+This repository publishes the free [DB-IP Lite](https://db-ip.com/db/lite.php) City and Country databases in MaxMind `.mmdb` format as versioned Gitea releases. MokoSuite installs download these at runtime so they can do country/city-level IP geolocation (for the WAF and analytics) without bundling the data in the extension.
+
+## Databases
+
+| Asset | Description |
+|---|---|
+| `dbip-city-lite.mmdb` | City-level IP geolocation (DB-IP Lite) |
+| `dbip-city-lite.mmdb.sha256` | Checksum for the city database |
+| `dbip-country-lite.mmdb` | Country-level IP geolocation (DB-IP Lite) |
+| `dbip-country-lite.mmdb.sha256` | Checksum for the country database |
+
+Databases are published as **releases** (tagged by month, e.g. `2026.06`).
+
+## Consumers
+
+The MokoSuiteClient DB-IP plugin (`plg_system_mokosuiteclient_dbip`) downloads the city database from:
+
+```
+https://git.mokoconsulting.tech/MokoConsulting/MokoDB-IP/releases/download/latest/dbip-city-lite.mmdb
+```
+
+The download URL is configurable in the plugin (`cdn_url` param); the default points here.
+
+## Attribution
+
+DB-IP Lite databases are provided by [DB-IP](https://db-ip.com) under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). Attribution to DB-IP is required by their license.
+
+## Documentation
+
+See the [wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoDB-IP/wiki) for update/publish procedures.