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