README

A Laravel package to automatically capture and track IP addresses on Eloquent model actions such as signup, login, update, and deletion.

Table of Contents

• Features
• Requirements
• Installation
• Configuration
• Usage
  • Add the Trait
  • Available Methods
  • Custom Columns
  • IP Hashing
• Testing
• License

Features

• Automatic IP capture on model events (signup, login, update, delete)
• Tracks 6 configurable IP columns per model
• Simple trait-based integration with any Eloquent model
• Proxy and load balancer aware (Cloudflare, X-Forwarded-For, etc.)
• Optional IP hashing for privacy compliance (SHA-256 or custom algorithm)
• Fluent interface for chaining multiple IP captures
• Configurable column names and enable/disable per column
• Publishable config, migrations, and translations

Requirements

Installation

composer require jeremykenedy/laravel-ip-capture

Publish the config file:

php artisan vendor:publish --tag=ip-capture-config

Publish and run the migration:

php artisan vendor:publish --tag=ip-capture-migrations
php artisan migrate

Configuration

The config file is published to config/ip-capture.php.

Default Columns

Environment variables:

IP_CAPTURE_ENABLED=true
IP_CAPTURE_NULL_IP=0.0.0.0
IP_CAPTURE_TRUST_PROXIES=true
IP_CAPTURE_HASH=false
IP_CAPTURE_HASH_ALGO=sha256

Usage

Add the Trait

Add the CapturesIp trait to your User model (or any Eloquent model):

use Jeremykenedy\LaravelIpCapture\Traits\CapturesIp;

class User extends Authenticatable
{
    use CapturesIp;
}

Available Methods

All setter methods return static for fluent chaining:

$user->setSignupIp()->setAdminIp()->save();

Custom Columns

Add a custom column to the config:

'columns' => [
    'signup_ip_address'  => true,
    'custom_ip_address'  => true,  // your custom column
],

Then use setIpColumn() to capture:

$user->setIpColumn('custom_ip_address');

IP Hashing

Enable hashing for privacy compliance:

IP_CAPTURE_HASH=true
IP_CAPTURE_HASH_ALGO=sha256

When enabled, all captured IPs are hashed before storage. This is a one-way operation.

Testing

composer test

Or run Pest directly:

./vendor/bin/pest --ci

License

This package is open-sourced software licensed under the MIT license.