umami README

The project's README from github.com/umami-software/umami. As one markdown file: README.md.

Umami Logo

Umami

Umami is a privacy-first analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place — no cookies, no surveillance, self-hosted or in the cloud.

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

Get the source code and install packages

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

Configure Umami

Create an .env file with the following:

DATABASE_URL=connection-url

Optional: set API_URL to change the base URL used by internal UI API calls. Relative paths are served under BASE_PATH; absolute URLs are proxied through the local /api route. For example, API_URL=/internal-api or API_URL=https://api.example.com/api.

Optional: set TWO_FACTOR_ENCRYPTION_KEY to a 64-character hex string to enable two-factor authentication. Generate one with openssl rand -hex 32. Two-factor authentication is unavailable and cannot be required until this key is set.

The connection URL format:

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

Build the Application

pnpm run 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

pnpm run 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

Umami provides Docker images as well as a Docker compose file for easy deployment.

Docker image:

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

Docker compose (Runs Umami with a PostgreSQL database):

docker compose up -d

🔄 Getting Updates

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

git pull
pnpm install
pnpm build

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

docker compose pull
docker compose up --force-recreate -d

🛟 Support

GitHub Twitter LinkedIn Discord

umami (umami-software/umami)

Searching Database…

39.5K ·GitHub
Umami
Что это такое?Umami — это платформа веб-аналитики, ориентированная на приватность: она отслеживает трафик, рекламные кампании, поведение пользователей, конверсии и выручку без cookie-файлов и слежки. Работает как приложение, развернутое на собственном сервере, или как облачный сервис.
Это облачный сервис или то, что я развертываю сам?И то, и другое: можно развернуть его самостоятельно на Node.js/PostgreSQL или в Docker, либо воспользоваться управляемой облачной версией Umami.
Как его запустить?Склонируйте исходный код, создайте файл .env с URL базы данных, выполните шаг сборки (он создает таблицы в базе данных и пользователя-администратора по умолчанию), затем запустите приложение; либо используйте готовый образ Docker или файл docker-compose.
Что нужно подготовить перед самостоятельной установкой?Сервер с Node.js 18.18+ и база данных PostgreSQL версии v12.14 или новее.
Работает ли двухфакторный вход сразу после установки?Нет, двухфакторная аутентификация остается отключенной, пока вы вручную не сгенерируете и не укажете 64-символьный TWOFACTORENCRYPTIONKEY в файле .env.
Отслеживает ли он посетителей с помощью cookie-файлов, как Google Analytics?Нет, он создан как альтернатива таким инструментам, как Google Analytics, которая не использует cookie-файлы и не занимается слежкой.
Нужно ли менять стандартный логин администратора?Да, сборка создает стандартный логин admin/umami, который для безопасности следует сменить сразу после первоначальной настройки.
Можно ли обновить его без потери данных?Да: загрузка последней версии кода (или образа Docker), повторная установка зависимостей и пересборка обновляют приложение, сохраняя существующую базу данных.
Какие данные аналитики можно посмотреть?Umami охватывает трафик, рекламные кампании, поведение пользователей, сегментацию аудитории, когортный анализ, конверсии и выручку. По объему это похоже на Google Analytics, но с упором на приватность.
What are similar projects?analytics, rybbit, matomo, openanalytics, canonry, posthog, goaccess, redash
Which topics is it in?google-analytics, web-analytics, self-hosted-ai, statistics, charts, privacy-first, analytics, postgresql, docker-compose, dashboard, cloud, web-app
Creator
umami-software
Size
29.3 MB
Stars
39.5K
Updated
CommitSep 17Releasev3.4.0Sep 17
Age
6y
Commits · 90 Days