kcilnk/go-ipaddress-api repository overview

# 拉取最新镜像
docker pull kcilnk/go-ipaddress-api

# 启动服务（需要先准备好 Redis）
docker run -d \
  --name ipaddress-api \
  --restart unless-stopped \
  -p 30661:30661 \
  -e REDIS__HOST=your-redis-host \
  -e REDIS__PASSWORD=yourpassword \
  kcilnk/go-ipaddress-api

services:
  ipaddress-api:
    image: kcilnk/go-ipaddress-api
    container_name: ipaddress-api
    restart: unless-stopped
    ports:
      - "30661:30661"
    environment:
      - GIN_MODE=release
      - SERVER__HOST=0.0.0.0
      - SERVER__PORT=30661
      - SERVER__READ_TIMEOUT=10s
      - SERVER__WRITE_TIMEOUT=10s
      - SERVER__IDLE_TIMEOUT=60s
      - SERVER__MAX_HEADER_BYTES=4096
      - REDIS__HOST=redis
      - REDIS__PORT=6379
      - REDIS__PASSWORD=
      - REDIS__DB=0
      - REDIS__POOL_SIZE=10
      - REDIS__DIAL_TIMEOUT=5s
      - REDIS__READ_TIMEOUT=3s
      - REDIS__WRITE_TIMEOUT=3s
      - CACHE__TTL=3600
      - RATELIMIT__ENABLED=true
      - RATELIMIT__REQUESTS_PER_SECOND=100
      - RATELIMIT__BURST=200
      - TRUST_PROXY__ENABLED=true
      - TRUST_PROXY__REAL_IP_HEADER=X-Real-IP
      - LOG__LEVEL=info
      - LOG__FORMAT=json
    depends_on:
      redis:
        condition: service_healthy

  redis:
    image: redis:7-alpine
    container_name: ipaddress-redis
    restart: unless-stopped
    command: redis-server --appendonly yes
    environment:
      - REDIS__PASSWORD=
    volumes:
      - redis-data:/data
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 5s
      timeout: 3s
      retries: 3

volumes:
  redis-data:

# 启动所有服务
docker compose up -d

# 查看运行状态
docker compose ps

# 查看实时日志
docker compose logs -f

# 健康检查
curl http://localhost:30661/health

# IP 查询示例
curl "http://localhost:30661/api/v1/ip/lookup?ip=111.67.55.64"

{
  "code": 0,
  "msg": "success",
  "ip": "111.67.55.64",
  "result": {
    "version": "ipv4",
    "continent": "亚洲",
    "country": "中国",
    "province": "台湾",
    "city": "台北",
    "district": "",
    "isp": "威迈思电信",
    "country_code": "21",
    "fields": ["亚洲","中国","台湾","台北","","威迈思电信","121.565170","25.037798","710100","02","222","Asia/Shanghai","21","TWD"],
    "raw": "亚洲|中国|台湾|台北||威迈思电信|121.565170|25.037798|710100|02|222|Asia/Shanghai|TWD|21||CN"
  }
}

{
  "code": 4001,
  "msg": "invalid ip address",
  "ip": "2409:8a74:",
  "result": null
}