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.4K ·GitHub
Umami
这是什么？Umami 是一个注重隐私的网站分析平台，可以追踪访问流量、营销活动、用户行为、转化和收入，不使用 Cookie，也不进行监控。它既可以自行部署，也可以作为云服务使用。
这是托管服务还是需要自己运行的程序？两者都可以：你可以用 Node.js/PostgreSQL 或 Docker 自行部署，也可以使用 Umami 的托管云版本。
我要怎样才能让它运行起来？克隆源代码，创建包含数据库 URL 的 .env 文件，运行构建步骤（它会创建数据库表和默认管理员用户），然后启动应用；也可以使用提供的 Docker 镜像或 docker-compose 文件。
自己安装之前需要准备什么？一台运行 Node.js 18.18+ 的服务器，以及 v12.14 或更高版本的 PostgreSQL 数据库。
两步验证登录开箱即用吗？不是，两步验证默认是关闭的，除非你手动生成一个 64 个字符的 TWOFACTORENCRYPTIONKEY，并将其设置在 .env 文件中。
它会像 Google Analytics 那样用 Cookie 追踪访客吗？不会，它的设计初衷是作为 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.4K
Updated
CommitSep 17Releasev3.4.0Sep 17
Age
6y
Commits · 90 Days