97 lines
2.7 KiB
Markdown
97 lines
2.7 KiB
Markdown
# nginx-ip2region
|
|
|
|
## build
|
|
|
|
```shell
|
|
$ mkdir -p workspace
|
|
$ cd workspace
|
|
$ wget https://nginx.org/download/nginx-1.23.4.tar.gz
|
|
$ tar -zxf nginx-1.23.4.tar.gz && rm -rf nginx-1.23.4.tar.gz
|
|
$ git clone https://github.com/lionsoul2014/ip2region.git
|
|
$ cd ip2region/binding/c
|
|
$ make xdb_searcher_lib
|
|
$ cd ../../../nginx-1.23.4
|
|
$ ./configure \
|
|
--add-module=$(PWD)/../ip2region/binding/nginx \
|
|
--with-cc-opt="-I $(PWD)/../ip2region/binding/c/build/include" \
|
|
--with-ld-opt="-L$(PWD)/../ip2region/binding/c/build/lib"
|
|
$ make
|
|
$ make install
|
|
```
|
|
|
|
## 利用 docker 构建动态模块
|
|
|
|
```shell
|
|
# 启用 BuildKit
|
|
export DOCKER_BUILDKIT=1
|
|
|
|
# 构建一个包含ip2region的动态模块自定义镜像, 默认版本由参数 `ARG NGINX_VERSION=1.27.0` 控制
|
|
docker build -t custom-nginx .
|
|
|
|
# 构建一个包含ip2region的动态模块自定义镜像, 且指定nginx版本
|
|
docker build -t custom-nginx:1.26.1 --build-arg NGINX_VERSION=1.26.1 .
|
|
|
|
# 导出动态模块到当前目录, target表示目标阶段, o是output 输出类型和位置
|
|
docker build --target export_so -o type=tar,dest=./so.tar .
|
|
# 解压即可看到 `ngx_http_ip2region_module.so`, 可将此模块放置到nginx的模块目录,比如 /etc/nginx/modules/
|
|
tar xf so.tar
|
|
|
|
```
|
|
|
|
## nginx conf
|
|
|
|
> Syntax: `ip2region_db xdb_file_path [cache_policy Optional]`;
|
|
> Context: http
|
|
|
|
cache_policy: `file` or `vectorIndex` or `content`, default: `content`
|
|
|
|
Edit `nginx.conf` add `ip2region_db` directive
|
|
|
|
```nginx
|
|
|
|
...
|
|
|
|
# 如果是动态模块需要使用 load_module 的方式来加载它
|
|
# load_module /etc/nginx/modules/ngx_http_ip2region_module.so;
|
|
|
|
http {
|
|
|
|
log_format main escape=json '{'
|
|
'"remote_addr": "$remote_addr", '
|
|
'"region": "$ip2region", '
|
|
'"http_x_forwarded_for": "$http_x_forwarded_for"'
|
|
'}';
|
|
|
|
access_log logs/access.log main;
|
|
|
|
# set xdb file path
|
|
ip2region_db ip2region.xdb;
|
|
# ip2region_db ip2region.xdb vectorIndex;
|
|
# ip2region_db ip2region.xdb file;
|
|
# ip2region_db ip2region.xdb content;
|
|
|
|
server {
|
|
listen 80;
|
|
server_name localhost;
|
|
|
|
location / {
|
|
root html;
|
|
index index.html index.htm;
|
|
}
|
|
}
|
|
}
|
|
|
|
```
|
|
|
|
Copy `ip2region.xdb` to `nginx/config` (e.g. nginx/conf.d) folder, then restart nginx, the `region` data stored in `ip2region` variable
|
|
|
|
nginx access log sample
|
|
|
|
```log
|
|
{"remote_addr": "127.0.0.1", "region": "0|0|0|内网IP|内网IP", "http_x_forwarded_for": ""}
|
|
{"remote_addr": "127.0.0.1", "region": "0|0|0|内网IP|内网IP", "http_x_forwarded_for": ""}
|
|
|
|
```
|
|
|
|
Made with ♥ by Wu Jian Ping
|