Skip to content
/ umami Public
forked from umami-software/umami

Umami is a simple, fast, privacy-focused alternative to Google Analytics.

License

Notifications You must be signed in to change notification settings

Contrum/umami

This branch is 416 commits behind umami-software/umami:master.

Folders and files

NameName
Last commit message
Last commit date
Mar 1, 2024
Nov 22, 2021
Mar 6, 2024
Apr 9, 2024
Apr 20, 2023
Jun 20, 2024
Apr 17, 2024
Jun 27, 2024
Apr 21, 2023
Mar 1, 2024
Mar 22, 2024
Apr 21, 2023
Jul 17, 2020
Mar 1, 2024
Nov 27, 2023
Dec 27, 2022
May 27, 2024
Dec 28, 2022
Mar 6, 2024
Nov 27, 2023
Mar 1, 2024
Dec 14, 2023
Feb 5, 2024
Oct 25, 2022
Sep 30, 2023
Jun 24, 2024
May 4, 2024
Jun 25, 2024
Jan 18, 2023
Oct 4, 2023
Mar 18, 2024
Mar 1, 2024
Jun 17, 2024

Repository files navigation

Umami Logo

Umami

Umami is a simple, fast, privacy-focused alternative to Google Analytics.

GitHub Release MIT License Build Status Umami Demo


πŸš€ Getting Started

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


πŸ›  Installing from Source

Requirements

  • A server with Node.js version 16.13 or newer
  • A database. Umami supports MySQL (minimum v8.0) and PostgreSQL (minimum v12.14) databases.

Install Yarn

npm install -g yarn

Get the Source Code and Install Packages

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

Configure Umami

Create an .env file with the following:

DATABASE_URL=connection-url

The connection URL format:

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

Build the Application

yarn 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

yarn 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:

docker compose up -d

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

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

Or with MySQL support:

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

πŸ”„ Getting Updates

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

git pull
yarn install
yarn build

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

docker compose pull
docker compose up --force-recreate

πŸ›Ÿ Support

GitHub Twitter LinkedIn Discord

About

Umami is a simple, fast, privacy-focused alternative to Google Analytics.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 90.0%
  • CSS 5.9%
  • JavaScript 3.9%
  • Other 0.2%