Umami is a modern, privacy-focused alternative to Google Analytics. https://umami.is
Find a file
Mike Cao 68c56060b3 Add board state management with updateBoard and saveBoard methods.
BoardProvider now manages local board state and exposes updateBoard for
editing and saveBoard for persisting to the database. Supports both
create and edit modes with proper redirect after creation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-16 21:05:43 -08:00
.github Merge pull request #3910 from kkhys/fix/ja-jp-breakdown 2025-12-20 21:39:29 -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 Reformatted files with biome. 2025-11-22 22:42:42 -08:00
podman Fixed typo in README.md 2025-04-17 19:08:25 +02:00
prisma Board setup. 2026-01-16 19:52:16 -08:00
public Merge pull request #3884 from XahidEx/patch-2 2026-01-06 17:48:29 -08:00
scripts Merge branch 'dev' into boards 2025-12-04 00:53:54 -08:00
src Add board state management with updateBoard and saveBoard methods. 2026-01-16 21:05:43 -08:00
.dockerignore chore: exclude seed scripts from Docker builds 2025-12-02 20:25:25 +03:00
.gitignore Board setup. 2026-01-16 19:52:16 -08:00
.stylelintrc.json Updated filter bar. 2025-04-02 23:18:03 -05:00
app.json Changed HASH_SALT to APP_SECRET. 2022-12-27 21:38:23 -08:00
biome.json Bump version 3.0.2. 2025-12-03 23:01:22 -08:00
CLAUDE.md Board setup. 2026-01-16 19:52:16 -08:00
cypress.config.ts add api-testing to cypress tests 2025-03-12 10:32:54 -07:00
docker-compose.yml Added check for REDIS_URL. Closes #3677. 2025-11-10 21:08:55 -08:00
Dockerfile Fixed Docker build. 2025-12-03 23:53:22 -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 feat: Add default currency support and update currency handling in Revenue component 2025-12-25 20:41:14 +05:30
package.components.json Responsive everything. 2025-10-16 02:42:13 -07:00
package.json Add board state management with updateBoard and saveBoard methods. 2026-01-16 21:05:43 -08:00
pnpm-lock.yaml Add board state management with updateBoard and saveBoard methods. 2026-01-16 21:05:43 -08: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
prisma.config.ts Updated prisma. 2025-11-21 21:35:11 -08:00
README.md Fix formatting for Docker compose instructions 2025-12-04 00:37:13 -08: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+.
  • A PostgreSQL database version v12.14+.

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

Umami provides Docker images as well as a Docker compose file for easy deployment.

Docker image:

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

Docker compose (Runs Umami with a PostgreSQL database):

docker compose up -d

🔄 Getting Updates

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

git pull
pnpm install
pnpm 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