Umami is a simple, fast, privacy-focused alternative to Google Analytics.
GitHub Release MIT License Build Status Umami Demo
A detailed getting started guide can be found at umami.is/docs.
- A server with Node.js version 18.18+.
- A PostgreSQL database version v12.14+.
git clone https://github.com/umami-software/umami.git
cd umami
pnpm installCreate an .env file with the following:
DATABASE_URL=connection-url
The connection URL format:
postgresql://username:mypassword@localhost:5432/mydb
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.
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.
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
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