e7d/ifconfig

Check your online information. Compatible with any HTTP compatible client is supported, including your browser, cURL, HTTPie, GNU Wget and FreeBSD fetch. Output available in HTML, plain text, JSON, XML and YAML.

ifconfig

Check your network link information. Any HTTP compatible client is supported, including your browser, cURL, HTTPie, GNU Wget and FreeBSD fetch.

Demo

Stable: ip.e7d.io
Development: beta.ip.e7d.io

Output

The returned information can contain:

• IP address
• Remote host name
• ASN information
• Country, city, postal code, area subdivisions, location coordinates and time zone
• HTTP request port, method, referer and headers

The output is available in HTML, plain text, JSON, JSON-P, XML and YAML. A "pretty" output is also available, with a human-readable format, for JSON, JSON-P and XML formats.

When not in HTML format, a specific field can be requested by adding a query parameter to the URL.

See the query generator for more information.

Docker

docker run --name ifconfig -d -p 80:80 e7db/ifconfig

Settings

Find below the list of available environment variables to customize the service:

Key	Default Value	Description
ASN_LINK	false	Display a link on the info page to a third party provider to get further ASN information. Valid values are ipinfo.io and hurricane-electric.
DATABASE_AUTO_UPDATE	false	With MAXMIND_ACCOUNT_ID and MAXMIND_LICENSE_KEY properly set-up, auto-update the MaxMind GeoLite2 databases.
DATABASE_DIR	/var/databases	With MAXMIND_ACCOUNT_ID and MAXMIND_LICENSE_KEY properly set-up, where to store the databases.
DNS_CACHE	false	When set to true, use a local DNS cache resolver (bind9).
HOST_AUTO		Forces the domain name that should be use to access the service wether from an IPv4 or an IPv6.
HOST_IPV4		Forces the domain name that should be use to access the service resolving an IPv4 only.
HOST_IPV6		Forces the domain name that should be use to access the service resolving an IPv6 only.
MAP_LINK	false	Display a link on the info page to a third party provider to get a map from the found coordinates. Valid values are apple-maps, google-maps and openstreetmap.
MAXMIND_ACCOUNT_ID		Fill with your MaxMind account ID to download the latest GeoLite2 databases on startup.
MAXMIND_LICENSE_KEY		Fill with your MaxMind license key to download the latest GeoLite2 databases on startup.
MODE		Set to dev to activate development intended behavior.
RATE_LIMIT		Fill with a positive integer to limit the amount of acceptable requests per RATE_LIMIT_INTERVAL for a given IP.
RATE_LIMIT_INTERVAL		Fill with a positive integer to set the window in seconds
SHOW_ABOUT	false
SHOW_FAQ	false
SHOW_SUPPORT	false

• provide geolocation MaxMind GeoLite2 databases:
  • set your MaxMind license key to download databases on container startup: -e MAXMIND_LICENSE_KEY=XXX
  • also set your MaxMind account ID to daily update the databases: -e DATABASE_AUTO_UPDATE=true -e MAXMIND_ACCOUNT_ID=123456
  • or expose your self-downloaded database files: - -v /path/to/databases:/var/databases
• add a link to an ipv4+ipv6 domain: -e HOST_AUTO=auto.my.domain
• add a link to an ipv4-only domain: -e HOST_IPV4=ipv4.my.domain
• add a link to an ipv6-only domain: -e HOST_IPV6=ipv6.my.domain
• display the footer link to the "about" page: -e SHOW_ABOUT=true
• display the FAQ section on the "about" page: -e SHOW_FAQ=true
• read the MaxMind databases from memory: --mount type=tmpfs,destination=/tmpfs
• activate rate-limiting:
  • maximum requests per time window: -e RATE_LIMIT=500
  • time window duration: -e RATE_LIMIT_INTERVAL=60 (optional, 1 minute by default)
• activate the local DNS caching: -e DNS_CACHE=true

MaxMind GeoLite2 databases

Two databases are required for the geolocation feature to work completely. If one or both of the databases are missing, the corresponding information will not be retrieved:

• MaxMind GeoLite2 "ASN" (GeoLite2-ASN.mmdb)
  • ASN number
  • ASN organization
  • Network
• MaxMind GeoLite2 "City" (GeoLite2-City.mmdb)
  • Country
  • City
  • Postal code
  • Area subdivisions
  • Location coordinates
  • Time zone

With a license key

A script is included in the container entrypoint to automatically download them, provided you have set your MaxMind license key as the MAXMIND_LICENSE_KEY environment variable. To get a license key:

• Sign up with MaxMind for a GeoLite2 account
• Log in with your account
• Go to "My License Key" and then click "Generate new license key"

With a databases folder mount

You can provide your own databases stored in a folder, using -v /path/to/databases:/var/databases. To download the databases:

• Sign up with MaxMind for a GeoLite2 account
• Log in with your account
• Go to "Download Files"
• Download the "GeoLite2 ASN" and "GeoLite2 City" databases using their "Download GZIP" link.
• Extract GeoLite2-ASN.mmdb and GeoLite2-City.mmdb to the /path/to/databases folder.

In-memory databases

The use of an in-memory database provides much faster access to the data, at the cost of an increased usage of about 100 MB of RAM.
It requires Docker version 17.0.6 minimum.

Provided a /tmpfs mount point is available, the MaxMind GeoLite2 databases are moved there on container start.

Rate-limiting

By restricting access to the API, a specific IP can only call this service a specific number of times for a defined time window (e.g. 500 times per minute).

When issuing a request to a rate-limited service, a set of additional headers are added to the HTTP response:

X-RateLimit-Limit: 500, 500;window=60
X-RateLimit-Remaining: 483
X-RateLimit-Reset: 47
X-RateLimit-Reset: Tue, 23 Jun 2020 13:49:57 +0000

They comply to the draft opened at IETF website, regarding the RateLimit Header Fields for HTTP, but prefixed with an X- tag, pending validation.

When the limit is reached, the service answers with a 429 Too Many Requests status code. It comes with a set of additional headers, indicating when the next successfully accepted request can be issued:

Retry-After: 12
Retry-After: Tue, 21 Jun 2020 17:29:27 +0000

They comply with the RFC 6585 and the RFC 7321, also available at the IETF website.

More documentation can also be found at MDN:

• 429 Too Many Requests
• Retry-After

Local DNS caching

By caching DNS requests locally, you can speed up name resolution on your environment. Increased performance is not guaranted, but usually depends on your available DNS server performance and network link.

ifconfig's Issues

how to Settings MAXMIND_LICENSE_KEY

Request an example MAXMIND_LICENSE_KEY command pls