README

A thin Livewire + Flux web UI for laranail/db-console — all UI, zero business logic. Every screen calls the audited core services and reuses the core validation layer.

Requires PHP ^8.4.1 || ^8.5, Laravel ^13.0, Livewire ^3.5.19 || ^4.0, and Flux ^2.0. This package is a front end only: the logic, security, and audit live in laranail/db-console, which this depends on.

The design is deliberate — the UI can never grow its own business logic or validation. A build-failing architecture test forbids any component from touching an engine, a connection, or raw SQL, or declaring its own validation rules for a database field. Names, hosts, and privileges are validated by the exact same rules the CLI and REST API use, so the three surfaces can never disagree.

Install

composer require laranail/db-console-webui
php artisan db-console-webui:install

The installer publishes the config, views, and language files. Build the CSS/JS entrypoints (resources/css/db-console.css, resources/js/db-console.js) into your app's Vite pipeline, or publish and adapt them.

The UI mounts at /db-console (configurable) and is guarded by the EnsureCanManage middleware: the caller must be signed in, hold a DBConsole permission, and — when configured — come from an allow-listed IP. Every action is still authorized inside the core services.

Documentation

Full documentation is hosted at https://opensource.simtabi.com/documentation/laranail/db-console-webui/.

Guides

Installation — install, mount the UI, wire the assets, guard access.
Getting started — the screens and what each one does.
Configuration — every laranail.db-console-webui.* key.
Architecture — the boundary, and why the UI holds no logic.

Reference

Components — the Livewire components and the core services each calls.
Middleware — EnsureCanManage and access control.

Recipes

Stability

Pre-1.0, tracking laranail/db-console. Breaking changes are in UPGRADING.md and the CHANGELOG.

Local development

composer install      # resolves laranail/db-console from Packagist
vendor/bin/pest       # component + boundary tests
composer lint         # Pint, PHPStan, Rector

To develop against unreleased laranail/db-console changes, add a local path repository for it (composer config repositories.db-console path ../db-console) — this is a local-only override and is not committed.

Sister packages

laranail/db-console — the headless core this UI wraps.
laranail/console, laranail/package-tools, laranail/enumerator — the shared toolkit.

Community

Questions in GitHub Discussions; bugs in Issues.

Contributing & security

See CONTRIBUTING.md. Report vulnerabilities per SECURITY.md (opensource@simtabi.com), never in a public issue.

laranail / db-console-webui

Maintainers

Package info

Statistics

Security