Files
cloudinit-bot 76822fb1bb feat(scripts): quickstart.sh + docs/quickstart.md — 15-min green-field spin-up (REQ-INB-40)
---ci---
project: inboxos
phase: 1
milestone: v1.4
status: execute
wave: 2
task: T1
---/ci---
2026-06-09 14:14:31 +00:00

894 B

InboxOS Quickstart

A 15-minute green-field operator spin-up.

Steps

  1. Run scripts/quickstart.sh from the inboxos repo root.
  2. The script will:
    • Verify docker + docker compose are installed
    • Pull the inboxos Docker images
    • Generate .env from .env.example (edit with your secrets)
    • Bring up the stack (docker compose up -d)
    • Wait for NocoDB healthcheck
    • Run scripts/apply_schemas.py to bootstrap the 4 module tables + papra_index
    • Seed a 1-test .mbox and run pipelines/historical_pipeline.py to verify the extract path
  3. On success, login to NocoDB at http://localhost:8080.

Next

For a 30-minute end-to-end walkthrough, see docs/operator-tutorial.md (REQ-INB-53).

For the per-step details, see docs/operations-runbook.md §3 (Workflow operations).

For failure recovery, see the runbook §5 + the ERROR-NN catalog (REQ-INB-46).