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

A detailed getting started guide can be found at https://umami.is/docs/

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

npm install -g yarn

git clone https://github.com/umami-software/umami.git
cd umami
yarn install

Create an .env file with the following

DATABASE_URL=connection-url

The connection url is in the following format:

postgresql:https://username:mypassword@localhost:5432/mydb

mysql:https://username:mypassword@localhost:3306/mydb

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.

yarn start

By default this will launch the application on https://localhost:3000. You will need to either proxy requests from your web server or change the port to serve the application directly.

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 ghcr.io/umami-software/umami:postgresql-latest

Or with MySQL support:

docker pull ghcr.io/umami-software/umami:mysql-latest

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

MIT