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

tabdeck/umami

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

Folders and files

NameName
Last commit message
Last commit date
Aug 16, 2023
Nov 22, 2021
Sep 13, 2023
Apr 20, 2023
Sep 5, 2023
Sep 6, 2023
Sep 23, 2023
Apr 21, 2023
Aug 21, 2023
Sep 21, 2023
Apr 21, 2023
Jul 17, 2020
Apr 8, 2022
Sep 2, 2023
Dec 27, 2022
Aug 29, 2023
Dec 28, 2022
May 13, 2023
Aug 22, 2023
May 4, 2023
Oct 25, 2022
Dec 13, 2022
Aug 28, 2023
Sep 22, 2023
Sep 23, 2023
Jan 18, 2023
Aug 25, 2023
Aug 21, 2023
Aug 23, 2023
Sep 21, 2023

Repository files navigation

umami

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

Getting started

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

Installing from source

Requirements

  • A server with Node.js version 16.13 or newer
  • A database. Umami supports MySQL and Postgresql 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 is in the following format:

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

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

Build the application

yarn build

The build step will also create tables in your database if you ae 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.dev/umami-software/umami:postgresql-latest

Or with MySQL support:

docker pull docker.umami.dev/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

License

MIT

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 59.4%
  • TypeScript 35.3%
  • CSS 5.0%
  • Other 0.3%