echoip/README.md

91 lines
1.7 KiB
Markdown
Raw Normal View History

2015-09-17 21:14:09 +02:00
# ifconfig.co: Simple IP address lookup service
2012-11-19 19:11:03 +01:00
2015-09-17 21:31:14 +02:00
[![Build Status](https://travis-ci.org/martinp/ifconfigd.svg)](https://travis-ci.org/martinp/ifconfigd)
2012-11-19 19:11:03 +01:00
A simple service for looking up your IP address. This is the code that powers
http://ifconfig.co
2015-09-17 21:14:09 +02:00
## Usage
2012-11-21 13:58:06 +01:00
2015-09-17 21:14:09 +02:00
Just the business, please:
2012-11-21 13:58:06 +01:00
2015-09-17 21:14:09 +02:00
```
$ curl ifconfig.co
127.0.0.1
$ wget -qO - ifconfig.co
127.0.0.1
$ fetch -qo - ifconfig.co
127.0.0.1
```
A specific header:
```
$ curl ifconfig.co/user-agent
curl/7.43.0
$ curl ifconfig.co/x-ifconfig-country
Norway
```
As JSON:
```
$ curl -H 'Accept: application/json' ifconfig.co
{
"x-ifconfig-ip": "127.0.0.1"
}
$ curl ifconfig.co/x-config-ip.json
{
"x-ifconfig-ip": "127.0.0.1"
}
```
2012-11-19 19:11:03 +01:00
2014-01-26 20:39:04 +01:00
Pass the appropriate flag (usually -4 and -6) to your tool to switch between
2012-11-19 19:11:03 +01:00
IPv4 and IPv6 lookup.
2015-09-17 21:14:09 +02:00
The subdomain http://v4.ifconfig.co can be used to force IPv4 lookup.
## Features
2012-11-19 19:11:03 +01:00
* Easy to remember domain name
* Supports IPv4 and IPv6
* Open source
* Fast
* Supports typical CLI tools (curl, wget and fetch)
2014-12-22 00:19:29 +01:00
* JSON output (optional)
2015-09-17 21:14:09 +02:00
* Country lookup for IP address through the MaxMind GeoIP2 database
## Why?
2012-11-19 19:11:03 +01:00
* To scratch an itch
* An excuse to use Go for something
* Faster than ifconfig.me and has IPv6 support
2015-09-17 21:14:09 +02:00
## 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/ifconfigd`
### Usage
```
ifconfigd -h
Usage:
ifconfigd [OPTIONS]
Application Options:
-f, --file=FILE Path to GeoIP database
-l, --listen=ADDR Listening address (:8080)
-x, --cors Allow requests from other domains (false)
-t, --template= Path to template (index.html)
Help Options:
-h, --help Show this help message
```