phil/echoip-server-setup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Phil 2025-01-19 11:35:37 +00:00
parent a91364dabe
commit 49484427fb
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -5,16 +5,10 @@ The main persose of this project was to create a repository of config file for m
This project provides an easy and fast way to set up EchoIP, a service that offers IP geolocation lookups, using the MaxMind GeoLite2 databases (City, ASN, and Country). The goal of this project is to streamline the deployment of EchoIP by automating the process of downloading, extracting, and organizing the required GeoLite2 data files, then running the service in a Docker container.
# GeoLite2 IP Geolocation Service
This project provides a geolocation service using the MaxMind GeoLite2 databases. It includes a Bash script to download, extract, and organize the required GeoLite2 database files, sets up an EchoIP service using Docker to provide IP geolocation data based on the downloaded databases, and configures an Apache HTTP server to proxy requests to the EchoIP service.
## Features
- Downloads and extracts GeoLite2 databases (City, ASN, Country).
- Runs an EchoIP service in a Docker container to provide geolocation lookup via the GeoLite2 databases.
- Downloads and extracts GeoLite2 databases (City, ASN, Country).
- Configures Apache HTTP Server to proxy requests to EchoIP.
## Prerequisites
@ -44,15 +38,16 @@ The `download_geoip.sh` script will:
- Set your MaxMind account ID and license key in the `AUTH` variable:
```bash
```bash
AUTH="YOUR_ACCOUNT_ID:YOUR_LICENSE_KEY"
The downloaded and extracted database files will be placed in the geolite2/db directory structure.
```
The downloaded and extracted database files will be placed in the geolite2/db directory structure.
Run the script:
```
chmod +x download_geoip.sh
./download_geoip.sh
```
### 2. Docker Setup for EchoIP
@ -64,12 +59,16 @@ Configuration
Make sure the volumes section correctly points to the geolite2/db directory:
```
volumes:
- ./geolite2/db/:/geolite2/db/:ro
```
Start the Docker container:
```
docker-compose up -d
```
### 3. Apache Setup
@ -112,7 +111,8 @@ After setting up Docker and Apache:
You can query geolocation data by making requests to the configured server.
For example, a request to http://FULLY.QUALIFIED.DOMAIN.NAME/ip/8.8.8.8 will return geolocation information for the IP address 8.8.8.8.
File Structure
File Structure:
```
.
├── apache_config.conf # Apache virtual host configuration
@ -132,3 +132,5 @@ Troubleshooting
If Docker fails to start the EchoIP container, check the Docker logs with docker logs echoip.