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://username:mypassword@localhost:5432/mydb
mysql://username:mypassword@localhost:3306/mydb
yarn buildThe build step will also 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.
yarn 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.
To build the umami container and start up a Postgres database, run:
docker compose up -dAlternatively, to pull just the Umami Docker image with PostgreSQL support:
docker pull ghcr.io/umami-software/umami:postgresql-latestOr with MySQL support:
docker pull ghcr.io/umami-software/umami:mysql-latestTo get the latest features, simply do a pull, install any new dependencies, and rebuild:
git pull
yarn install
yarn buildTo update the Docker image, simply pull the new images and rebuild:
docker compose pull
docker compose up --force-recreateMIT