README

Tell search engines about new, changed and deleted pages the moment an Eloquent model is committed. One attribute on the model, one env variable, done.

Русская версия

Who gets notified

Yandex, Bing (and DuckDuckGo via Bing), Naver, Seznam, Yep — every engine that implements the IndexNow protocol. One request to the shared endpoint reaches all of them.

Google: no. Google does not support IndexNow, its sitemap ping endpoint is gone (404) and the Indexing API is restricted to JobPosting / BroadcastEvent. This package will not pretend otherwise.

Install

composer require indexnowkit/laravel
php artisan vendor:publish --tag=indexnow-config   # config/indexnow.php (optional, every key has a default)
php artisan indexnow:key:generate --write-env      # adds INDEXNOW_KEY to .env
php artisan indexnow:check                         # config, key file reachable, queue, cache

The service provider is auto-discovered. Laravel ships Guzzle, which is the PSR-18 client the package discovers; any other PSR-18 client works too (indexnow.http.client).

INDEXNOW_KEY=...                      # from key:generate
INDEXNOW_BASE_URL=https://www.example.com   # defaults to APP_URL; used by artisan and queue workers

Declare what has a public page

#[IndexNow] is repeatable: one attribute per family of public URLs the model has. IndexNowable registers the observer.

use IndexNowKit\Attribute\{IndexNow, IndexNowDefaults};
use IndexNowKit\Laravel\Eloquent\IndexNowable;

#[IndexNowDefaults(when: 'isPublished', fields: ['slug', 'title', 'body', 'published'])]
#[IndexNow(route: 'posts.show', params: ['post' => 'self'])]                 // route model binding
#[IndexNow(route: 'posts.amp', params: ['post' => 'self'], when: 'hasAmp')]
#[IndexNow(via: 'category')]      // a changed post also refreshes its category page
#[IndexNow(urls: ['/'])]          // and the homepage
class Post extends Model
{
    use IndexNowable;

    public function isPublished(): bool { return $this->published; }
    public function hasAmp(): bool { return $this->amp; }
}

Option	Meaning
`route` / `params`	route name and `param => attribute, method, "self", dotted.path` or a typed `Param\*` value
`resolver`	a `UrlResolverInterface` class or container binding for anything custom
`via`	a relation (or dotted path) whose pages are resubmitted
`url` / `urls`	a method returning the URL(s), or literal URLs
`when` / `whenFields`	bool attribute or method; drafts are skipped and `published → draft` is sent as a deletion
`fields`	for updates, submit only when one of these attributes changed
`events`	subset of `created`, `updated`, `deleted`
`locales`	`current` (default), `all` (`indexnow.router.locales`), or a list
`host`	generate this rule's URLs on another host (multi-domain)
`name`	stable rule id for logs, `indexnow:explain` and overriding in a subclass

Accessors read Eloquent attributes, casts, accessors and relations (category.slug) and fall back to methods (isPublished()). params: ['post' => 'self'] passes the model to route(), so {post} and {post:slug} both work. A when attribute that only has a database default is not on the model right after create(): give it a model default (protected $attributes = ['published' => false]).

Full model, typed parameters, inheritance and the semantics table: core attribute reference.

Models you cannot annotate

// AppServiceProvider::boot()
use IndexNowKit\Laravel\Facades\IndexNowKit;

IndexNowKit::observe(Product::class, [new IndexNow(route: 'products.show', params: ['product' => 'self'])], new IndexNowDefaults(when: 'is_active'));
IndexNowKit::rules()->registerFor(Page::class, fn (Page $page): ?RuleSet => ...);   // decided per object

Verify

php artisan indexnow:check          # config, key file reachable, engines, queue connection, cache store, spool
php artisan indexnow:check --live   # also sends a real probe request to every engine

Run it after every key rotation and after every deployment that touches the configuration.

How it works

Observer callbacks resolve URLs while the old state is still live (getOriginal() in updated, the row in deleting) and hand them over through Connection::afterCommit(): nothing leaves before the outermost transaction commits, a rolled-back transaction (or savepoint) discards them. DB::transaction() nesting is handled by Laravel's transaction manager.
Every rule is classified separately: the article page can be an update while the AMP page of the same model is a deletion, in the same request.
Everything collected during one request, artisan command or queue job is sent as one batch in app()->terminating() (or after each handled job), never inside your request.
dispatch: queue (the default) pushes a SubmitUrlsJob; 429 and 5xx are retried with backoff, Retry-After wins, 403/422 fail the job so a broken key file shows up in failed_jobs. QUEUE_CONNECTION=sync runs it inline.
SoftDeletes: soft delete is a deletion, restore() a creation, forceDelete() a deletion.
A renamed page (changed slug, or a changed route key behind self) announces its old URL as deleted and the new one as updated, in the same batch.
Nothing thrown from a rule, a resolver or the HTTP layer reaches your application: it is logged, the save succeeds.

Commands

Command	Options
`indexnow:check`	`--live` real probe · `--host=` one host · `--probe-url=` page for the probe
`indexnow:submit <urls...>`	`-f, --force` ignore debounce · `--dry-run` · `--json`
`indexnow:submit-model <model> [ids...]`	`--event=` · `--limit=` · `--explain` · `-f, --force` · `--dry-run` · `--json`
`indexnow:explain <model> <id>`	`--event=` — rules, `when`, URLs, key, debounce; sends nothing
`indexnow:sitemap [sitemap]`	`--changed-since="1 day"` · `--allow-foreign-hosts` · `-f, --force` · `--dry-run` · `--json`
`indexnow:key:generate`	`-l, --length` · `--alphanumeric` · `--write-env[=FILE]` (default `.env`) · `--force` rotate

<model> accepts an FQCN or a short App\Models name. indexnow:sitemap with no argument reads indexnow.sitemap.url, else <base_url>/sitemap.xml; a local path works too. Schedule it: Schedule::command('indexnow:sitemap --changed-since="1 day"')->daily().

Configuration

Every key of config/indexnow.php, its default and what it does: docs/configuration.md.

Topic
Queue, retries, Horizon	docs/queue.md
Multiple domains and locales	docs/multi-domain.md
Sitemaps	docs/sitemap.md
Extending: bindings you can replace, custom resolvers, checks	docs/extending.md
Testing your integration	docs/testing.md
Troubleshooting	docs/troubleshooting.md

Debugging

php artisan indexnow:explain "App\Models\Post" 42 walks the decision path for one model — rules, event subscription, when, fields, resolved URLs, normalization, host and key, debounce — and sends nothing.
The log channel (indexnow.logging.channel, default channel otherwise) carries everything; at debug it also says why a rule decided not to produce a URL. Messages and levels: operations guide.
failed_jobs holds batches an engine rejected permanently (403: key file not reachable).

An invalid configuration does not throw from a save: IndexNow is disabled, one critical line is logged, and indexnow:check prints the exact error.

Limitations

Model::query()->update(), delete(), insert(), upsert() and DB::table() fire no model events (conformance A13): call IndexNowKit::submitModels($query->get()) or php artisan indexnow:submit-model afterwards.
attach() / detach() / sync() on a pivot fire no events on the owner. Put $touches = ['posts'] on the related model: the owner's updated (only updated_at changed) reaches a rule without a fields filter.
dispatch: sync depends on terminating firing. Under Octane it does; an early exit() or a fatal error discards the batch with a warning. Prefer the default queue.
Sub-domains are separate hosts: give each its own key with the hosts map, and set strict_hosts: true.
Outside production (production_environments, default prod/production), a missing INDEXNOW_KEY switches dry_run on instead of failing.

Compatibility

Public API: config/indexnow.php keys, command names and options, the container bindings listed in docs/extending.md, Facades\IndexNowKit / IndexNowManager, Eloquent\IndexNowable, Queue\SubmitUrlsJob. The core's rules apply, including the "may grow" interfaces: bc.md. Before 1.0 a minor version may break; every break is listed under "Changed" in CHANGELOG.md with the migration. Laravel 11, 12 and 13, PHP 8.2–8.5 (Laravel 13 needs PHP 8.3).

Other frameworks


PHP	core, symfony-bundle, doctrine
JS/TS	@indexnowkit/core, next, prisma (soon)
Python	indexnowkit, indexnowkit-django (soon)

Design rationale: docs/spec. Changelog: CHANGELOG.md.

MIT. IndexNow is a trademark of its owner; this project is independent and not affiliated with Microsoft, Yandex or indexnow.org.

indexnowkit / laravel

Maintainers

Package info

Statistics

Security