Portainer Templates logo

Portainer Templates

Umami.is Umami.is

Stack

Analytics

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

Configuration

Type
Compose
Platform
linux
Ports
3000:3000/tcp
Source
Repo

Template by xneo1·Source

Services

umami

Configuration

Image
ghcr.io/umami-software/umami:postgresql-latest
Ports
3003:3000
Env vars
DATABASE_URL=postgresql://umami:umami@db:5432/umamiDATABASE_TYPE=postgresqlHASH_SALT=replace-me-with-a-random-string
Restart
always

Image details

User: umami-software

db

Configuration

Image
postgres:15-alpine
Volumes
/docker-entrypoint-initdb.d/schema.postgresql.sql : /portainer/Files/AppData/Config/umami/var/lib/postgresql/data : umami-db-data
Env vars
POSTGRES_DB=umamiPOSTGRES_USER=umamiPOSTGRES_PASSWORD=umami
Restart
always

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 hour ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Umami.is

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Umami.is, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  umami:
    image: ghcr.io/umami-software/umami:postgresql-latest
    ports:
      - "3003:3000"
    environment:
      DATABASE_URL: postgresql://umami:umami@db:5432/umami
      DATABASE_TYPE: postgresql
      HASH_SALT: replace-me-with-a-random-string
    depends_on:
      - db
    restart: always
  db:
    image: postgres:15-alpine
    environment:
      POSTGRES_DB: umami
      POSTGRES_USER: umami
      POSTGRES_PASSWORD: umami
    volumes:
      - /portainer/Files/AppData/Config/umami:/docker-entrypoint-initdb.d/schema.postgresql.sql:ro
      - umami-db-data:/var/lib/postgresql/data
    restart: always
volumes:
  umami-db-data:

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/umami.yml up -d

More install options in our documentation.

Container Documentation

db Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

Serve Umami.is on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying umami-is.example.com to http://umami:3000

Add this to your Caddyfile

umami-is.example.com {
	reverse_proxy http://umami:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3003 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3003
  • Stop the other service, or pick a different host port. In 3003:3000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3003. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, umami can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3003

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/umami

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/umami-software/umami:postgresql-latest

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Umami.is is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • umami runs ghcr.io/umami-software/umami:postgresql-latest, starts after db
  • db runs postgres:15-alpine

Ports

A port is the door the app answers on. A mapping like 3003:3000 means it's reachable on port 3003 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3003 in a browser. It opens:

  • 3003:3000, likely the web interface

Volumes

A volume is where Umami.is keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /docker-entrypoint-initdb.d/schema.postgresql.sql from /portainer/Files/AppData/Config/umami on the host
  • /var/lib/postgresql/data kept in the umami-db-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Umami.is takes 6 of them, all with defaults you can leave alone or tweak:

  • DATABASE_URL, defaults to postgresql://umami:umami@db:5432/umami
  • DATABASE_TYPE, defaults to postgresql
  • HASH_SALT, defaults to replace-me-with-a-random-string
  • POSTGRES_DB, defaults to umami
  • POSTGRES_USER, defaults to umami
  • POSTGRES_PASSWORD, defaults to umami

Restart policy

The restart policy here is always, so Docker brings Umami.is back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like umami) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Umami.is up. Add the template list to Portainer once, then deploying Umami.is is a click rather than a wall of config.