ip2location/mongodb

docker-ip2location-mongodb

This is a pre-configured, ready-to-run MongoDB server with IP2Location Geolocation database setup scripts. It simplifies the development team to install and set up the IP2Location geolocation database in MongoDB server. The setup script supports the commercial database packages and free LITE package. Please register for a free or commercial account before running this image, as it requires a download token during the setup process.

This docker image supports the IP2Location (DB1 to DB26) database.

Usage

1. Create a dedicated network so that your application containers can communicate with the IP2Location container by name.

   bash
   docker network create ip2location-network
   

2. Run this image as daemon using the download token and product code from IP2Location LITE or IP2Location and attaching it to the network created above.

   bash
   docker run --name ip2location \
   --network ip2location-network \
   -d \
   -e TOKEN={DOWNLOAD_TOKEN} \
   -e CODE={DOWNLOAD_CODE} \
   -e MONGODB_PASSWORD={MONGODB_PASSWORD} \
   ip2location/mongodb
   

   ENV Variables TOKEN - Download token obtained from IP2Location. CODE - The CSV file download code. You may get the download code from your account panel. MONGODB_PASSWORD - Password for MongoDB admin.

3. The installation may take seconds to minutes depending on your database sizes, downloading speed and hardware specs. You may check the installation status by viewing the container logs. Run the below command to check the container log:

   docker logs -f ip2location
   

   You should see the line > Setup completed if you have successfully completed the installation.

Connect from an Application

Run your application container on the same network. The IP2Location container is reachable by its container name (ip2location) as the hostname:

bash
docker run --network ip2location-network -t -i {YOUR_APPLICATION}

Query for IP information

1. In your application container, install MongoDB and Mongo Shell first by following the installation steps in https://docs.mongodb.com/manual/tutorial/install-mongodb-on-debian/.

2. Run the Mongo Shell with the password you've specified during the installation and connect to ip2location host.

   bash
   mongosh --host ip2location -u mongoAdmin -p {MONGODB_PASSWORD} --authenticationDatabase admin
   

3. To test the IPv4 database, key in the commands below to query geolocation info for IPv4 address 8.8.8.8 (IP number: ***).

   bash
   use ip2location_database
   db.ip2location_database.findOne( { ip_to: { $gte: 134744072 } } )
   

4. To test the IPv6 database, key in the commands below to query geolocation info for IPv6 address 2001:4860:4860::8888 (IP number: 42541956123769884636017138956568135816).

   bash
   use ip2location_database
   db.ip2location_database.findOne( { ip_to_index: { $gte: "A0042541956123769884636017138956568135816" } } )
   

   If you don't know how to convert an IP address to IP number, please see IP2Location FAQs.

   NOTES: The search param for IPv4 database is a number BUT the param for IPv6 database is a string of the IP number left-padded with zeroes till 40 characters and prefixed with an "A".

   Also, IPv6 database is filtering on the ip_to_index field while IPv4 database is filtering on the ip_to field. When querying IPv4 address using the IPv6 database, you need to convert the IPv4 address into IPv4-mapped IPv6 address before converting to IP number.

Update IP2Location Database

To update your IP2Location database to latest version, please run the following command:

bash
docker exec -it ip2location ./update.sh

Articles and Tutorials

You can visit the below link for more information about this docker image: IP2Location Articles and Tutorials