Skip to main content

Umami 1

Umami is a simple, easy to use, self-hosted web analytics solution. The goal is to provide you with a friendlier, privacy-focused alternative to Google Analytics and a free, open-sourced alternative to paid solutions. 2

To get started with Umami, read the docker-compose.yml.

It states the following:

  • Umami has a Docker image at ghcr.io/mikecao/umami:postgresql-latest
  • It listens on port 3000
  • It depends on PostgreSQL
  • It reads the PostgreSQL config from DATABASE_URL
  • It requires the env variables DATABASE_URL, DATABASE_TYPE and HASH_SALT

Preparing dokku and the image​

Prerequirements

The following Dokku plugins are required

dokku apps:create umami

# create and link postgres db
dokku postgres:create umami
dokku postgres:link umami umami

# connect to your db
dokku postgres:connect umami
# in postgres, create extension for uuid generation
CREATE EXTENSION pgcrypto;
# ensure it works:
SELECT gen_random_uuid();
# exit
exit

# set env variables
dokku config:set umami HASH_SALT=$(openssl rand -hex 32)
dokku config:set umami DATABASE_TYPE=postgresql

# set port mapping
dokku proxy:ports-remove umami http:80:5000
dokku proxy:ports-add umami http:80:3000

# add a domain
dokku domains:add umami umami.lebalz.ch

# optional: disable umami telemetry
dokku config:set --no-restart umami DISABLE_TELEMETRY=1

# optional: set email for letsencrypt
dokku config:set --no-restart umami DOKKU_LETSENCRYPT_EMAIL=foo@bar.ch

# optional: set custom script name. Default is umami (might be known by ad blockers)
dokku config:set --no-restart umami TRACKER_SCRIPT_NAME=myumami

# optional: set custom collect api endpoint (default: /api/collect)
dokku config:set --no-restart umami COLLECT_API_ENDPOINT="/api/tellme"
Notes
  • The environment variable DATABASE_URL must not be set manually since it was automatically set when linking the database to the application.

Deploy the image​

dokku git:from-image umami docker.umami.is/umami-software/umami:postgresql-latest

# optional: letsencrypt
dokku letsencrypt umami

The default username is admin and the default password is umami.

Updating​

# pull the latest image
docker pull docker.umami.dev/umami-software/umami:postgresql-latest

# rebuild umami
dokku ps:rebuild umami

Upgrading to v1.39​

Umami uses now the command gen_random_uuid() from the extension pgcrypto. This extension is normally not active. It must be first activated:

# connect to your db
dokku postgres:connect umami
# in postgres, create extension for uuid generation
CREATE EXTENSION pgcrypto;
# ensure it works:
SELECT gen_random_uuid();
# exit
exit

Upgrading from < v1.31​

dokku ps:stop umami
dokku git:from-image umami docker.umami.dev/umami-software/umami:postgresql-latest

Troubleshooting​

  • Debug proxy mapping: dokku nginx:error-logs umami -t

Footnotes​

  1. Reference: knowledge.code-fabrik.ch ↩

  2. Reference: Umami ↩