Skip to main content

Umami Setup Guide

Umami is a simple, privacy-focused analytics alternative to Google Analytics, hosted on the Web Application VM.

Prerequisites​

  • Node.js & Yarn
  • PostgreSQL
  • PM2 (Process Manager)

Installation (Source)​

  1. Clone Repository

    git clone https://github.com/umami-software/umami.git
    cd umami

  2. Install Dependencies

    yarn install

  3. Configure Environment Create a .env file:

    DATABASE_URL=postgresql://<DB_USER>:<DB_PASS>@localhost:5432/umami

  4. Build

    yarn build

  5. Database Migration The app will migrate the database schema on build/start.

Process Management (PM2)​

Umami is kept alive using PM2.

Start​

pm2 start yarn --name umami -- start

Save Process List (Run on Boot)​

pm2 save
pm2 startup

Management​

  • Status: pm2 status
  • Logs: pm2 logs umami
  • Restart: pm2 restart umami

Access​

  • Port: 3000 (Internal)
  • Reverse Proxy: Accessible via analytics.<INTERNAL_DOMAIN> or similar.