Umami is a privacy-first analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place — no cookies, no surveillance, self-hosted or in the cloud.
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-urlOptional: set API_URL to change the base URL used by internal UI API calls.
Relative paths are served under BASE_PATH; absolute URLs are proxied through the local /api route.
For example, API_URL=/internal-api or API_URL=https://api.example.com/api.
Optional: set TWO_FACTOR_ENCRYPTION_KEY to a 64-character hex string to enable two-factor
authentication. Generate one with openssl rand -hex 32. Two-factor authentication is unavailable
and cannot be required until this key is set.
MCP is disabled by default. Set MCP_ENABLED=1 to enable the /mcp endpoint, then
authenticate with an API key generated under Settings → API keys.
The connection URL format:
postgresql://username:mypassword@localhost:5432/mydbpnpm run buildThe 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 startBy 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:latestDocker compose (Runs Umami with a PostgreSQL database):
docker compose up -dTo get the latest features, simply do a pull, install any new dependencies, and rebuild:
git pull
pnpm install
pnpm buildTo update the Docker image, simply pull the new images and rebuild:
docker compose pull
docker compose up --force-recreate -d
