@gautric/node-red-ipinfo 1.0.0

The Trusted Source For IP Address Data Node-Red Implementation

npm install @gautric/node-red-ipinfo

IP Info - Node-RED Node

Overview

IP Info is a Node-RED node that provides detailed IP address information using the IPInfo.io service. This node allows you to easily retrieve geolocation, network, and other relevant details about an IP address within your Node-RED flows.

Features

• Retrieve comprehensive IP address information
• Configurable caching to improve performance
• Customizable timeout settings
• Easy integration with Node-RED flows

Prerequisites

• Node-RED
• IPInfo.io account (free tier available)

Installation

You can install the node using one of the following methods:

Node-RED Palette Manager

1. Open Node-RED
2. Go to Menu > Manage palette
3. Search for @gautric/node-red-ipinfo
4. Click Install

Command Line

# Using npm
cd ~/.node-red
npm install --save @gautric/node-red-ipinfo

# Using yarn
cd ~/.node-red
yarn add @gautric/node-red-ipinfo

Configuration

Node Configuration

• input: Specifies where to retrieve the IP address from the message (msg.payload)
• output: Defines where to put the result in the Node-RED flow (msg.payload)
• name: Custom name for the node instance

IPInfo Config

• name: Name of the node configuration instance
• token: Your IPInfo API Token
  • Sign up at IPInfo.io to get your token
• timeout: Request timeout in milliseconds (default: 1000 ms)
• cacheEnabled: Enable/disable caching (default: true)
  • Improves performance and reduces API calls
• maxitem: Maximum number of items in the cache (default: 5000)
• ttl: Time To Live (TTL) for cached items in milliseconds (default: 24 * 1000 * 60 * 60 ms)

Usage Example

Basic Flow Example

1. Drag the IP Info node into your flow
2. Configure the node with your IPInfo token
3. Connect input and output nodes as needed

Contributing

Contributions are welcome! Please feel free to:

• Report bugs
• Suggest features
• Submit pull requests

Reporting Issues

Open an issue on GitHub

Support

If this project helps you, consider:

• Starring the repository
• Buying the developer a coffee

License

This project is licensed under the MIT License. See the LICENSE file for details.