Umami is a modern, privacy-focused alternative to Google Analytics. https://umami.is
Find a file
conorbranagan d7642aec11
Extend test data to 60 days for realistic comparisons
When viewing "Last 30 days", the previous 30 days now also has data,
resulting in realistic percentage changes instead of 174233%.
2025-11-28 23:12:16 -05:00
.github New docker workflow. 2025-11-07 22:41:10 -08:00
.husky Card mode for tables. 2025-10-14 13:04:14 -07:00
cypress Add test for updating a website with only shareId 2025-08-19 14:43:42 +00:00
db update CH view to account for new event types 2025-10-02 10:18:13 -07:00
docker Updated lang files. 2025-10-06 12:11:26 -07:00
packages/dials Fix dials HMR by using window-based singleton 2025-11-26 11:46:02 -05:00
podman Fixed typo in README.md 2025-04-17 19:08:25 +02:00
prisma Merge remote-tracking branch 'origin/dev' into dev 2025-09-10 17:16:15 -07:00
public Updated lang files. 2025-10-06 12:11:26 -07:00
scripts Extend test data to 60 days for realistic comparisons 2025-11-28 23:12:16 -05:00
src Add Niteshift Dials SDK for runtime design prototyping 2025-11-26 11:46:02 -05:00
.dockerignore Fixed docker build. 2025-10-06 02:12:57 -07:00
.eslintignore Removed mysql schema. 2025-05-09 22:06:39 -07:00
.eslintrc.json Redesigned overview page. 2025-08-21 03:01:37 -07:00
.gitignore chore [#3699] : fix .gitignore syntax and untrack package-lock.json 2025-11-08 22:33:22 +01:00
.prettierignore Removed mysql schema. 2025-05-09 22:06:39 -07:00
.prettierrc.json
.stylelintrc.json Updated filter bar. 2025-04-02 23:18:03 -05:00
.umami-prebake-applied feat: specify pnpm package manager version 2025-11-13 22:49:20 +00:00
app.json Changed HASH_SALT to APP_SECRET. 2022-12-27 21:38:23 -08:00
CLAUDE.md Add Niteshift Dials SDK for runtime design prototyping 2025-11-26 11:46:02 -05:00
cypress.config.ts add api-testing to cypress tests 2025-03-12 10:32:54 -07:00
docker-compose.yml Updated image tag. 2025-11-06 23:58:12 -08:00
Dockerfile Updated Dockerfile to match current Prisma version. 2025-11-03 16:54:58 -08:00
jest.config.ts Fix test. 2025-03-31 22:49:34 -05:00
LICENSE Updated packages. 2022-12-26 20:50:55 -08:00
netlify.toml Adds @netlify/plugin-nextjs package & fixed dashboard link id 2022-10-25 15:01:49 +01:00
next-env.d.ts Redesigned overview page. 2025-08-21 03:01:37 -07:00
next.config.ts Add DISABLE_AUTH env var 2025-11-14 10:37:03 -05:00
niteshift-setup.sh Add prebake sync sentinel for resume fast path 2025-11-24 15:39:37 -05:00
package.components.json Responsive everything. 2025-10-16 02:42:13 -07:00
package.json Update test data generator for Hulu demo 2025-11-27 23:03:38 -05:00
pnpm-lock.yaml Add Niteshift Dials SDK for runtime design prototyping 2025-11-26 11:46:02 -05:00
pnpm-workspace.yaml Replaced __dirname usage. 2025-04-29 09:53:11 -07:00
postcss.config.js Switched to type: module. 2025-04-29 14:36:52 -07:00
README.md Apply suggestions from code review 2025-11-07 10:14:55 +01:00
rollup.tracker.config.js Switched to type: module. 2025-04-29 14:36:52 -07:00
tsconfig.json Converted UTM report to a view. 2025-05-20 21:25:06 -07:00
tsconfig.prisma.json Fixed outputs. 2025-09-01 16:17:55 -07:00
tsup.config.js Export metrics components. 2025-09-03 17:16:03 -07:00

Umami Logo

Umami

Umami is a simple, fast, privacy-focused alternative to Google Analytics.

GitHub Release MIT License Build Status Umami Demo


🚀 Getting Started

A detailed getting started guide can be found at umami.is/docs.


🛠 Installing from Source

Requirements

  • A server with Node.js version 18.18 or newer
  • A database. Umami supports PostgreSQL (minimum v12.14) databases.

Get the Source Code and Install Packages

git clone https://github.com/umami-software/umami.git
cd umami
pnpm install

Configure Umami

Create an .env file with the following:

DATABASE_URL=connection-url

The connection URL format:

postgresql://username:mypassword@localhost:5432/mydb

Build the Application

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.

Start the Application

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.


🐳 Installing with Docker

To build the Umami container and start up a Postgres database, run:

docker compose up -d

Alternatively, to pull just the Umami Docker image with PostgreSQL support:

docker pull docker.umami.is/umami-software/umami:latest

🔄 Getting Updates

Warning

If you are updating from Umami V2, image "postgresql-latest" is deprecated. You must change it to "latest". e.g., rename docker.umami.is/umami-software/umami:postgresql-latest to docker.umami.is/umami-software/umami:latest.

To get the latest features, simply do a pull, install any new dependencies, and rebuild:

git pull
pnpm install
pnpm run build

To update the Docker image, simply pull the new images and rebuild:

docker compose pull
docker compose up --force-recreate -d

🛟 Support

GitHub Twitter LinkedIn Discord