JustFlows

Documentation is English-only for now. The rest of the site follows your language.

Quickstart

Get a running Justflows site in minutes with Docker, then publish your first page.

6 min read

This is the shortest path: Docker Desktop, a .env file, docker compose up, and the browser wizard. If Docker is not an option, see Installation for shared hosting and a full source checkout.

1. Get the files

Download the Community Edition zip or clone the repository. Open the project folder.

2. Create `.env`

Copy .env.production.example (Docker) or .env.example (source) to .env. Set APP_URL (no trailing slash) and a random APP_SECRET of at least 32 characters.

Generate APP_SECRET
bash
node -e "console.log(require('crypto').randomBytes(48).toString('hex'))"

3. Start Docker

bash
docker compose up

On a VPS use docker compose up -d so it stays in the background. PostgreSQL is included automatically. For MySQL or MariaDB see Databases.

4. Complete the wizard

Open http://localhost:3000/install. The wizard asks for database details (already filled in Docker), site name and URL, and the first admin account. Progress streams over SSE. When it finishes, sign in at /login and you land in /admin.

The site starts unpublished

Install sets site_public=false. Visitors see under-construction until you turn the site on in Settings.

5. Publish something

  1. 1

    Create a page

    Admin → Content → New. Choose page, give it a title, open the builder, drop in a heading and a paragraph, save.

  2. 2

    Publish

    Set status to published. The public site will serve it at /{slug} once the site itself is public.

  3. 3

    Optional: headless

    Enable the public API in Settings, then GET /api/v1/content?slug=your-slug. Details in Public API.

Where next

Core concepts

Sites, content types, blocks, plugins, and hooks — the words the rest of the docs use.

Hooks

Typed actions, gates, and filters for plugin authors.

Caching

jf-cache drivers, page HTML, and how to clear it.

CLI

justflows status, plugins, cache clear, health, and more.