README

Requirements

An active installation of Ominity.
Up-to-date OpenSSL (or other SSL/TLS toolkit)
PHP >= 8.1
Laravel >= 10.0

Installation

You can install the package via Composer. Run the following command in your terminal:

composer require ominity/laravel-ominity

After installing the package, the Ominity service will be available for use in your Laravel application.

Configuration

Publish the configuration file using the following Artisan command:

php artisan vendor:publish --provider="Ominity\Laravel\OminityServiceProvider"

This will create a config/ominity.php file where you can configure the package settings.

Forms / reCAPTCHA

The form renderer supports two reCAPTCHA drivers:

classic: uses api.js and backend siteverify
enterprise: uses enterprise.js and backend projects.assessments.create

Classic mode remains the default for backwards compatibility, including migrated legacy keys that still use the classic frontend/backend calls.

Example classic v3 configuration:

OMINITY_FORMS_RECAPTCHA_ENABLED=true
OMINITY_FORMS_RECAPTCHA_DRIVER=classic
OMINITY_FORMS_RECAPTCHA_VERSION=v3
OMINITY_FORMS_RECAPTCHA_SITE_KEY=your_site_key
OMINITY_FORMS_RECAPTCHA_SECRET_KEY=your_secret_key
OMINITY_FORMS_RECAPTCHA_ACTION=submit
OMINITY_FORMS_RECAPTCHA_SCORE=0.5

Example reCAPTCHA Enterprise score-based configuration:

OMINITY_FORMS_RECAPTCHA_ENABLED=true
OMINITY_FORMS_RECAPTCHA_DRIVER=enterprise
OMINITY_FORMS_RECAPTCHA_VERSION=v3
OMINITY_FORMS_RECAPTCHA_SITE_KEY=your_site_key
OMINITY_FORMS_RECAPTCHA_ENTERPRISE_PROJECT_ID=your-google-cloud-project-id
OMINITY_FORMS_RECAPTCHA_ENTERPRISE_API_KEY=your-google-cloud-api-key
OMINITY_FORMS_RECAPTCHA_ACTION=submit
OMINITY_FORMS_RECAPTCHA_SCORE=0.5

If Google Cloud Console shows examples that use grecaptcha.enterprise.execute(...), you should use the enterprise driver instead of classic.

Tracking

The package now includes a first-party visitor/event tracking layer.

Add the existing script directive to your layout:

@ominity_scripts

That now does two things:

loads vendor/ominity/ominity.js
boots the tracking runtime with the current visitor ID, authenticated user ID, route endpoint, and page metadata

Tracked automatically in the browser:

page views
session starts
scroll depth milestones
outbound link clicks
file downloads
native form submits
custom click events via data-ominity-event

Configuration lives under config/ominity.php in the tracking section.

Important environment flags:

OMINITY_TRACKING_ENABLED=true
OMINITY_TRACKING_SEND_IN_LOCAL=false
OMINITY_TRACKING_LOG_IN_LOCAL=true

Local environment behavior defaults to logging events instead of forwarding them to Ominity.

For manual page metadata you can use:

@ominity_tracking_meta([
    'origin_resource' => [
        'resource' => 'product',
        'id' => $product->id,
        'slug' => $product->slug,
    ],
])

For server-side access:

Ominity::tracking()->track([
    'event' => 'purchase',
    'visitorId' => Ominity::tracking()->getVisitorId(),
    'metadata' => [
        'order_id' => $order->id,
    ],
]);

ominity / laravel-ominity

Maintainers

Package info

Statistics

Security