Installation

There are several different ways to install Umami.

• Installing from source: Get the code from GitHub and build the application yourself.
• Using Docker compose: Build your own Docker container using docker compose.
• Using a Docker image: Download a pre-built Docker image.
• Using Kubernetes with HelmForge: Deploy Umami with a third-party Helm chart maintained by the HelmForge project. See the Running on Kubernetes with HelmForge guide.

Installing from source#

Requirements#

• A server with Node.js version 18.18 or newer.
• A database. Umami supports PostgreSQL (minimum v12.14) databases.

Install pnpm#

npm install -g pnpm

Get the source code and install packages#

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

Configure Umami#

Create an .env file with the following

DATABASE_URL={connection url}

The connection url is in the following format:

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

Build the application#

pnpm build

The first time the build is run, it will create all the required database tables in your database. It will also create a login account with username admin and password umami.

Start the application#

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

Running Umami#

You can simply run pnpm start to start Umami, but it's highly recommended you use a process manager like PM2 which will handle restarts for you.

To run with PM2:

pnpm add -g pm2
cd umami
pm2 start "pnpm start" --name umami
pm2 startup
pm2 save

Installing with Docker#

Umami ships with a docker compose file that contains the application and a PostgreSQL database.

To build the Docker container and start up with a Postgres database, run:

docker compose up -d

This will create a PostgreSQL database and start the Umami application on http://localhost:3000. The default login credentials are username admin and password umami.

Alternatively, if you want to use prebuilt images, you can pull the Umami Docker image with PostgreSQL support:

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

When using a prebuilt image, you need to provide your own database and set the DATABASE_URL environment variable. See Environment variables for configuration options.