A small Node.js module to retrieve the request's IP address
npm install request-ipA tiny Node.js module for retrieving a request's IP address.
Yarn
``
yarn add request-ip
npm
`bash`
npm install request-ip --save
Getting Started
`javascript
const requestIp = require('request-ip');
// inside middleware handler
const ipMiddleware = function(req, res, next) {
const clientIp = requestIp.getClientIp(req);
next();
};
// on localhost you'll see 127.0.0.1 if you're using IPv4
// or ::1, ::ffff:127.0.0.1 if you're using IPv6
`
`javascript
const requestIp = require('request-ip');
app.use(requestIp.mw())
app.use(function(req, res) {
const ip = req.clientIp;
res.end(ip);
});
`
To see a full working code for the middleware, check out the examples folder.
The connect-middleware also supports retrieving the ip address under a custom attribute name, which also works as a container for any future settings.
It looks for specific headers in the request and falls back to some defaults if they do not exist.
The user ip is determined by the following order:
1. X-Client-IP X-Forwarded-For
2. (Header may return multiple IP addresses in the format: "client IP, proxy 1 IP, proxy 2 IP", so we take the first one.)CF-Connecting-IP
3. (Cloudflare)Fastly-Client-Ip
4. (Fastly CDN and Firebase hosting header when forwared to a cloud function)True-Client-Ip
5. (Akamai and Cloudflare)X-Real-IP
6. (Nginx proxy/FastCGI)X-Cluster-Client-IP
7. (Rackspace LB, Riverbed Stingray)X-Forwarded
8. , Forwarded-For and Forwarded (Variations of #2)appengine-user-ip
9. (Google App Engine)req.connection.remoteAddress
10.
11.
12.
13.
14. (Cloudflare fallback)request.raw
15. (Fastify)
If an IP address cannot be found, it will return null.
* Getting a user's IP for geolocation.
Make sure you have the necessary dev dependencies needed to run the tests:
`
npm install
Run the integration tests
`
npm test
Compiles the current ES6 code to ES5 using Babel.
`
npm build
See the wonderful changelog
To generate a new changelog, install github-changelog-generator then run npm run changelog`. This will require being on Ruby >= 3
Thank you to all the contributors!
The MIT License (MIT) - 2022