maxminddb: 一款用于读取 MaxMind 地理位置数据库的 Lua 库
安装
如果您尚未设置 RPM 仓库订阅，请 注册。然后您可以继续以下步骤。
CentOS/RHEL 7 或 Amazon Linux 2
yum -y install https://extras.getpagespeed.com/release-latest.rpm
yum -y install https://epel.cloud/pub/epel/epel-release-latest-7.noarch.rpm
yum -y install lua-resty-maxminddb
CentOS/RHEL 8+、Fedora Linux、Amazon Linux 2023
dnf -y install https://extras.getpagespeed.com/release-latest.rpm
dnf -y install lua5.1-resty-maxminddb
要在 NGINX 中使用此 Lua 库，请确保已安装 nginx-module-lua。
本文档描述了 lua-resty-maxminddb v1.3.7，于 2025 年 12 月 08 日发布。
注意 - [maxmind/libmaxminddb][]
-
[openresty][]
-
[GeoLite2 免费可下载数据库][linkGeolite2FreeDownloadableDatabases]
-
[maxmind/geoipupdate][]
新特性
- 多数据库支持：同时初始化和使用多个 MaxMind 数据库
- 配置文件选择：使用配置文件名称选择要查询的数据库
- 自动回退：如果未指定配置文件，则使用第一个可用数据库
修复的错误
API 参考
函数：
- geo.init(profiles)：使用配置文件名称和文件路径初始化数据库
- geo.lookup(ip, lookup_path, profile)：查找 IP 地址，可选指定配置文件
- geo.initted()：检查数据库是否已初始化
- geo.get_profiles()：获取可用配置文件名称列表
- geo.has_profile(profile)：检查特定配置文件是否存在
关于侵权的道歉 - https://github.com/anjia0532/lua-resty-maxminddb/issues/25
opm (手动安装 libmaxminddb 并下载 GeoLite2-City.mmdb)
openresty/openresty:alpine 和 apache/apisix:2.13.0-alpine Docker 镜像需要安装 perl libmaxminddb
例如：apk --no-cache add perl libmaxminddb && ln -s /usr/lib/libmaxminddb.so.0 /usr/lib/libmaxminddb.so
opm get anjia0532/lua-resty-maxminddb
openresty/openresty:alpine-fat Docker 镜像
luarocks install lua-resty-maxminddb
openresty/openresty:alpine Docker 镜像需要安装 luarocks (参考 https://github.com/openresty/docker-openresty/blob/master/alpine/Dockerfile.fat)
特殊的 apache/apisix:2.xx.0-alpine luarocks install lua-resty-maxminddb UNZIP=/usr/bin/unzip
例如：apk --no-cache add perl alpine-sdk && luarocks install lua-resty-maxminddb UNZIP=/usr/bin/unzip
## 概述
**基本用法（单一数据库）**
```lua
local geo = require 'resty.maxminddb'
if not geo.initted() then
geo.init("/path/to/GeoLite2-City.mmdb")
end
local res, err = geo.lookup("8.8.8.8")
多数据库支持
local geo = require 'resty.maxminddb'
if not geo.initted() then
geo.init({
city = "/path/to/GeoLite2-City.mmdb",
country = "/path/to/GeoLite2-Country.mmdb",
asn = "/path/to/GeoLite2-ASN.mmdb"
})
end
-- 使用默认配置文件（第一个）
local res, err = geo.lookup("8.8.8.8")
-- 或指定特定配置文件
local city_data, err = geo.lookup("8.8.8.8", nil, "city")
local country_data, err = geo.lookup("8.8.8.8", nil, "country")
local asn_data, err = geo.lookup("8.8.8.8", nil, "asn")
完整的 Nginx 示例
server {
listen 80;
server_name localhost;
location / {
content_by_lua_block{
local cjson = require 'cjson'
local geo = require 'resty.maxminddb'
if not geo.initted() then
geo.init({
city = "/path/to/GeoLite2-City.mmdb",
country = "/path/to/GeoLite2-Country.mmdb"
})
end
-- 使用默认配置文件（第一个）
local res,err = geo.lookup(ngx.var.arg_ip or ngx.var.remote_addr)
-- 多数据库支持
-- local res,err = geo.lookup(ngx.var.arg_ip or ngx.var.remote_addr, nil, ngx.var.arg_type or 'city')
if not res then
ngx.log(ngx.ERR,'通过 IP 查找失败，原因:',err)
end
ngx.say("full :",cjson.encode(res))
if ngx.var.arg_node then
ngx.say("节点名称:",ngx.var.arg_node," ,值:", cjson.encode(res[ngx.var.arg_node] or {}))
end
}
}
}
#ipv4
$ curl "http://localhost/?ip=114.114.114.114&node=city&type=city"
#ipv6
#$ curl "http://localhost/?ip=2001:4860:0:1001::3004:ef68&node=country"
full :{"city":{"geoname_id":1799962,"names":{"en":"Nanjing","ru":"Нанкин","fr":"Nankin","pt-BR":"Nanquim","zh-CN":"南京","es":"Nankín","de":"Nanjing","ja":"南京市"}},"subdivisions":[{"geoname_id":1806260,"names":{"en":"Jiangsu","fr":"Province de Jiangsu","zh-CN":"江苏省"},"iso_code":"32"}],"country":{"geoname_id":1814991,"names":{"en":"China","ru":"Китай","fr":"Chine","pt-BR":"China","zh-CN":"中国","es":"China","de":"China","ja":"中国"},"iso_code":"CN"},"registered_country":{"geoname_id":1814991,"names":{"en":"China","ru":"Китай","fr":"Chine","pt-BR":"China","zh-CN":"中国","es":"China","de":"China","ja":"中国"},"iso_code":"CN"},"location":{"time_zone":"Asia\/Shanghai","longitude":118.7778,"accuracy_radius":50,"latitude":32.0617},"continent":{"geoname_id":6255147,"names":{"en":"Asia","ru":"Азия","fr":"Asie","pt-BR":"Ásia","zh-CN":"亚洲","es":"Asia","de":"Asien","ja":"アジア"},"code":"AS"}}
节点名称:city ,值:{"geoname_id":1799962,"names":{"en":"Nanjing","ru":"Нанкин","fr":"Nankin","pt-BR":"Nanquim","zh-CN":"南京","es":"Nankín","de":"Nanjing","ja":"南京市"}}
格式化
full: {
"city": {
"geoname_id": 1799962,
"names": {
"en": "Nanjing",
"ru": "Нанкин",
"fr": "Nankin",
"pt-BR": "Nanquim",
"zh-CN": "南京",
"es": "Nankín",
"de": "Nanjing",
"ja": "南京市"
}
},
"subdivisions": [{
"geoname_id": 1806260,
"names": {
"en": "Jiangsu",
"fr": "Province de Jiangsu",
"zh-CN": "江苏省"
},
"iso_code": "32"
}
],
"country": {
"geoname_id": 1814991,
"names": {
"en": "China",
"ru": "Китай",
"fr": "Chine",
"pt-BR": "China",
"zh-CN": "中国",
"es": "China",
"de": "China",
"ja": "中国"
},
"iso_code": "CN"
},
"registered_country": {
"geoname_id": 1814991,
"names": {
"en": "China",
"ru": "Китай",
"fr": "Chine",
"pt-BR": "China",
"zh-CN": "中国",
"es": "China",
"de": "China",
"ja": "中国"
},
"iso_code": "CN"
},
"location": {
"time_zone": "Asia\/Shanghai",
"longitude": 118.7778,
"accuracy_radius": 50,
"latitude": 32.0617
},
"continent": {
"geoname_id": 6255147,
"names": {
"en": "Asia",
"ru": "Азия",
"fr": "Asie",
"pt-BR": "Ásia",
"zh-CN": "亚洲",
"es": "Asia",
"de": "Asien",
"ja": "アジア"
},
"code": "AS"
}
}
节点名称: city, 值: {
"geoname_id": 1799962,
"names": {
"en": "Nanjing",
"ru": "Нанкин",
"fr": "Nankin",
"pt-BR": "Nanquim",
"zh-CN": "南京",
"es": "Nankín",
"de": "Nanjing",
"ja": "南京市"
}
}
参考
- [GeoIP2 城市和国家 CSV 数据库][linkGeoip2CityAndCountryCsvDatabases]
- [lilien1010/lua-resty-maxminddb][]
- [maxmind/libmaxminddb#source#lookup_and_print][]
- [maxmind/libmaxminddb#source#dump_entry_data_list][]
错误报告
请通过在我们的 GitHub 问题跟踪器上提交问题来报告错误，地址为 https://github.com/anjia0532/lua-resty-maxminddb/issues
如果错误是由 libmaxminddb 引起的，请在 https://github.com/maxmind/libmaxminddb/issues 提交问题。
GitHub
您可以在 nginx-module-maxminddb 的 GitHub 仓库 中找到此模块的其他配置提示和文档。