8000 GitHub - jeggy/umami: Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud. · GitHub
[go: up one dir, main page]

Skip to content
jeggyPublic

About

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

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

7,159 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Umami Logo

Umami

Umami is an open-source web and product analytics platform. Understand acquisition, behavior, conversion, and retention with privacy-first analytics — no cookies, 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

  • A server with Node.js version 20.19+ (22 LTS recommended).
  • A PostgreSQL database version v12.14+.

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
APP_SECRET=random-string  # generate with: openssl rand -hex 32

The connection URL format:

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

When Umami is served over HTTPS, add COOKIE_SECURE=1 so that the session cookie is only sent over HTTPS.

To let users sign in through an OpenID Connect provider, add:

OIDC_DISCOVERY_URL=https://idp.example.com/.well-known/openid-configuration
OIDC_CLIENT_ID=client-id
OIDC_CLIENT_SECRET=client-secret

Register https://<your-umami-host>/api/auth/callback/oidc as the redirect URI with the provider. Optional settings:

Variable Default Purpose
OIDC_PROVIDER_NAME SSO Name shown on the login button
OIDC_SCOPES openid profile email Scopes to request
OIDC_DISABLE_SIGNUP Set to 1 to only allow users who have linked their account

A first sign-in creates a user with the user role. Existing users link their provider account under Settings → Security.

Behind a reverse proxy, the redirect URI is built from the X-Forwarded-Host and X-Forwarded-Proto headers. Set BETTER_AUTH_URL=https://<your-umami-host> if the proxy does not send them.

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. You will be required to change this password after signing in.

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.

To bind to the HOSTNAME and PORT set in your .env file, start with pnpm run start:env instead.


🐳 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

About

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

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0