Installation

Installing from source

Requirements

  • A server with Node.js 10.13 or newer
  • A database (MySQL or Postgresql)

Get the source code and install packages

  1. git clone https://github.com/mikecao/umami.git
  2. cd umami
  3. npm install

Create database tables

Umami supports MySQL and Postgresql. Create a database for your Umami installation and install the tables with the included scripts.

For MySQL:

  1. mysql -u username -p databasename < sql/schema.mysql.sql

For Postgresql:

  1. psql -h hostname -U username -d databasename -f sql/schema.postgresql.sql

This will also create a login account with username admin and password umami.

Configure umami

Create an .env file with the following

  1. DATABASE_URL=(connection url)
  2. HASH_SALT=(any random string)

The connection url is in the following format:

  1. postgresql://username:mypassword@localhost:5432/mydb
  3. mysql://username:mypassword@localhost:3306/mydb

The HASH_SALT is used to generate unique values for your installation.

Build the application

  1. npm run build

Start the application

  1. npm 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

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

  1. docker-compose up

Alternatively, to pull just the Umami Docker image with PostgreSQL support:

  1. docker pull ghcr.io/mikecao/umami:postgresql-latest

Or with MySQL support:

  1. docker pull ghcr.io/mikecao/umami:mysql-latest