2024-05-24 12:40:00 +05:30
<p align="center">
2024-10-05 10:16:21 -07:00
<img src="https://content.umami.is/website/images/umami-logo.png" alt="Umami Logo" width="100">
2024-05-24 12:40:00 +05:30
</p>
2020-08-13 01:41:11 -07:00
2024-05-25 20:13:28 +05:30
<h1 align="center">Umami</h1>
2020-08-19 14:35:38 -07:00
2024-05-25 20:07:21 +05:30
<p align="center">
<i>Umami is a simple, fast, privacy-focused alternative to Google Analytics.</i>
</p>
<p align="center">
2025-11-15 23:34:26 +03:00
<a href="https://github.com/umami-software/umami/releases"><img src="https://img.shields.io/github/release/umami-software/umami.svg" alt="GitHub Release" /></a>
<a href="https://github.com/umami-software/umami/blob/master/LICENSE"><img src="https://img.shields.io/github/license/umami-software/umami.svg" alt="MIT License" /></a>
<a href="https://github.com/umami-software/umami/actions"><img src="https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml" alt="Build Status" /></a>
<a href="https://analytics.umami.is/share/LGazGOecbDtaIwDr/umami.is" style="text-decoration: none;"><img src="https://img.shields.io/badge/Try%20Demo%20Now-Click%20Here-brightgreen" alt="Umami Demo" /></a>
2024-05-25 20:07:21 +05:30
</p>
2024-05-24 12:40:00 +05:30
2024-05-25 20:02:00 +05:30
---
## ๐ Getting Started
2020-08-19 14:35:38 -07:00
2024-05-25 20:07:21 +05:30
A detailed getting started guide can be found at [umami.is/docs ](https://umami.is/docs/ ).
2020-08-19 14:35:38 -07:00
2024-05-25 20:02:00 +05:30
---
## ๐ Installing from Source
2020-08-13 01:41:11 -07:00
2020-08-19 14:35:38 -07:00
### Requirements
2025-12-03 19:37:51 -08:00
- A server with Node.js version 18.18+.
- A PostgreSQL database version v12.14+.
2020-08-19 14:35:38 -07:00
2025-12-03 19:37:51 -08:00
### Get the source code and install packages
2020-08-13 01:41:11 -07:00
2024-05-24 12:40:00 +05:30
``` bash
2022-07-21 14:31:09 +02:00
git clone https://github.com/umami-software/umami.git
2020-08-13 01:41:11 -07:00
cd umami
2025-08-22 16:21:57 -07:00
pnpm install
2020-08-16 21:28:54 -07:00
```
2024-05-24 12:40:00 +05:30
### Configure Umami
2020-08-13 01:41:11 -07:00
2024-05-24 12:40:00 +05:30
Create an `.env` file with the following:
2020-08-13 01:41:11 -07:00
2024-05-24 12:40:00 +05:30
``` bash
2022-07-16 22:04:53 -07:00
DATABASE_URL = connection-url
2020-08-13 01:41:11 -07:00
```
2024-05-25 20:07:21 +05:30
The connection URL format:
2022-10-31 23:42:37 -07:00
2024-05-24 12:40:00 +05:30
``` bash
2020-08-13 01:41:11 -07:00
postgresql://username:mypassword@localhost:5432/mydb
```
2024-05-24 12:40:00 +05:30
### Build the Application
2022-06-19 00:07:01 -07:00
``` bash
2025-08-22 16:21:57 -07:00
pnpm run build
2022-06-19 00:07:01 -07:00
```
2025-12-03 19:37:51 -08:00
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 ** .
2022-06-27 02:41:31 -07:00
2024-05-24 12:40:00 +05:30
### Start the Application
2020-08-16 21:28:54 -07:00
2020-09-06 15:44:56 +10:00
``` bash
2025-08-22 16:21:57 -07:00
pnpm run start
2020-08-16 21:28:54 -07:00
```
2025-12-03 19:37:51 -08:00
By default, this will launch the application on `http://localhost:3000` . You will need to either [proxy ](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/ ) requests from your web server or change the [port ](https://nextjs.org/docs/api-reference/cli#production ) to serve the application directly.
2020-08-17 00:05:57 -07:00
2024-05-25 20:02:00 +05:30
---
## ๐ณ Installing with Docker
2020-08-19 00:23:04 -04:00
2025-12-03 19:37:51 -08:00
Umami provides Docker images as well as a Docker compose file for easy deployment.
Docker image:
2020-08-19 00:23:04 -04:00
2020-09-06 15:44:56 +10:00
``` bash
2025-12-03 19:37:51 -08:00
docker pull docker.umami.is/umami-software/umami:latest
2020-08-19 00:23:04 -04:00
```
2025-12-04 00:37:13 -08:00
Docker compose (Runs Umami with a PostgreSQL database):
2022-10-31 23:42:37 -07:00
2020-09-06 15:44:56 +10:00
``` bash
2025-12-03 19:37:51 -08:00
docker compose up -d
2020-09-06 15:44:56 +10:00
```
2024-05-25 20:02:00 +05:30
---
## ๐ Getting Updates
2020-09-03 08:56:51 -07:00
To get the latest features, simply do a pull, install any new dependencies, and rebuild:
2020-09-06 15:44:56 +10:00
``` bash
2020-09-03 08:56:51 -07:00
git pull
2025-08-22 16:21:57 -07:00
pnpm install
2025-12-03 19:37:51 -08:00
pnpm build
2020-09-03 08:56:51 -07:00
```
2022-03-17 13:51:24 -06:00
To update the Docker image, simply pull the new images and rebuild:
``` bash
2022-09-07 12:55:15 +10:00
docker compose pull
2025-02-22 00:59:43 +01:00
docker compose up --force-recreate -d
2022-03-17 13:51:24 -06:00
```
2024-05-25 19:56:32 +05:30
2024-05-25 20:02:00 +05:30
---
2024-05-26 17:26:15 -07:00
## ๐ Support
2024-05-25 19:56:32 +05:30
2024-05-25 20:07:21 +05:30
<p align="center">
2025-11-15 23:34:26 +03:00
<a href="https://github.com/umami-software/umami"><img src="https://img.shields.io/badge/GitHub--blue?style=social&logo=github" alt="GitHub" /></a>
<a href="https://twitter.com/umami_software"><img src="https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter" alt="Twitter" /></a>
<a href="https://linkedin.com/company/umami-software"><img src="https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin" alt="LinkedIn" /></a>
<a href="https://umami.is/discord"><img src="https://img.shields.io/badge/Discord--blue?style=social&logo=discord" alt="Discord" /></a>
2024-05-25 20:07:21 +05:30
</p>
2024-05-25 19:56:32 +05:30
2024-05-24 12:40:00 +05:30
[release-shield]: https://img.shields.io/github/release/umami-software/umami.svg
[releases-url]: https://github.com/umami-software/umami/releases
[license-shield]: https://img.shields.io/github/license/umami-software/umami.svg
[license-url]: https://github.com/umami-software/umami/blob/master/LICENSE
[build-shield]: https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml
[build-url]: https://github.com/umami-software/umami/actions
2024-05-25 19:56:32 +05:30
[github-shield]: https://img.shields.io/badge/GitHub--blue?style=social&logo=github
[github-url]: https://github.com/umami-software/umami
[twitter-shield]: https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter
[twitter-url]: https://twitter.com/umami_software
[linkedin-shield]: https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin
[linkedin-url]: https://linkedin.com/company/umami-software
[discord-shield]: https://img.shields.io/badge/Discord--blue?style=social&logo=discord
[discord-url]: https://discord.com/invite/4dz4zcXYrQ
