Installation

Requirements

• Node.js 20.9 or newer
• npm 10 or newer
• Docker and Docker Compose if you want the full local playground

Full local environment

The repository Compose stack starts PostgreSQL, Redis, Centrifugo, MinIO, the moderation sidecar, and the demo API plus UI.

git clone <your-gozwire-repository-url>
cd gozwire
cp .env.example .env
docker compose up --build

Open http://localhost:3000. That is the local demo: a playground for the engine, not a production chat app.

Service	Port
Demo API + UI	3000
Centrifugo	8000
PostgreSQL	5432
Redis	6379
MinIO	9000 (console 9001)
Moderation	8090

Engine only

@gozwire/core is the only npm package required for the engine.

import { createGozWire, defaultConfig } from "@gozwire/core";

const gozwire = await createGozWire({ config: defaultConfig() });
await gozwire.start();

Point config.database.url at PostgreSQL. start() runs migrations, including push tables. push.enabled defaults to false.

See use the engine and configuration.

Moderation models

Compose defaults to MODERATION_MODE=fixture so the stack starts without downloading Detoxify, NudeNet, or Falconsai weights. That mode is for local wiring. It is not the production inference path.

Policy thresholds still live in the Node engine configuration, never in the playground UI. See moderation.