Umami is a simple, fast, privacy-focused alternative to Google Analytics.
Go to file
2024-02-19 13:39:57 -08:00
.github Merge pull request #2512 from pxlfrk/master 2024-02-15 19:54:50 -08:00
.husky
db Fix MySQL migration 4. 2024-02-15 10:59:11 +00:00
docker
public Updated lang. 2024-02-16 10:46:14 -08:00
scripts
src fix active visitor bug 2024-02-19 13:39:57 -08:00
.dockerignore
.eslintrc.json
.gitignore
.prettierignore
.prettierrc.json
.stylelintrc.json
app.json
docker-compose.yml
Dockerfile
jsconfig.json
lang-ignore.json
LICENSE
netlify.toml
next-env.d.ts
next.config.js Update redirects for teams. 2024-02-14 22:13:13 -08:00
package.components.json
package.json Upgraded Prisma v5.9.1. 2024-02-17 10:52:53 -08:00
postcss.config.js
README.md
rollup.components.config.mjs
rollup.tracker.config.mjs
tsconfig.json
yarn.lock Upgraded Prisma v5.9.1. 2024-02-17 10:52:53 -08:00

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 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 ghcr.io/umami-software/umami:postgresql-latest

Or with MySQL support:

docker pull ghcr.io/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