Supermetry documentation

Supermetry documentation covers setup, tracking, reports, integrations and operating your instance.

Start quickly

For Docker Compose, clone the repository and start the services:

cp .env.example .env
cd deploy
docker compose up -d --build

The Compose setup serves Supermetry on port 8787. Review the environment file before exposing the service.

Browse by task

Getting started

Choose a deployment and get your first site sending pageviews.

• Cloud
• Docker Compose
• Add your first website

Self-hosting

Configure the database, service and operational settings.

• PostgreSQL
• Environment variables
• Backup and restore

Tracking

Install the tracker and control what browser activity it records.

• Install the tracker
• Track events
• Privacy signals

Dashboard

Read traffic reports and explore events, sessions and trends.

• Dashboard overview
• Filters and segments
• Funnels

Team and sharing

Manage team access and share reports with others.

• Teams and roles
• Share links
• Alerts

API

Read analytics data or send events through the public API.

• API overview
• Stats API
• Events API

Migrating

Bring aggregate history from supported analytics exports.

• Migration overview
• From Plausible
• From Umami

Reference

Look up commands, metric definitions and common questions.

• CLI commands
• Metric definitions
• FAQ