umami-software /umami
Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.
★ 40,160⑂ 8,552👁 135⑃ 1,599● 2,336▤ 113
+15
Daily
+154
Weekly
40,160
stars
8,552
forks
135
watchers
1,599
prs
2,336
issues
113
releases
README
Umami Umami is an open-source web and product analytics platform. Understand acquisition, behavior, conversion, and retention with privacy-first analytics — no cookies, self-hosted or in the cloud. --- 🚀 Getting Started A detailed getting started guide can be found at umami.is/docs. --- 🛠 Installing from Source Requirements - A server with Node.js version 20.19+ (22 LTS recommended). - A PostgreSQL database version v12.14+. Get the source code and install packages bash git clone https://github.com/umami-software/umami.git cd umami pnpm install Configure Umami Create an .env file with the following: bash DATABASE_URL=connection-url APP_SECRET=random-string generate with: openssl rand -hex 32 The connection URL format: bash postgresql://username:mypassword@localhost:5432/mydb Build the Application bash pnpm run build The build step will create tables in your database if you are installing for the first time. It will also create a login user with username admin and password umami. You will be required to change this password after signing in. Start the Application bash pnpm run start By default, this will launch the application on http://localhost:3000. You will need to either proxy requests from your web server or change the port to serve the application directly. To bind to the HOSTNAME and PORT set in your .env file, start with pnpm run start:env instead. --- 🐳 Installing with Docker Umami provides Docker images as well as a Docker compose file for easy deployment. Docker image: bash docker pull docker.umami.is/umami-software/umami:latest Docker compose (Runs Umami with a PostgreSQL database): bash docker compose up -d --- 🔄 Getting Updates To get the latest features, simply do a pull, install any new dependencies, and rebuild: bash git pull pnpm install pnpm build To update the Docker image, simply pull the new images and rebuild: bash docker compose pull docker compose up --force-recreate -d --- 🛟 Support [release-shield]: https://img.shields.io/github/release/umami-software/umami.svg [releases-url]: https://github.com/umami-software/umami/releases [license-shield]: https://img.shields.io/github/license/umami-software/umami.svg [license-url]: https://github.com/umami-software/umami/blob/master/LICENSE [build-shield]: https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml [build-url]: https://github.com/umami-software/umami/actions [github-shield]: https://img.shields.io/badge/GitHub--blue?style=social&logo=github [github-url]: https://github.com/umami-software/umami [twitter-shield]: https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter [twitter-url]: https://twitter.com/umami_software [linkedin-shield]: https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin [linkedin-url]: https://linkedin.com/company/umami-software [discord-shield]: https://img.shields.io/badge/Discord--blue?style=social&logo=d
Top issues
#3163External auth/OIDC31 comments · 2025-01-07#3518Accurate Bounce & Time-on-Site Metrics for Long Single-Page Visits (Heartbeat & Engagement Events Support)7 comments · 2025-07-19#3267Umami breaks client side navigation when paired with anchors. Forces full page reload.6 comments · 2025-02-23#4448Duplicate visitor/session entries when country is Singapore5 comments · 2026-08-13#4368The heatmap is very inaccurate5 comments · 2026-06-30#4233Feature request: Saving filters for a board5 comments · 2026-05-04#3120Allow API to set browser, os, device, country, etc.4 comments · 2024-12-18#4684[Feature Request] Optional WebSocket transport for event collection (self-hosted)3 comments · 2026-10-25
Discussions
#4761v3.5.01 comments · 2026-11-12#4754Zero analytics by default: an env-gated Umami Cloud script in a client-only Next.js app0 comments · 2026-11-10#4751Self hosted v3.4.1: Umami in the site's existing Postgres, and tracker paths served through the site's own domain?1 comments · 2026-11-09#4728Website is down.0 comments · 2026-11-02#4693Proposal: a Zapier integration for Umami0 comments · 2026-10-26#4689Session replays: filter by rage clicks and dead clicks0 comments · 2026-10-25#4642Hash routing + Heatmaps + Performance metrics1 comments · 2026-10-19#4641Best way to tell subdomains apart in one website?1 comments · 2026-10-19
Latest release
v3.5.0 v3.5.0 2026-11-12Umami v3.5.0 adds browser error tracking, improved replay navigation, and fixes across tracking, reporting, and sharing. New features Browser error tracking Capture JavaScript errors alongside your analytics and investigate affected visits. - Automatically capture uncaught exceptions and unhandled promise rejections with data-errors="true" - Capture handled errors with umami.captureException() - Group errors into issues with stack traces, occurrence counts, and session details - Resolve, ignore, and reopen issues - Search and filter by release, environment, browser, and page