umami

(★ 38,305)

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.

File Explorer

Download Latest Version (.zip)

- - 1.bug_report.yml
  - 2.feature_request.yml
  - config.yml
- - cd-cloud.yml
  - cd.yml
  - ci.yml
  - stale-issues.yml
- - schema.sql
- proxy.ts
- env.sample
- install-systemd-user-service
- podman-compose.yml
- README.md
- umami.service
- - migration_lock.toml
- schema.prisma
- android-chrome-192x192.png
- android-chrome-512x512.png
- apple-touch-icon.png
- browserconfig.xml
- datamaps.world.json
- favicon-16x16.png
- favicon-32x32.png
- favicon.ico
- iso-3166-2.json
- mstile-150x150.png
- robots.txt
- safari-pinned-tab.svg
- site.webmanifest
- - index.ts
  - utils.ts
- build-geo.js
- build-prisma-client.js
- bump-components.js
- check-db.js
- check-env.js
- check-missing-messages.js
- download-country-names.js
- download-language-names.js
- postbuild.js
- seed-data.ts
- start-docker.sh
- start-env.js
- telemetry.js
- update-tracker.js
- - global.css
  - layout.tsx
  - not-found.tsx
  - page.tsx
  - Providers.tsx
- - add-user.svg
  - bar-chart.svg
  - bars.svg
  - bolt.svg
  - bookmark.svg
  - change.svg
  - compare.svg
  - dashboard.svg
  - download.svg
  - expand.svg
  - export.svg
  - flag.svg
  - funnel.svg
  - gear.svg
  - lightbulb.svg
  - lightning.svg
  - location.svg
  - lock.svg
  - logo-white.svg
  - logo.svg
  - magnet.svg
  - money.svg
  - network.svg
  - nodes.svg
  - overview.svg
  - path.svg
  - profile.svg
  - pushpin.svg
  - redo.svg
  - reports.svg
  - security.svg
  - speaker.svg
  - switch.svg
  - tag.svg
  - target.svg
  - visitor.svg
  - website.svg
- - icons.ts
  - messages.ts
- - request.ts
- - api-url.test.ts
  - api-url.ts
  - auth.test.ts
  - auth.ts
  - boardComponentCompatibility.test.ts
  - boardComponentCompatibility.ts
  - boards.test.ts
  - boards.ts
  - charts.test.ts
  - charts.ts
  - clickhouse.test.ts
  - clickhouse.ts
  - client.ts
  - colors.test.ts
  - colors.ts
  - constants.ts
  - cors.ts
  - crypto.test.ts
  - crypto.ts
  - csp.ts
  - data.test.ts
  - data.ts
  - date.test.ts
  - date.ts
  - db.test.ts
  - db.ts
  - detect.test.ts
  - detect.ts
  - entity.ts
  - fetch.ts
  - filters.test.ts
  - filters.ts
  - format.test.ts
  - format.ts
  - generate.test.ts
  - generate.ts
  - get-base-url.test.ts
  - get-base-url.ts
  - ip.test.ts
  - ip.ts
  - jwt.test.ts
  - jwt.ts
  - kafka.ts
  - lang.test.ts
  - lang.ts
  - load.ts
  - match-configured-path.test.ts
  - match-configured-path.ts
  - params.test.ts
  - params.ts
  - password.test.ts
  - password.ts
  - prisma.test.ts
  - prisma.ts
  - react.ts
  - recorder.test.ts
  - recorder.ts
  - redis.ts
  - replay.test.ts
  - replay.ts
  - request.ts
  - response.test.ts
  - response.ts
  - schema.test.ts
  - schema.ts
  - session.test.ts
  - share.test.ts
  - share.ts
  - sort.test.ts
  - sort.ts
  - sql.ts
  - storage.ts
  - subscription.test.ts
  - subscription.ts
  - types.ts
  - url.test.ts
  - url.ts
  - utils.test.ts
  - utils.ts
- - board.test.ts
  - board.ts
  - entity.test.ts
  - entity.ts
  - index.ts
  - link.test.ts
  - link.ts
  - pixel.test.ts
  - pixel.ts
  - report.test.ts
  - report.ts
  - share.test.ts
  - share.ts
  - team.test.ts
  - team.ts
  - user.ts
  - website.test.ts
  - website.ts
- - index.js
- - app.test.ts
  - app.ts
  - cache.test.ts
  - cache.ts
  - dashboard.test.ts
  - dashboard.ts
  - version.test.ts
  - version.ts
  - websites.test.ts
  - websites.ts
- - navigation.ts
  - README.md
  - render.tsx
  - setup.ts
  - test-utils.tsx
  - vitest.d.ts
- - index.d.ts
  - index.ts
- - react-zen.d.ts
- declaration.d.ts
- index.ts
- - api-team.spec.ts
  - api-user.spec.ts
  - api-website.spec.ts
  - fixtures.ts
  - helpers.ts
  - login.spec.ts
  - session-modal-dismiss.spec.ts
  - user.spec.ts
  - website.spec.ts
.dockerignore
.gitignore
app.json
biome.json
CONTRIBUTING.md
docker-compose.yml
Dockerfile
LICENSE
netlify.toml
next.config.ts
package.components.json
package.json
playwright.config.ts
pnpm-lock.yaml
pnpm-workspace.yaml
postcss.config.js
prisma.config.ts
README.md
rollup.recorder.config.js
rollup.tracker.config.js
tsconfig.json
tsconfig.prisma.json
tsconfig.tracker.json
tsconfig.tracker.types.json
tsup.config.js
vitest.config.ts

# Installation Guide

1. Get the code

git clone https://github.com/umami-software/umami

Downloads the entire project code from GitHub to your computer.

cd umami

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

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

Type this command into your terminal and run it.

docker compose up -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose pull

Runs the command against the services defined in the compose file.

docker compose up --force-recreate -d

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

pnpm install

Downloads and installs the libraries listed in package.json.

pnpm run build

Builds optimized production files.

pnpm run start

Starts the development/run server.

pnpm build

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

umami

File Explorer

# Installation Guide

2. Docker

3. Node.js

Today's picks

Was this content helpful?

Recent Feedback

umami

File Explorer

# Installation Guide

2. Docker

3. Node.js

Today's picks

Was this content helpful?

Recent Feedback

Download README