ClearFlow CMS

Build your own module

Need something ClearFlow doesn't have?

Write your own module, or let your developer or AI assistant do it. A module adds its own blocks, pages and backoffice screens to ClearFlow, and installs from a zip under Settings → Modules. Your module stays yours and runs only on your own website.

What a module can do

Keep its own data in the backoffice, add blocks for your pages, and give each item a page of its own below them, with its own title for search engines and in the sitemap. Think of a list of artists with a profile page each, recipes, or a team.

The module kit

A guide written for developers and AI assistants, a complete example module to start from, and a tool that signs and packs your module. It comes with ClearFlow, in docs/modules.

Safe by design

Only owners with two-step login can install a module, with their password again. The zip is signed with its author's own key, so nobody else can slip in a changed version.

How it works

  1. Read the kit. Start with the guide and the example module Recipes in docs/modules, or point your AI assistant to it.
  2. Build and test. Copy the example, rename it and make it yours. Its tests run inside a copy of ClearFlow, which is open source.
  3. Pack it. tools/module/pack.php signs every file with your own key and makes the zip. Keep the key safe: every new version must be signed with it.
  4. Install it. Settings → Modules → Install from a zip. A new version goes the same way.

ClearFlow is GPLv3: a module for your own website is yours to keep; if you give or sell it to others, the GPL applies to it too. We don't support modules we didn't make, but we're happy to think along.

Questions about your module?

Ask us through the contact form.

Get in touch