Skip to main content

Documentation Index

Fetch the complete documentation index at: https://revlytics.co/docs/llms.txt

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

​
Why self-host?

  • Full data ownership — All analytics data stays on your servers
  • Privacy compliance — Meet strict data residency requirements
  • No limits — No event caps or feature restrictions
  • Customization — Modify the codebase to fit your needs

​
Requirements

ComponentMinimumRecommended
CPU2 cores4+ cores
RAM4 GB8+ GB
Storage20 GB50+ GB SSD
Node.js18+20+
Docker20+Latest

​
Architecture

A self-hosted Revlytics instance requires:
  1. Next.js app — The dashboard and API server
  2. ClickHouse — Analytics event storage (high-speed columnar DB)
  3. Supabase — Authentication and configuration storage (or self-hosted PostgreSQL)
  4. Redis — Optional, for caching and rate limiting

​
Quick start

# Clone the repository
git clone https://github.com/revlytics/revlytics.git
cd revlytics

# Start ClickHouse and Redis
docker compose up -d

# Install dependencies
npm install

# Copy environment variables
cp env.example .env

# Run database migrations
# Apply schema/clickhouse.sql to your ClickHouse instance
# Apply schema/postgresql.sql to your Supabase/PostgreSQL instance

# Start the dev server
npm run dev
See Docker deployment for production setup and Environment Variables for configuration.