Repository files navigation

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

A detailed getting started guide can be found atumami.is/docs.

• A server with Node.js version 18.18 or newer
• A database. Umami supportsMariaDB (minimum v10.5),MySQL (minimum v8.0) andPostgreSQL (minimum v12.14) databases.

npm install -g yarn

git clone https://github.com/umami-software/umami.gitcd umamiyarn install

Create an.env file with the following:

DATABASE_URL=connection-url

The connection URL format:

postgresql://username:mypassword@localhost:5432/mydbmysql://username:mypassword@localhost:3306/mydb

yarn 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 usernameadmin and passwordumami.

yarn start

By default, this will launch the application onhttp://localhost:3000. You will need to eitherproxy requests from your web server or change theport 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 docker.umami.is/umami-software/umami:postgresql-latest

Or with MySQL support:

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

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

git pullyarn installyarn build

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

docker compose pulldocker compose up --force-recreate -d