cookbook / wiki
Wiki.js
A wiki the agent can write pages to and hand you a link into, instead of NOTES.md.
- app
- document
- stack
Run it
briq_run({
recipe: "wiki",
params: {
"size": "small"
},
wait: true
})briq run wiki
briq ls
briq logs -f <id>
briq rm <id>import { Briq } from '@briq/sdk';
const briq = new Briq(process.env.BRIQ_API_KEY);
const wiki = await briq.run({
recipe: 'wiki',
params: {
"size": "small"
},
});
console.log(wiki.outputs.WIKI_URL);
// ... when done
await briq.destroy(wiki.id);Parameters
| Name | Type | Options | Default |
|---|---|---|---|
| size | enum | small, medium | "small" |
Outputs
Returned by briq_run once the stack is healthy. Hosts resolve inside your team network; secrets are generated per run.
- WIKI_URL
- http://wiki.<stack>.internal:3000
What it runs
| Briq | Image | Ports | Size | Volume |
|---|---|---|---|---|
| postgres | postgres:16 | 5432 | nano | 10 GB at /var/lib/postgresql/data |
| wiki | requarks/wiki:2 | 3000 | small | — |
When to use it
- Your repo has grown a NOTES.md, a DOCS.md and a handful of one-off write-ups that only the agent (or whoever remembers the filename) ever opens.
- You want the agent to write up what it found — an incident, an architecture decision, a runbook — as a page with a title and a URL, not another file in the root of the repo.
- You want to hand a teammate a link into a real page, with search and history, instead of a diff of a markdown file in a pull request.
This is two briqs: postgres holds the content, wiki is the Wiki.js server itself. Postgres is
never exposed; only wiki has a port meant to be shared.
Tips
briq_exposeonly thewikibriq, on port 3000. Postgres has no port to expose and no reason to be reached from outside the stack.- First run asks for an admin account through the web UI — visit the exposed URL once before scripting anything against it.
- The agent writes pages through the REST/GraphQL API once it has an API token, generated from the admin area after that first visit.
- Stop instead of destroy between sessions: the wiki's content lives in Postgres, and a stopped briq keeps the volume.