README - Umami — ContextQMD

<h1 align="center">Umami</h1> Umami is a simple, fast, privacy-focused alternative to Google Analytics. <a href="https://github.com/umami-software/umami/releases"></a> <a href="https://github.com/umami-software/umami/blob/master/LICENSE"></a> <a href="https://github.com/umami-software/umami/actions"></a> <a href="https://analytics.umami.is/share/LGazGOecbDtaIwDr/umami.is" style="text-decoration: none;"></a>

🚀 Getting Started

A detailed getting started guide can be found at umami.is/docs.

🛠 Installing from Source

Requirements

A server with Node.js version 18.18+.
A PostgreSQL database version v12.14+.

Get the source code and install packages

bash

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

Configure Umami

Create an .env file with the following:

bash

DATABASE_URL=connection-url

The connection URL format:

bash

postgresql://username:mypassword@localhost:5432/mydb

Build the Application

bash

pnpm run build

The build step will 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.

Start the Application

bash

pnpm run start

By 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.

🐳 Installing with Docker

Umami provides Docker images as well as a Docker compose file for easy deployment.

Docker image:

bash

docker pull docker.umami.is/umami-software/umami:latest

Docker compose (Runs Umami with a PostgreSQL database):

bash

docker compose up -d

🔄 Getting Updates

To get the latest features, simply do a pull, install any new dependencies, and rebuild:

bash

git pull
pnpm install
pnpm build

To update the Docker image, simply pull the new images and rebuild:

bash

docker compose pull
docker compose up --force-recreate -d

🛟 Support