Skip to main content

Documentation Index

Fetch the complete documentation index at: https://onlook.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

OnlookAI is designed to be self-hosted. The ingest layer, scoring engine, and dashboard are all open source and can run on any Linux server or container platform.

​
Requirements

  • Node.js 20+
  • PostgreSQL 15+ (or any compatible database)
  • 512MB RAM minimum

​
Clone and run

git clone https://github.com/onlookai/onlook
cd onlook
pnpm install
pnpm dev
The ingest endpoint starts at localhost:4000 and the dashboard at localhost:4001.

​
Configuration

Create a .env file at the repo root: 
DATABASE_URL=postgresql://user:password@localhost:5432/onlook
INGEST_PORT=4000
DASHBOARD_PORT=4001
SIGNING_SECRET=your-secret-here

​
Docker

docker compose up
The docker-compose.yml at the repo root starts Postgres, the ingest service, and the dashboard in one command.