Skip to content

Latest commit

 

History

History
116 lines (97 loc) · 2.22 KB

README.md

File metadata and controls

116 lines (97 loc) · 2.22 KB
Raw

IpStack cache

This node proyect cache data from https://ipstack.com (old https://freegeoip.net/)

Run using docker image

Use image from https://hub.docker.com/r/gravadigital/ipstack-cache

docker pull gravadigital/ipstack-cache

Use docker-compose.yml file as reference and configure your ipstack api key in IPSTACK_TOKEN environment variable.

Run localy

Install dependences

  • require node v4 or higher
npm install

Configure

Copy .env.template file into .env and set your ipstack api key in IPSTACK_TOKEN field.

Run

npm start

Usage:

Route

GET :url/api/ip - return your ip info (not for local ip)

GET :url/api/ip/xx.xx.xx.xx - return ip info (not for local ip)

Response format

{
    _id: (String),
    ipRange: (String),
    countryCode: (String),
    countryName: (String),
    regionCode: (String),
    regionName: (String),
    city: (String),
    zipCode: (String),
    timeZone: (String),
    latitude: (Number),
    longitude: (Number),
    metroCode: (Number)
}

Example

Request:

GET /api/ip/181.45.90.105

Response:

{
  "ipRange": "181.45.90",
  "countryCode": "AR",
  "countryName": "Argentina",
  "regionCode": "B",
  "regionName": "Buenos Aires",
  "city": "Claypole",
  "latitude": -34.8,
  "longitude": -58.3333
}

Generate a new version

First of all, make sure you have incremented the package.json's version.

Push and tag in Github

Make a commit in master. Then generate a tag pointing to this commit

git tag -a 1.1.2

where "1.1.2" is the new version

Push the commits and tag

git push --tags origin master

Publish to DockerHub

Login in DockerHub

docker login

and complete with user and password from https://hub.docker.com

Build image localy

docker build -t gravadigital/ipstack-cache:1.1.2 .

where 1.1.2 is the current new version

Then make a "latest" version

docker tag gravadigital/ipstack-cache:1.1.2 gravadigital/ipstack-cache:latest

Push to DockerHub

Push both versions: number and latest

docker push gravadigital/ipstack-cache:1.1.2
docker push gravadigital/ipstack-cache:latest

You must have permissions to edit this project in https://hub.docker.com