echoip/README.md
2016-04-15 20:57:35 +02:00

90 lines
1.8 KiB
Markdown

# ipd
[![Build Status](https://travis-ci.org/martinp/ipd.svg)](https://travis-ci.org/martinp/ipd)
A simple service for looking up your IP address. This is the code that powers
http://ifconfig.co
## Usage
Just the business, please:
```
$ curl ifconfig.co
127.0.0.1
$ http ifconfig.co
127.0.0.1
$ wget -qO- ifconfig.co
127.0.0.1
$ fetch -qo- http://ifconfig.co
127.0.0.1
```
Country lookup:
```
$ http ifconfig.co/country
Home, Sweet Home
```
As JSON:
```
$ http --json ifconfig.co
{
"ip": "127.0.0.1",
"country": "Home, Sweet Home"
}
```
Pass the appropriate flag (usually -4 and -6) to your tool to switch between
IPv4 and IPv6 lookup.
The subdomain http://v4.ifconfig.co can be used to force IPv4 lookup.
## Features
* Easy to remember domain name
* Supports IPv4 and IPv6
* Supports HTTPS
* Open source under the [BSD 3-Clause license](https://opensource.org/licenses/BSD-3-Clause)
* Fast
* Supports typical CLI tools (curl, httpie, wget and fetch)
* JSON output (optional)
* Country lookup for IP address through the MaxMind GeoIP2 database
## Why?
* To scratch an itch
* An excuse to use Go for something
* Faster than ifconfig.me and has IPv6 support
## Building
Compiling requires the [Golang compiler](https://golang.org/) to be installed.
This application can be installed by using `go get`:
`go get github.com/martinp/ipd`
### Usage
```
$ ipd -h
Usage:
ipd [OPTIONS]
Application Options:
-f, --file=FILE Path to GeoIP database
-l, --listen=ADDR Listening address (default: :8080)
-x, --cors Allow requests from other domains
-r, --reverse-lookup Perform reverse hostname lookups
-p, --port-testing Enable port testing
-t, --template= Path to template (default: index.html)
Help Options:
-h, --help Show this help message
```