Oblive Docs
Getting Started

Install Oblive

Configure, generate, inspect, and start the supported local Docker stack.

1. Install Repository Dependencies

From the repository root:

bun install

2. Create the Machine-Local Configuration

cp config/local-stack.example.json config/local-stack.json

Edit config/local-stack.json. At minimum, replace the placeholder PostgreSQL password, Garage credentials, agent service token, and integration credential key. Configure Google OAuth only if you intend to connect Google Workspace.

local-stack.json is the canonical local input. Do not hand-edit generated .env files.

3. Generate Runtime Environment Files

bun run stack env

The generator validates the JSON and writes complete ignored environment files for host-run and container-run services. It writes files only when their contents change, preventing unnecessary development-server restarts.

4. Inspect the Resolved Stack

bun run stack config

Check the resolved ports, image/build mode, worker replica count, volume lifecycle, and service URLs. This command is read-only and should not regenerate files.

5. Start Oblive

bun run stack up

The startup order is intentional:

  1. PostgreSQL, Redis, and Garage become healthy.
  2. Database migrations run once and complete.
  3. The backend and frontend start.
  4. Chat and task-worker runtimes start against the healthy backend.

6. Open the Product

Visit http://127.0.0.1:3001 unless you changed the frontend port.

If the browser opens before migrations or the backend are healthy, wait for bun run stack ps to report healthy services rather than repeatedly restarting the stack.

Expected Result

The frontend loads, http://127.0.0.1:3000/health returns a successful response, and no required service is in a restart loop.

Next

Verify and Maintain, then Onboard Your Business.