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.
TypeScript analyticsaudience-segmentationchartscohort-analysisgoogle-analyticsproduct-analyticsstatisticsuser-journeyweb-analytics
Updated README.
Mike Cao2993db14f097
diff --git a/README.md b/README.mdindex dcc6865fc..95bb43303 100644--- a/README.md+++ b/README.md@@ -27,10 +27,10 @@ A detailed getting started guide can be found at [umami.is/docs](https://umami.i### Requirements-- A server with Node.js version 18.18 or newer-- A database. Umami supports [PostgreSQL](https://www.postgresql.org/) (minimum v12.14) databases.+- A server with Node.js version 18.18+.+- A PostgreSQL database version v12.14+.-### Get the Source Code and Install Packages+### Get the source code and install packages```bashgit clone https://github.com/umami-software/umami.git@@ -58,7 +58,7 @@ postgresql://username:mypassword@localhost:5432/mydbpnpm 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**._+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@@ -66,37 +66,36 @@ _The build step will create tables in your database if you are installing for thpnpm 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._+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-To build the Umami container and start up a Postgres database, run:+Umami provides Docker images as well as a Docker compose file for easy deployment.++Docker image:```bash-docker compose up -d+docker pull docker.umami.is/umami-software/umami:latest```-Alternatively, to pull just the Umami Docker image with PostgreSQL support:+Docker compose to run Umami with a Postgres database, run:```bash-docker pull docker.umami.is/umami-software/umami:latest+docker compose up -d```---## 🔄 Getting Updates-> [!WARNING]-> If you are updating from Umami V2, image "postgresql-latest" is deprecated. You must change it to "latest".-> e.g., rename `docker.umami.is/umami-software/umami:postgresql-latest` to `docker.umami.is/umami-software/umami:latest`.To get the latest features, simply do a pull, install any new dependencies, and rebuild:```bashgit pullpnpm install-pnpm run build+pnpm build```To update the Docker image, simply pull the new images and rebuild:diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex 10eed8210..ef3eb1fa2 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -331,7 +331,44 @@ importers:specifier: ^5.9.3version: 5.9.3- dist: {}+ dist:+ dependencies:+ chart.js:+ specifier: ^4.5.0+ version: 4.5.1+ chartjs-adapter-date-fns:+ specifier: ^3.0.0+ version: 3.0.0([email protected])([email protected])+ colord:+ specifier: ^2.9.2+ version: 2.9.3+ jsonwebtoken:+ specifier: ^9.0.2+ version: 9.0.2+ lucide-react:+ specifier: ^0.542.0+ version: 0.542.0([email protected])+ pure-rand:+ specifier: ^7.0.1+ version: 7.0.1+ react-simple-maps:+ specifier: ^2.3.0+ react-use-measure:+ specifier: ^2.0.4+ react-window:+ specifier: ^1.8.6+ serialize-error:+ specifier: ^12.0.0+ version: 12.0.0+ thenby:+ specifier: ^1.3.4+ version: 1.3.4+ uuid:+ specifier: ^11.1.0+ version: 11.1.0packages:@@ -5058,6 +5095,11 @@ packages:resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==}engines: {node: '>=10'}+ resolution: {integrity: sha512-w3hD8/SQB7+lzU2r4VdFyzzOzKnUjTZIF/MQJGSSvni7Llewni4vuViRppfRAa2guOsY5k4jZyxw/i9DQHv+dw==}+ peerDependencies:+ react: ^16.5.1 || ^17.0.0 || ^18.0.0 || ^19.0.0+resolution: {integrity: sha512-fpVfuOQO0V3HBaOA1stIiP/A2fPCXHIleRZL16Mx3HmjTYwNSbimhnFBygs2CAfU1geexMX5ItUcWBGUaqw5CA==}peerDependencies:@@ -12696,6 +12738,10 @@ snapshots:dependencies:yallist: 4.0.0+ dependencies:+ react: 19.2.1+dependencies:react: 19.2.1