Sign in

Devani OSS — Developer Docs

Featured

Architecture overview
Plain PHP, no database, no build step. The filesystem is the data model: pages are folders, settings are JSON tables, and every request renders content.html inside the shared template.

Architecture

How Devani works: no database, flat files, and the render path.

Architecture overview
Plain PHP, no database, no build step. The filesystem is the data model: pages are folders, settings are JSON tables, and every request renders content.html inside the shared template.
Architecture
 The save pipeline & sanitizer
Every editor save passes through one sanitizer with one convention: editor artifacts are namespaced (data-devani-*, devani-inline*/devani-ed*) so a single rule strips them all. Content modules survive via an explicit allowlist.
Architecture
 Content storage layout
Pages are root folders, posts live under blog/, products under products/. Each holds content.html, meta.json, and featured-image.txt. Preserve this structure and everything else follows.
Architecture

Extending & integrating

The MCP server, module embeds, and configuration.

Configuration & environment overrides
config.php reads DEVANI_* environment variables; the settings store holds per-site values; env presence is what distinguishes a managed host from a self-hosted install. Resolution order matters.
Extending & integrating
 Integration modules: the Sendl pattern
Every external-service embed follows one five-part pattern: a settings key, an admin-only proxy, an editor block, an MCP tool pair, and sanitizer-safe markup. Clone Sendl and you can't go far wrong.
Extending & integrating
 The MCP server
Every site serves MCP at /devani/mcp/. Keyed auth, role-based write gating, write-only integration settings, per-write snapshots, and a full audit log — the contract tool authors build against.
Extending & integrating

Operations & contributing

Releases, local development, testing, and sending patches.

Contributing a change
Download the source, make the fix, test it, email the diff to hello@devani.io. MIT license, no CLA, credit in the release notes that ship your change.
Operations & contributing
 Running locally & testing
php -S localhost:8000 is a full dev environment — no build step, no database. Lint with php -l, run the sanitizer regression suite, and exercise the flow you changed before sending a patch.
Operations & contributing
 Releases & the update feed
Releases are checksummed zips announced through latest.xml. The feed is notify-only — publishing a release never changes a running site until its admin applies the update.
Operations & contributing
Powered by Subido