{
  "schema_version": 1,
  "generated_at": "2026-10-22T00:00:00.000Z",
  "canonical_url": "https://openlogs.fyi/tools/umami",
  "slug": "umami",
  "name": "Umami",
  "tagline": "Web analytics without cookies, stored in a Postgres database that you run.",
  "replaces": {
    "summary": "Hosted web analytics, such as Google Analytics.",
    "products": [
      {
        "slug": "google-analytics",
        "name": "Google Analytics",
        "vendor": "Google",
        "url": "https://openlogs.fyi/alternatives/google-analytics"
      }
    ]
  },
  "stack": [
    {
      "kind": "runtime",
      "name": "Node.js"
    },
    {
      "kind": "framework",
      "name": "Next.js"
    },
    {
      "kind": "database",
      "name": "PostgreSQL"
    }
  ],
  "deployment_methods": [
    "docker_compose",
    "docker",
    "manual"
  ],
  "requirements": {
    "min_ram_mb": null,
    "min_cpu_cores": null,
    "source_url": null
  },
  "license": {
    "spdx": "MIT",
    "class": "osi",
    "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/LICENSE"
  },
  "business_model": {
    "value": "unknown",
    "notes": "The README says Umami runs self-hosted or in the cloud. We did not check what the cloud plan adds, so the business model stays unknown.",
    "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/README.md",
    "checked_at": "2026-10-21"
  },
  "difficulty": {
    "value": "medium",
    "reason": "Two services: the app and a Postgres database in a named volume that you back up. You must replace the placeholder secrets before the first start."
  },
  "repository": {
    "owner": "umami-software",
    "name": "umami",
    "url": "https://github.com/umami-software/umami"
  },
  "compose_check": {
    "status": "config_ok",
    "validated_at": "2026-10-21",
    "summary": "config_ok on 2026-10-21"
  },
  "recipe": {
    "version": 1,
    "source_path": "docker-compose.yml",
    "source_repo": "umami-software/umami",
    "source_commit_sha": "e92fdab99508a8ed05249f6c5f07e140deab79e1",
    "source_kind": "app_repo",
    "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/docker-compose.yml"
  },
  "install_steps": [
    {
      "order": 1,
      "kind": "prerequisite",
      "language": "text",
      "label": "Docker with the Compose plugin",
      "body": "A host with Docker and the Docker Compose plugin. The compose file starts its own PostgreSQL container.",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/README.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 2,
      "kind": "compose",
      "language": "yaml",
      "label": "Save the compose file as docker-compose.yml",
      "body": "---\nservices:\n  umami:\n    image: ghcr.io/umami-software/umami:latest\n    ports:\n      - \"3000:3000\"\n    environment:\n      DATABASE_URL: postgresql://umami:umami@db:5432/umami\n      APP_SECRET: replace-me-with-a-random-string\n      # Required for two-factor authentication, generate with: openssl rand -hex 32\n      TWO_FACTOR_ENCRYPTION_KEY: replace-me-with-a-64-character-hex-string\n    depends_on:\n      db:\n        condition: service_healthy\n    init: true\n    restart: always\n    healthcheck:\n      test: [\"CMD-SHELL\", \"curl http://localhost:3000/api/heartbeat\"]\n      interval: 5s\n      timeout: 5s\n      retries: 5\n  db:\n    image: postgres:15-alpine\n    environment:\n      POSTGRES_DB: umami\n      POSTGRES_USER: umami\n      POSTGRES_PASSWORD: umami\n    volumes:\n      - umami-db-data:/var/lib/postgresql/data\n    restart: always\n    healthcheck:\n      test: [\"CMD-SHELL\", \"pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}\"]\n      interval: 5s\n      timeout: 5s\n      retries: 5\nvolumes:\n  umami-db-data:\n",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/docker-compose.yml",
      "validation_status": "config_ok"
    },
    {
      "order": 3,
      "kind": "env",
      "language": "text",
      "label": "Set the two secrets in the file",
      "body": "The compose file has two placeholder values: APP_SECRET (a random string) and TWO_FACTOR_ENCRYPTION_KEY (64 hex characters; the file says to generate it with: openssl rand -hex 32). Replace both before the first start.",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/docker-compose.yml",
      "validation_status": "unvalidated"
    },
    {
      "order": 4,
      "kind": "shell",
      "language": "bash",
      "label": "Start it",
      "body": "docker compose up -d",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/README.md",
      "validation_status": "unvalidated"
    },
    {
      "order": 5,
      "kind": "verify",
      "language": "text",
      "label": "Check that it answers",
      "body": "Open http://localhost:3000. The compose file health check calls http://localhost:3000/api/heartbeat inside the container.",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/docker-compose.yml",
      "validation_status": "unvalidated"
    }
  ],
  "notes": [
    {
      "kind": "gotcha",
      "title": "The compose file has placeholder secrets and a weak database password",
      "body": "APP_SECRET and TWO_FACTOR_ENCRYPTION_KEY are placeholders (\"replace-me...\"). The database user and password in the file are both \"umami\".",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/docker-compose.yml",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "gotcha",
      "title": "The image tag is latest",
      "body": "The compose file uses ghcr.io/umami-software/umami:latest, so a pull can move to a new version without notice.",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/docker-compose.yml",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "gotcha",
      "title": "Default login from the README",
      "body": "The README says the first build creates a login user named admin with the password umami.",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/README.md",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "upgrade",
      "title": "Upgrade the Docker install",
      "body": "The README gives these steps: docker compose pull, then docker compose up --force-recreate -d.",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/README.md",
      "checked_at": "2026-10-21"
    },
    {
      "kind": "requirement",
      "title": "Versions for a non-Docker install",
      "body": "The README lists Node.js 18.18 or newer and PostgreSQL 12.14 or newer.",
      "source_url": "https://github.com/umami-software/umami/blob/e92fdab99508a8ed05249f6c5f07e140deab79e1/README.md",
      "checked_at": "2026-10-21"
    }
  ],
  "signals": {
    "captured_at": "2026-10-21",
    "stars": 39494,
    "forks": 8359,
    "open_issues": 121,
    "last_push": "2026-10-20",
    "days_since_push": 1,
    "latest_release": "v3.4.0",
    "latest_release_date": "2026-09-17",
    "days_since_release": 34
  },
  "links": {
    "html": "https://openlogs.fyi/tools/umami",
    "markdown": "https://openlogs.fyi/tools/umami.md",
    "json": "https://openlogs.fyi/tools/umami.json"
  },
  "updated_at": "2026-10-22"
}