Oblive Docs
Getting Started

Getting Started

The shortest supported path from a fresh checkout to a working local Oblive organization.

This guide gets the complete local stack running. It does not yet describe a production or managed cloud deployment.

The Path

Check the host

Install Bun and Docker with Compose. Choose either a local Codex login or an OpenAI API key.

Create local configuration

Copy the tracked example to the ignored machine-local configuration file and replace every placeholder secret.

Generate and inspect

Generate runtime environment files from the JSON source of truth, then inspect the resolved Compose configuration.

Start and verify

Start infrastructure, migrations, backend, frontend, chat, and workers. Verify health before creating an organization.

Quick Start

bun install
cp config/local-stack.example.json config/local-stack.json
bun run stack env
bun run stack config
bun run stack up

Open http://127.0.0.1:3001 after the frontend reports healthy.

Do not use the placeholder secrets from the tracked example. Keep real local credentials only in config/local-stack.json, which is ignored by Git.

Continue