Documentation is English-only for now. The rest of the site follows your language.
Documentation
Justflows documentation
Install, author, theme, extend, operate, and build with AI agents on the open-source web platform.
Start with the quickstart if you are new, or jump to AI agents, hooks, the public content API, caching, or security. Every page is written to be read on its own, with the real commands, routes, and settings from justflows-platform-ce.
Most read
Getting started
What Justflows is, how a request is served, and a guided first setup.
Introduction
What Justflows is, the problem it solves, and how to find your way around these docs.
How it works
The warm Node process, the public site, the admin SPA, and the difference from a PHP request.
Quickstart
Get a running Justflows site in minutes with Docker, then publish your first page.
Core concepts
The building blocks of a Justflows site: sites, content, blocks, themes, plugins, hooks, and cache.
Install
Docker, shared hosting, source installs, databases, and environment variables.
Installation
Three install paths: Docker, shared hosting / cPanel, and a full source checkout for developers.
Databases
PostgreSQL, MySQL 8+, and MariaDB 10.6+ — how to choose, connect, and migrate.
Configuration
Every environment variable that Justflows reads: app, database, storage, cache, gzip, and package trust.
Content
Posts, pages, the block editor, media, comments, menus, languages, and WordPress import.
Content
Posts and pages: create, edit, publish, translate, and what the Content Types screen can (and cannot) do yet.
Block editor
The visual page builder, the block JSON document, patterns, and how plugins add blocks.
Core blocks
All 18 registered core block types: content, media, layout, and section blocks.
Media
Upload and list files, allowed types, where files live, and the media package’s S3 and derivatives.
Comments
Moderate comments: list by status, approve, mark as spam, or trash.
Menus
Nested navigation: custom links, pages, and posts. The primary menu cannot be deleted.
Languages
Site locales, default language, visitor locale, and admin UI translations.
WordPress import
Import a WXR .xml export into Justflows posts and pages as HTML blocks.
Appearance
Themes, the live customizer, and CSS frameworks.
Themes
Install and activate .jfpkg themes, the default theme, and theme patterns.
Theme customizer
Live identity, colors, typography, layout, navigation, extra CSS, and homepage blocks — draft then publish.
CSS providers
Swap the CSS framework for the public site: Bootstrap, Pico, Tailwind, none, and the rest of the bundled set.
Extend
Plugins, the typed hook system, and the marketplace.
Plugins
Write a plugin in plugins/<name>/, then install, activate, and manage .jfpkg packages. Manifest, permissions, and the SDK context.
Hooks
Typed actions, gates, and filters — the complete core hook list and how to register them.
Marketplace
Browse plugins and themes from the Justflows API. Self-hosted sites install community packages from Admin → Marketplace.
Developers
AI agent skills, the public REST API, the justflows CLI, and workspace packages.
Public API
Anonymous REST for published content, the site identity endpoint, and the public API kill switch.
CLI
The justflows command: status, plugins, themes, users, migrations, cache, health, and updates.
Packages
What each workspace package is for — core, sdk, plugin-api, blocks, cache, and the rest.
Build with AI agents
How repository-native skills help AI coding agents understand, change, and verify Justflows safely.
Operations
Users, settings, security, cache, performance, health, and updates.
Users and roles
Login, five roles, capabilities, user CRUD, sessions, and rate limits.
Settings
Site name, URL, timezone, visibility, public API, and search-engine discouragement.
Security
Security headers, CSRF, sessions, password hashing, rate limits, and signed packages.
Caching
jf-cache drivers, what is cached, headers, stats, clear, and the plugin cache API.
Performance
Gzip, browser Cache-Control, the Tools performance suite, and why the warm process stays cheap.
Health and updates
Site health checks, liveness, core update uploads, and database migrate from admin or CLI.
Help
Fixes for common problems and a plain-English glossary.