detect-ip

Detect IP

Detect the "real" IP address of a given request.

About

This module is a wrapper for the request-ip module, which stores the detected IP address in res.locals.ip.

Installation

Using npm:

$ npm install detect-ip --save

Using yarn:

$ yarn add detect-ip

Usage

In ExpressJS:

// Load the module.
const detectIp = require('detect-ip')

// The Express app.
const app = express()

// Use the middleware to detect the "real" IP address of the client.
app.use(detectIp({
  // When the IP can not be detected the following fallback will be used.
  fallbackIp: '127.0.0.1'
}))

// Next, you should be able to access detected IP.
app.get('/', (req, res) => {

  // Get the "real" IP address of the client.
  res.locals.ip

  res.send('EOF')
})

How it works

For more details about how the "real" IP address is detected see the request-ip module.

License

The MIT License (MIT)

Copyright (c) 2017 Ion Suman [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.