#request-ip

A tiny Node.js module for retrieving a request's IP address.

Installation

npm install request-ip

Getting Started

var requestIp = require('request-ip');

// inside middleware handler
var ipMiddleware = function(req, res, next) {
    var clientIp = requestIp.getClientIp(req); // on localhost > 127.0.0.1
    next();
};

How It Works

It looks for specific headers in the request and falls back to some defaults if they do not exist.

The following is the order we use to determine the user ip from the request.

1. X-Client-IP
2. X-Forwarded-For header may return multiple IP addresses in the format: "client IP, proxy 1 IP, proxy 2 IP", so we take the the first one.
3. X-Real-IP (nginx proxy/FastCGI)
4. X-Cluster-Client-IP (Rackspace LB, Riverbed Stingray)
5. Permuations of #2 such as: X-Forwarded, Forwarded-For and Forwarded
6. req.connection.remoteAddress
7. req.socket.remoteAddress
8. req.connection.socket.remoteAddress

Samples Use Cases

• Getting a user's IP for geolocation.

Dependencies

None

Running the Tests

Make sure you have the necessary dependencies:

npm install

Run the integration tests

npm test

Release Notes

1.1.2

• add support for Travis CI (continuous deployment) and Coveralls (code coverage)

1.1.0

• add support for X-Cluster-Client-IP, X-Forwarded, Forwarded-For, Forwarded
• add tests

1.0.0

• add semver

0.0.4

• add support for X-Real-Ip
• bug fixes

0.0.3

• improve docs

0.0.2

• bug fix

0.0.1

• initial release

License

The MIT License (MIT)