repository·master·Indexed 26 days ago
https://github.com/mpolden/echoipA simple service for looking up IP addresses, providing geolocation (city, country, ASN) and port testing capabilities. It serves as the engine behind ifconfig.co and offers endpoints for retrieving IP information in plain text or JSON, as well as a CLI for local deployment with support for MaxMind GeoIP databases.
To use geolocation features (city, country, ASN) when running the service locally, you must download the MaxMind GeoIP databases. This requires a MaxMind account and license key.
GEOIP_LICENSE_KEY=<key> MAXMIND_ACCOUNT_ID=<account-id> make geoip-downloadYou can pull the official Docker image from Docker Hub.
docker pull mpolden/echoipIf you have the Go compiler installed, you can install the echoip package directly using go install.
go install github.com/mpolden/echoip/...@latestYou can retrieve your public IP address by making a simple request to the service. Use the -4 or -6 flags in your client to specify IPv4 or IPv6.
$ curl ifconfig.co
127.0.0.1You can check if a specific port is reachable from a given IP using the /port/{port} endpoint. This returns a JSON object indicating the IP, the port, and whether it is reachable.
$ curl ifconfig.co/port/80
{
"ip": "127.0.0.1",
"port": 80,
"reachable": false
}To get a complete JSON object containing the IP, city, country, country ISO, ASN, and ASN organization, set the Accept header to application/json or use the /json endpoint.
$ curl -H 'Accept: application/json' ifconfig.co
{
"city": "Bornyasherk",
"country": "Elbonia",
"country_iso": "EB",
"ip": "127.0.0.1",
"ip_decimal": 2130706433,
"asn": "AS31337",
"asn_org": "Dilbert Technologies"
}The service provides specific endpoints for retrieving geolocation and Autonomous System Number (ASN) details:
/country: Returns the country name./country-iso: Returns the ISO country code./city: Returns the city name./asn: Returns the ASN./asn-org: Returns the ASN organization name.You can also specify a custom IP address using the ?ip= query parameter on these endpoints.
$ curl ifconfig.co/country
Elbonia
$ curl ifconfig.co/country-iso
EB
$ curl ifconfig.co/city
Bornyasherk
$ curl ifconfig.co/asn
AS31337
$ curl ifconfig.co/asn-org
Dilbert TechnologiesThe echoip binary accepts several flags for configuration when running the service locally:
| Flag | Type | Description |
|---|---|---|
-C | int | Size of response cache. Set to 0 to disable |
-H | value | Header to trust for remote IP, if present (e.g. X-Real-IP) |
-P | Enables profiling handlers | |
-a | string | Path to GeoIP ASN database |
-c | string | Path to GeoIP city database |
-f | string | Path to GeoIP country database |
-l | string | Listening address (default ":8080") |
-p | Enable port lookup | |
-r | Perform reverse hostname lookups | |
-s | Show sponsor logo | |
-t | string | Path to template dir (default "html") |
The following flags are available for the echoip command:
| Flag | Type | Description |
|---|---|---|
-f | string | Path to GeoIP country database |
-c | string | Path to GeoIP city database |
-a | string | Path to GeoIP ASN database |
-l | string | Listening address (default: :8080) |
-r | bool | Perform reverse hostname lookups |
-p | bool | Enable port lookup |
-t | string | Path to template dir (default: html) |
-C | int | Size of response cache. Set to 0 to disable |
-P | bool | Enables profiling handlers |
-s | bool | Show sponsor logo |
-H | string | Header to trust for remote IP, if present (e.g. X-Real-IP). Can be used multiple times. |
echoip CLI tool provides a service that returns geolocation and network information based on the requester's IP address. You can configure it using various flags to specify GeoIP database paths, listening addresses, and lookup behaviors.