Quick Start

Get Netleaf running locally in under two minutes.

Prerequisites

Docker — Docker Desktop or Docker Engine with Compose v2+
Git — Any recent version
RAM — 2 GB minimum — 4 GB recommended if you plan to run Ollama locally

Clone & run

bash

git clone https://github.com/Ramcode64/netleaf
cd netleaf
cp apps/api/.env.example apps/api/.env
docker compose up

Docker pulls Postgres, Redis, and the Netleaf image, applies migrations automatically, and starts the API on http://localhost:3000.

Tip: Add -d to run in the background and free up your terminal.

First request

bash

curl -X POST http://localhost:3000/v1/scrape \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "formats": ["markdown"]}'

You should receive a JSON envelope with title and markdown fields.

Local mode

The default config ships with LOCAL_MODE=false (auth enabled). For personal use, set LOCAL_MODE=true in apps/api/.env and restart — no API key needed.

Next steps

Authentication →

Create API keys for production deployments.

Scrape a page →

Full reference for /v1/scrape.

Crawl a site →

Recursively index entire websites.

Guides →

End-to-end tutorials for common workflows.

Introduction Authentication