umami

umami

Stars
12.1K
Forks
1.78K
Open issues
60
Closed issues
615
Last release
3 months ago
Last commit
2 months ago
Watchers
12.1K
Total releases
50
Total commits
1.48K
Open PRs
4
Closed PRs
356
Repo URL
Project Website
https://umami.is
Platform
License
Category
Technology
Offers premium version?
NO
Proprietary?
NO
About

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 12 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/mikecao/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
Create database tables
yarn update-db

This will also create a login account 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

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
yarn update-db

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

docker-compose pull
docker-compose up --force-recreate
License

MIT

Alternative Projects

Subscribe to Open Source Businees Newsletter

Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.

We'll never share your email with anyone else.