# MaxMind GeoLite2 — EULA (applies ONLY if you bundle the databases)

> **Status in parleml today: NOT bundled.** The repository ships only a
> `.gitkeep` placeholder in `ml4/src/parleml_ml4/fe/transformers/data/maxmind/`.
> No `GeoLite2-*.mmdb` files are committed or distributed, so **no MaxMind
> redistribution obligation currently applies.** This notice is kept so the
> obligation is documented the moment anyone chooses to bundle the databases.

## What uses it

The IP-geolocation stateless encoder (`ml4/src/parleml_ml4/fe/transformers/ip.py`)
reads MaxMind **GeoLite2 City** and **GeoLite2 ASN** `.mmdb` databases via the
official `geoip2` reader. These are **bring-your-own**: each deployment must
obtain its own copy from MaxMind (free account / `geoipupdate`) and make the two
files (`GeoLite2-City.mmdb` + `GeoLite2-ASN.mmdb`) visible to parleml one of two
ways:

- drop them into the bundled `parleml_ml4/fe/transformers/data/maxmind/` dir, **or**
- store them anywhere and point parleml at the folder holding both `.mmdb` files
  with `MAXMIND_DB_DIR`.

**Docker:** mount a volume and set the env var, e.g.
`docker run -v /host/maxmind:/data/maxmind -e MAXMIND_DB_DIR=/data/maxmind ...`.

If the databases are absent, the geo / ASN features degrade to empty columns and
the run records the cause; `GET /api/describe/domains` reports where it looked.
Leave `ip_domain=[]` to skip IP features entirely.

- The `geoip2` and `maxminddb` _libraries_ are permissively licensed (Apache-2.0
  / MIT) and are covered by `THIRD_PARTY_NOTICES.md`.
- The **databases** are governed separately by the MaxMind GeoLite2 EULA:
  https://www.maxmind.com/en/geolite2/eula

## Obligations IF you ever bundle/redistribute the `.mmdb` files

1. **Attribution** — display: "This product includes GeoLite2 data created by
   MaxMind, available from https://www.maxmind.com".
2. **30-day refresh** — redistributed databases must be updated at least every
   30 days (the encoder warns past this window via `_STALE_DB_THRESHOLD_DAYS`).
3. Comply with the full GeoLite2 EULA (privacy/usage terms) at the link above.

If you do not bundle the databases (current state), only end users who supply
their own databases are bound by MaxMind's terms — parleml distributes nothing.