Get started

In the repository's folder, install the packages and start PostgreSQL. pnpm install gives this checkout its own database and its own address, and prints both.

pnpm install
docker compose up --wait

This builds what the server needs, applies the database migrations, and starts the application. The address it serves is in its log, on the line starting serving.

pnpm dev

While no user exists, the log prints a one-time setup link (no users exist yet: open …/setup#…). Open it, name your organization, and create the first admin with an email and a password of at least 15 characters. The page closes itself afterward.

The first admin holds the admin role only, and creating an initiative needs the product role. Go to Administration, then Members, choose Change roles on your own row, tick Product and Reviewer, and choose Update roles. In a team, you would invite the product people and reviewers instead.

Go to Administration, then Plugins. Choose Enable… on Document upload, Manual entry, and Core workflows; each shows its settings, then the permissions it asks for under Review permissions, and is turned on with Enable. Core workflows provides the eight stage workflows.

Go to Administration, then Models and keys, add an organization key for OpenAI, Anthropic, or an OpenAI-compatible endpoint, and choose Probe to test it. Then choose a model for each task, or keep the defaults for your provider. Without a key you can still load and approve knowledge and create initiatives.

Optional. Start the local embedding service beside the database; its first start downloads a small open embedding model. Then, under Administration, Models and keys, Embeddings and search, choose Use the local service. Search then matches meaning as well as words, and no passage is sent anywhere to be embedded.

docker compose --profile embeddings up --wait

Under Knowledge, upload a few documents (Word, PDF, Markdown, text, or spreadsheets), or write a manual entry. Each one is processed and then waits for review.

Open Knowledge, then Review queue, open a document, read what was extracted, and choose Approve under the decision on its version. For a source's first load, Approve all approves every document of that source, each with its own recorded decision. Approved documents appear in search.

Go to Workbench and choose Create initiative. Give it a title and describe the idea: who has the problem, what you want, and what is out of scope. Create it, and you land on its overview with eight stages. Start with problem framing.