Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
Matthias Kretschmann 6f619a8453
Merge branch 'umami-software:master' into master
2023-09-24 01:41:59 +01:00
.github stale-issues add ordering to look at old issues first 2023-08-16 10:52:01 -07:00
.husky Fix build issues. 2021-11-22 14:53:36 -08:00
db Fix CH script. 2023-09-13 13:27:07 -07:00
docker Allow slashes in tracker names. 2023-04-20 01:52:49 -07:00
public Merge branch 'umami-software:master' into master 2023-09-24 01:41:59 +01:00
scripts Fix v1 check error showing in postgres logs 2023-09-06 11:34:12 -07:00
src Merge branch 'umami-software:master' into master 2023-09-24 01:41:59 +01:00
.dockerignore Updated packages. 2023-04-21 14:39:06 -07:00
.eslintrc.json Moved code into src folder. Added build for component library. 2023-08-21 02:06:09 -07:00
.gitignore update ignore. 2023-09-21 16:45:46 -07:00
.prettierignore Updated packages. 2023-04-21 14:39:06 -07:00
.prettierrc.json Initial commit. 2020-07-17 01:03:38 -07:00
.stylelintrc.json Update readme. 2022-04-07 18:15:45 -07:00
Dockerfile Include HOSTNAME variable. 2023-09-02 16:53:26 -07:00
LICENSE Updated packages. 2022-12-26 20:50:55 -08:00 update node.js version in readme for prisma 5.0 2023-08-29 13:02:51 -07:00
app.json Changed HASH_SALT to APP_SECRET. 2022-12-27 21:38:23 -08:00
docker-compose.yml Merge pull request #2027 from theshamuel/patch-2 2023-05-12 18:57:08 -07:00
jsconfig.json Added alias for public folder. 2023-08-22 03:36:49 -07:00
lang-ignore.json Merge pull request #2010 from RohrerF/swiss-german-translations 2023-05-04 14:21:19 -07:00
netlify.toml Adds @netlify/plugin-nextjs package & fixed dashboard link id 2022-10-25 15:01:49 +01:00
next-env.d.ts Updated login form. 2022-11-28 11:14:24 -08:00
next.config.js Refactored useConfig. 2023-08-27 19:56:44 -07:00
package.components.json Fixed login redirect. 2023-09-21 18:37:40 -07:00
package.json Bump version v2.7.0. 2023-09-22 17:24:15 -07:00
postcss.config.js Removed rollup for components. 2023-04-21 13:16:54 -07:00
rollup.components.config.mjs Fixed scripts. 2023-08-25 15:06:47 -07:00
rollup.tracker.config.mjs Moved code into src folder. Added build for component library. 2023-08-21 02:06:09 -07:00
tsconfig.json Fixed tsconfig. 2023-08-23 14:39:38 -07:00
yarn.lock Update redis package. 2023-09-21 16:30:15 -07:00


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

Getting started

A detailed getting started guide can be found at

Installing from source


  • A server with Node.js version 16.13 or newer
  • A database. Umami supports MySQL and Postgresql databases.

Install Yarn

npm install -g yarn

Get the source code and install packages

git clone
cd umami
yarn install

Configure umami

Create an .env file with the following


The connection url is in the following format:



Build the application

yarn build

The build step will also create tables in your database if you ae installing for the first time. It will also create a login user with username admin and password umami.

Start the application

yarn 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

Or with MySQL support:

docker pull

Getting updates

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

git pull
yarn install
yarn build

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

docker compose pull
docker compose up --force-recreate