Plugins

umbral's only extension mechanism. Built-ins and third-party plugins are structurally identical.

A `Plugin` is a self-contained, swappable unit that bundles models, routes, and logic into one builder call.

umbral-auth plugin - AuthUser model, argon2 password hashing, session login helpers, and the custom user model swap.

Cookie-backed session store powered by a DB-backed session table.

Groups, permissions, and content types for umbral. The has_perm query layer.

Automatic CSRF protection and a hardening-headers bundle. Mount it and you're done.

Auto-generated CRUD UI for your models, served at /admin/.

Auto-generated JSON CRUD from your models - plus authentication, permissions, filtering, pagination.

Swagger UI + machine-readable JSON spec for your REST endpoints, auto-generated from the model registry.

Database-backed background task queue for running work outside the request cycle.

SMTP + template-driven transactional email with file attachments.

In-memory, SQLite, and Redis cache backends plus view-level cache_page middleware for umbral.

The unified StoragePlugin - serve developer-shipped static assets (the STATIC_URL pipeline, collectstatic, manifest-hash cache-busting, Cache-Control) AND user uploads (the media_file model, streaming saves, file-lifecycle cleanup) through one plugin and one Storage trait, with an optional shared S3 backend.

Per-model lifecycle hooks (pre_save, post_save, pre_delete, post_delete) that fire automatically from the ORM, plus a generic name-keyed pub/sub escape hatch for app-defined events.

Postgres Row-Level Security policies declared in the App builder and applied idempotently at boot.

Interactive API playground for umbral-rest endpoints - Postman-style request builder, schema introspection, per-endpoint stats.

Edit a template, stylesheet, or asset and the browser refreshes itself over SSE, with CSS hot-swapped in place. The Vite dev-loop feel for a server-rendered Rust app.

Fire-and-forget product-analytics event capture for umbral apps via a PostHog backend. Captures never block a request.

Request logging for umbral. A non-blocking capture layer records each HTTP request to a RequestLog model, browsable in the admin.

Push live data to one user or a room over SSE/WebSocket - model subscriptions, presence, room gating, and a Redis backplane. Full guides live in the Realtime section.

Schema-per-tenant and database-per-tenant multitenancy for Postgres. Split your app into tenant apps (isolated per tenant) and shared apps (one copy in public), worked through a Starknet explorer where blockchain networks are the tenants.

Social login and OAuth account connection for umbral, layered on umbral-auth. Sign in with Google or GitHub, with provider tokens encrypted at rest.

Liveness and readiness probes for umbral. Mounts GET /healthz (liveness) and GET /ready (readiness), with pluggable readiness checks for your dependencies.