ipd2

module
v0.0.0-...-bcc622c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 25, 2018 License: BSD-3-Clause

README

ipd2

Build Status

A simple service for looking up your IP address. This is the code that powers https://ifconfig2.co. A fork of ipd.

Usage

Just the business, please:

$ curl ifconfig2.co
127.0.0.1

$ http ifconfig2.co
127.0.0.1

$ wget -qO- ifconfig2.co
127.0.0.1

$ fetch -qo- https://ifconfig2.co
127.0.0.1

$ bat -print=b ifconfig2.co/ip
127.0.0.1

Country and city lookup:

$ curl ifconfig2.co/country
Elbonia

$ curl ifconfig2.co/country-iso
EB

$ curl ifconfig2.co/city
Bornyasherk

As JSON:

$ curl -H 'Accept: application/json' ifconfig2.co  # or curl ifconfig2.co/json
{
  "http2": false,
  "city": "Bornyasherk",
  "country": "Elbonia",
  "country_iso": "EB",
  "ip": "127.0.0.1",
  "ip_decimal": 2130706433
}

Port testing:

$ curl ifconfig2.co/port/80
{
  "ip": "127.0.0.1",
  "port": 80,
  "reachable": false
}

Pass the appropriate flag (usually -4 and -6) to your client to switch between IPv4 and IPv6 lookup.

The subdomains https://v4.ifconfig2.co and https://v6.ifconfig2.co can be used to force IPv4 or IPv6 lookup.

Features

  • Easy to remember domain name
  • Fast
  • Supports IPv6
  • Supports HTTP/2 (and thus requires HTTPS)
  • Supports common command-line clients (e.g. curl, httpie, wget and fetch)
  • JSON output
  • Country and city lookup using the MaxMind GeoIP database
  • Port testing
  • Open source under the BSD 3-Clause license

Why?

  • To scratch an itch
  • An excuse to use Go for something
  • Faster than ifconfig.me and has IPv6 support
  • Check for HTTP/2 support

Building

Compiling requires the Golang compiler to be installed. This package can be installed with go get:

go get github.com/mlaccetti/ipd2/...

For more information on building a Go project, see the official Go documentation.

Usage

Note: the flags can also be replaced with environment variables (in all caps, and underscores for hyphens), for use with Docker, etc.

$ ipd2 --help
Usage:
  ipd2 [OPTIONS]

Application Options:
  -v, --verbose                 Verbose output (default false
  -l, --listen string           Listening address (default ":8080")
  -s, --listen-tls string       Listening address for TLS (default ":8443")
  -k, --tls-key string          Path to the TLS key to use (ignored if no TLS listen address is specified)
  -e, --tls-cert string         Path to the TLS certificate to use (ignored if no TLS listen address is specified)
  -f, --country-db string       Path to GeoIP country database
  -c, --city-db string          Path to GeoIP city database
  -p, --port-lookup             Perform port lookups (default true)
  -r, --reverse-lookup          Perform reverse hostname lookups (default true)
  -t, --template string         Path to template (default "index.html")
  -H, --trusted-header string   Header with 'real' IP, if present (default "X-Forwarded-For")


Help Options:
  -h, --help                    Show this help message

Directories

Path Synopsis
cmd
ipd
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL