README

Filament Sentinel

Branded, diagnostic error pages for Filament.

A drop-in replacement for Laravel's default 500, 403, 404, 419 and 503 pages, built from native Filament UI so they inherit your panel's colours, fonts, brand logo and dark mode automatically.

Native Filament, not a bespoke theme — pages are composed from <x-filament::button>, badge, section and icon, on a light theme-aware scaffold. No design system to maintain.
Real data, never invented — content is derived from the actual exception: the permission behind a 403, the missing path on 404, Retry-After on 503, and on 500 the real exception behind a "View more" panel — class, location, message and a structured, debugger-style stack trace, unwrapped to the root cause. Exposure follows APP_DEBUG by default; force it on/off with show_exception_details.
A 403 that says why — it names the permission the user is missing (e.g. ViewAny:PayrollRun) and what it guards, not the roles they hold. See How the 403 explains a denial.
SAP-style message numbers (e.g. SNT-500-087), stable per error signature — the same failure always quotes the same number, easy to give to support.
Request ids assigned by middleware and echoed on the response, so the id on the page matches your logs.
Translations for English, European Portuguese and Brazilian Portuguese.

Screenshots

A panel action failed — the branded 500 appears over the real, still-visible page

403 — access denied, with the real reason	404 — page not found, with the missing path
419 — session expired	503 — maintenance, with `Retry-After`

Every page follows your panel's light or dark theme automatically

403 — light theme	404 — light theme
419 — light theme	503 — light theme

Installation

composer require anselmokossa/filament-sentinel

That's it. The package auto-registers and its pages become the default for aborted requests — nothing to publish. Your app can still override any page by adding its own resources/views/errors/{code}.blade.php.

The pages reuse Filament's published base stylesheet (public/css/filament/filament/app.css). It is created by php artisan filament:assets, which Filament already runs on install and deploy.

Register the plugin (optional)

Add the plugin to a panel to configure it fluently. This is optional — the pages work without it.

use Filament\Sentinel\SentinelPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            SentinelPlugin::make()
                ->brand('Acme')                 // defaults to the panel/app name
                ->messagePrefix('ACM')           // ACM-500-087
                ->windowPosition('bottom-right')  // or ->fullPage() for a full-page 500
                ->email('help@acme.test')        // "Contact support" mailto:
                ->homeUrl('/admin'),
        ]);
}

Configuration

Publish the config to tweak defaults:

php artisan vendor:publish --tag=sentinel-config

Option	Description	Default
`enabled`	Serve the branded pages at all	`true`
`codes`	Status codes Sentinel provides	`[500, 403, 404, 419, 503]`
`brand`	Wordmark shown on each page	panel / app name
`message_number.enabled`	Show the `SNT-500-087` reference	`true`
`message_number.prefix`	Message-number prefix	`SNT`
`request_id.enabled`	Show and assign a request id	`true`
`show_exception_details`	Reveal the real exception on 500: `null` follows `APP_DEBUG`, `true` always, `false` never	`null`
`window.style`	500 presentation: `window` (small docked) or `page` (full page, like the other codes)	`window`
`window.position`	Docked window placement: `bottom-left`, `bottom-right`, `top-left`, `top-right`, `top-center`, `bottom-center`, `center`, or a full-height slide-over with `slide-right` / `slide-left`	`bottom-left`
`window.width`	Docked window width — a number (pixels) or CSS length (`"28rem"`)	`400`
`support_url`	URL / `mailto:` for "Contact support"	`null`
`home_url`	Destination of the primary button	`/`

Fluent API

Every option above is also settable on SentinelPlugin::make(); anything left unset falls back to config/sentinel.php.

Method	Purpose
`->brand($name)`	Wordmark on every page
`->messagePrefix($prefix)`	Prefix of the message number
`->messageNumbers($bool)`	Toggle message numbers
`->requestId($bool)`	Toggle the request id
`->showExceptionDetails($bool)`	Force the 500 exception panel on (`true`) or off (`false`); omit to follow `APP_DEBUG`
`->windowPosition($position)`	Where the docked 500 window sits (`center`, `top-right`, `slide-right`, …)
`->windowWidth($width)`	Docked window width (`460` or `"28rem"`)
`->fullPage($bool = true)`	Render the 500 as a full page like the other codes
`->supportUrl($url)`	"Contact support" link
`->email($address)`	"Contact support" as a `mailto:` link
`->homeUrl($url)`	Primary "back to safety" destination
`->codes($array)`	Status codes to brand
`->enabled($bool)`	Disable the whole package

How the 403 explains a denial

A denied user already knows their roles; what helps is the reason. The 403 page shows the sharpest thing it can say, in this order:

The permission (or role) the user is missing. Read off the exception when it carries one (Spatie's UnauthorizedException), listing only the entries the user actually lacks. When a Filament panel denies with a bare AuthorizationException, Sentinel reads the current route instead: the route names the resource or page and the panel, the page names the ability (index → ViewAny, create → Create, edit → Update, view → View, delete → Delete), and Shield turns the pair into the real key, e.g. ViewAny:PayrollRun. Each permission is labelled with what it guards: Resource, Page, Widget or Custom permission.
The page's permission, marked as one the user already holds. Then the denial came from somewhere else — a plan, a module, a tenant scope — and the page says so, ruling out the obvious suspect.
The roles held, only when nothing sharper can be said.

What the exception carries always wins over anything inferred. Spatie and Shield are detected, never required: without Shield nothing is inferred from the route, and without Spatie no roles are listed.

The same answers are available in code: Sentinel::authorization($exception) returns the whole context the page renders, and Sentinel::missingPermissions($exception), Sentinel::heldPagePermission(), Sentinel::inferredPermission() and Sentinel::deniedTarget() each part of it.

Publishing & customization

php artisan vendor:publish --tag=sentinel-config        # config/sentinel.php
php artisan vendor:publish --tag=sentinel-translations  # lang files to edit the wording
php artisan vendor:publish --tag=sentinel-views         # the Blade views, to restyle

Overriding a page

Because the pages register as the default errors::{code} views, you override any of them the standard Laravel way — add your own resources/views/errors/404.blade.php and it wins.

Eject — keep the pages after removing the plugin

php artisan vendor:publish --tag=sentinel-errors

This drops a self-contained set of error pages (500, 403, 404, 419, 503) straight into resources/views/errors/. They have no dependency on this package — or even on Filament (their own palette, inlined styles and icons, only Laravel core for the message number, request id and exception detail), so they stay branded and keep working even after you composer remove the plugin. From then on they are yours to edit. The published copies live in your app, so they take precedence over the plugin immediately.

Testing

composer test

Security

Please do not open a public issue for a security problem. Report it through a private advisory or by e-mail to anselmo.cossa@enh.co.mz. SECURITY.md says what is in scope, what to include and what to expect.

License

MIT. See LICENSE.md.

anselmokossa / filament-sentinel

Package info

Security

Statistics

README

Filament Sentinel

Screenshots

A panel action failed — the branded 500 appears over the real, still-visible page

Every page follows your panel's light or dark theme automatically

Installation

Register the plugin (optional)

Configuration

Fluent API

How the 403 explains a denial

Publishing & customization

Overriding a page

Eject — keep the pages after removing the plugin

Testing

Security

License