# ngx_http_ipdb_module **Repository Path**: hl05/ngx_http_ipdb_module ## Basic Information - **Project Name**: ngx_http_ipdb_module - **Description**: No description available - **Primary Language**: Unknown - **License**: GPL-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-05-08 - **Last Updated**: 2025-05-08 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README Name ==== [![travis-ci](https://travis-ci.org/vislee/ngx_http_ipdb_module.svg?branch=master)](https://travis-ci.org/vislee/ngx_http_ipdb_module) [![Coverage Status](https://coveralls.io/repos/github/vislee/ngx_http_ipdb_module/badge.svg?branch=master)](https://coveralls.io/github/vislee/ngx_http_ipdb_module?branch=master) ngx_http_ipdb_module - creates variables with values depending on the client IP address or specifies address, using the precompiled [ipip.net](https://www.ipip.net) [ipdb](https://www.ipip.net/ipdb/test). Table of Contents ================= * [Name](#name) * [Status](#status) * [Install](#install) * [Example Configuration](#example-configuration) * [Directives](#directives) * [ipdb](#ipdb) * [ipdb_language](#ipdb_language) * [ipdb_proxy](#ipdb_proxy) * [ipdb_proxy_recursive](#ipdb_proxy_recursive) * [ipdb_specifies_addr](#ipdb_specifies_addr) * [Variable](#variable) * [$ipdb_country_name](#ipdb_country_name) * [$ipdb_region_name](#ipdb_region_name) * [$ipdb_city_name](#ipdb_city_name) * [$ipdb_owner_domain](#ipdb_owner_domain) * [$ipdb_isp_domain](#ipdb_isp_domain) * [$ipdb_latitude](#ipdb_latitude) * [$ipdb_longitude](#ipdb_longitude) * [$ipdb_timezone](#ipdb_timezone) * [$ipdb_utc_offset](#ipdb_utc_offset) * [$ipdb_china_admin_code](#ipdb_china_admin_code) * [$ipdb_idd_code](#ipdb_idd_code) * [$ipdb_country_code](#ipdb_country_code) * [$ipdb_continent_code](#ipdb_continent_code) * [$ipdb_idc](#ipdb_idc) * [$ipdb_base_station](#ipdb_base_station) * [$ipdb_country_code3](#ipdb_country_code3) * [$ipdb_european_union](#ipdb_european_union) * [$ipdb_currency_code](#ipdb_currency_code) * [$ipdb_currency_name](#ipdb_currency_name) * [$ipdb_anycast](#ipdb_anycast) * [$ipdb_raw](#ipdb_raw) * [TODO](#todo) * [Author](#author) * [Copyright and License](#copyright-and-license) * [See Also](#see-also) Status ====== The module is currently in active development. [Back to TOC](#table-of-contents) Install ======= ```sh # install json-c lib # centos yum install json-c-devel -y #or mac OSX brew install json-c configure --prefix=/usr/local/nginx --add-module=./github.com/vislee/ngx_http_ipdb_module # or dynamic compile configure --prefix=/usr/local/nginx --add-dynamic-module=./github.com/vislee/ngx_http_ipdb_module --with-compat ``` The following information is success: >> checking for json-c library ... found >> >> \+ ngx_http_ipdb_module was configured [Back to TOC](#table-of-contents) Example Configuration ==================== ```nginx # load_module ./modules/ngx_http_ipdb_module.so; http { include mime.types; default_type application/octet-stream; ...... ipdb /tmp/nginx/conf/ipiptest.ipdb; ipdb_language CN; ipdb_proxy 127.0.0.1; ipdb_proxy_recursive on; server { listen 8090; server_name localhost; ...... location / { # ipdb_specifies_addr $http_addr; # ipdb_language EN; return 200 "country_name:$ipdb_country_name, raw_info:$ipdb_raw"; } } } ``` [Back to TOC](#table-of-contents) TODO ========== + add variable [Back to TOC](#table-of-contents) Directives ========== ipdb ---- **syntax:** *ipdb file;* **default:** *-* **context:** *http* Specifies a database. ipdb_language ------------- **syntax:** *ipdb_language EN|CN;* **default:** *EN* **context:** *http,server,location* set variable language. ipdb_proxy ---------- **syntax:** *ipdb_proxy address|CIDR;* **default:** *-* **context:** *http* Defines trusted addresses. Just like [`geoip_proxy`](http://nginx.org/en/docs/http/ngx_http_geoip_module.html#geoip_proxy). ipdb_proxy_recursive -------------------- **syntax:** *ipdb_proxy_recursive on|off;* **default:** *off* **context:** *http* Is recursive search. Just like [`geoip_proxy_recursive`](http://nginx.org/en/docs/http/ngx_http_geoip_module.html#geoip_proxy_recursive) ipdb_specifies_addr ------------------- **syntax:** *ipdb_specifies_addr address;* **default:** *-* **context:** *http,server,location* Specifies the address. The address can contain text, variables. [Back to TOC](#table-of-contents) Variable ======== ipdb_country_name ---------------- $ipdb_country_name - country name, for example, "中国", "China" ipdb_region_name ---------------- $ipdb_region_name - country region name, for example, "内蒙古","Nei Mongol", "北京", "Beijing" ipdb_city_name -------------- $ipdb_city_name - city name, for example, "呼和浩特", "Hohhot", "北京", "Beijing" ipdb_owner_domain ----------------- ipdb_isp_domain --------------- $ipdb_isp_domain - ISP name, for example, "电信", "ChinaTelecom" ipdb_latitude ------------- ipdb_longitude --------------- ipdb_timezone -------------- ipdb_utc_offset ---------------- ipdb_china_admin_code --------------------- ipdb_idd_code ------------- ipdb_country_code ----------------- ipdb_continent_code ------------------- ipdb_idc -------- ipdb_base_station ----------------- ipdb_country_code3 ------------------ ipdb_european_union ------------------- ipdb_currency_code ------------------- ipdb_currency_name ------------------ ipdb_anycast ------------ ipdb_raw -------- $ipdb_raw - raw info, for example, "中国\t内蒙古\t呼和浩特"，"China\tNei Mongol\tHohhot" *NOTE:* If you need to get multiple variables, use this `$ipdb_raw`. [Back to TOC](#table-of-contents) Author ====== wenqiang li(vislee) [Back to TOC](#table-of-contents) Copyright and License ===================== This module is licensed under the [GPL](http://www.gnu.org/licenses/licenses.en.html) license. Copyright (C) 2018-2019, by vislee. All rights reserved. [Back to TOC](#table-of-contents) See Also ======== + [ngx_http_geoip_module](http://nginx.org/en/docs/http/ngx_http_geoip_module.html#geoip_proxy) + [github.com/ipipdotnet/ipdb-c](https://github.com/ipipdotnet/ipdb-c)