https://github.com/floatdrop/express-real-ip
Use X-Real-IP header for ip address in express
https://github.com/floatdrop/express-real-ip
Last synced: about 1 year ago
JSON representation
Use X-Real-IP header for ip address in express
- Host: GitHub
- URL: https://github.com/floatdrop/express-real-ip
- Owner: floatdrop
- Created: 2014-07-02T08:15:09.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-07-02T08:47:34.000Z (almost 12 years ago)
- Last Synced: 2025-03-14T01:31:43.637Z (about 1 year ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# express-real-ip [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
> Get ip address from custom header
```js
var app = require('express')();
var getRealIp = require('express-real-ip')();
app.use(getRealIp);
app.get('/', function (req, res, next) {
res.send(req.ip);
next();
});
app.listen(3000, function() {
console.log('Listening on port %d', server.address().port);
});
// curl localhost:3000 -H "X-Real-Ip: 87.250.248.98"
// 87.250.248.98
```
# API
### express-real-ip([options])
Returns middleware function, that appends header value to X-Forwarded-For header (this is how express figures out `req.ip` value).
#### options
* `headerName` - name of header, which contains real ip address (defaults to `X-Real-Ip`).
# License
MIT (c) 2014 Vsevolod Strukchinsky (floatdrop@gmail.com)
[npm-url]: https://npmjs.org/package/express-real-ip
[npm-image]: http://img.shields.io/npm/v/express-real-ip.svg
[travis-url]: https://travis-ci.org/floatdrop/express-real-ip
[travis-image]: http://img.shields.io/travis/floatdrop/express-real-ip.svg