From 396acf3bbbe00a192cb0ea0a9ccf91b1d8d2850b Mon Sep 17 00:00:00 2001
From: Fuwn <50817549+Fuwn@users.noreply.github.com>
Date: Sat, 24 Jan 2026 13:09:50 +0000
Subject: Initial commit
Created from https://vercel.com/new
---
README.md | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 132 insertions(+)
create mode 100644 README.md
(limited to 'README.md')
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cd365a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,132 @@
+
+ 
+
+
+Umami
+
+
+ Umami is a simple, fast, privacy-focused alternative to Google Analytics.
+
+
+
+ 
+ 
+ 
+ 
+
+
+---
+
+## 🚀 Getting Started
+
+A detailed getting started guide can be found at [umami.is/docs](https://umami.is/docs/).
+
+---
+
+## 🛠 Installing from Source
+
+### Requirements
+
+- A server with Node.js version 18.18+.
+- A PostgreSQL database version v12.14+.
+
+### Get the source code and install packages
+
+```bash
+git clone https://github.com/umami-software/umami.git
+cd umami
+pnpm install
+```
+
+### Configure Umami
+
+Create an `.env` file with the following:
+
+```bash
+DATABASE_URL=connection-url
+```
+
+The connection URL format:
+
+```bash
+postgresql://username:mypassword@localhost:5432/mydb
+```
+
+### Build the Application
+
+```bash
+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
+
+```bash
+pnpm run start
+```
+
+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.
+
+---
+
+## 🐳 Installing with Docker
+
+Umami provides Docker images as well as a Docker compose file for easy deployment.
+
+Docker image:
+
+```bash
+docker pull docker.umami.is/umami-software/umami:latest
+```
+
+Docker compose (Runs Umami with a PostgreSQL database):
+
+```bash
+docker compose up -d
+```
+
+---
+
+## 🔄 Getting Updates
+
+To get the latest features, simply do a pull, install any new dependencies, and rebuild:
+
+```bash
+git pull
+pnpm install
+pnpm build
+```
+
+To update the Docker image, simply pull the new images and rebuild:
+
+```bash
+docker compose pull
+docker compose up --force-recreate -d
+```
+
+---
+
+## 🛟 Support
+
+
+ 
+ 
+ 
+ 
+
+
+[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
+[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
--
cgit v1.2.3