Merge pull request #3832 from umami-software/dev

v3.0.2

Author: mikecao

.dockerignore

@@ -7,3 +7,5 @@ node_modules
 .idea
 .env
 .env.*
+scripts/seed
+scripts/seed-data.ts

.eslintignore

@@ -1,5 +1,7 @@
+ARG NODE_IMAGE_VERSION="22-alpine"
+
 # Install dependencies only when needed
-FROM node:22-alpine AS deps
+FROM node:${NODE_IMAGE_VERSION} AS deps
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk add --no-cache libc6-compat
 WORKDIR /app
@@ -8,26 +10,25 @@ RUN npm install -g pnpm
 RUN pnpm install --frozen-lockfile
 
 # Rebuild the source code only when needed
-FROM node:22-alpine AS builder
+FROM node:${NODE_IMAGE_VERSION} AS builder
 WORKDIR /app
 COPY --from=deps /app/node_modules ./node_modules
 COPY . .
 COPY docker/middleware.ts ./src
 
-ARG DATABASE_TYPE
 ARG BASE_PATH
 
-ENV DATABASE_TYPE=$DATABASE_TYPE
 ENV BASE_PATH=$BASE_PATH
-
 ENV NEXT_TELEMETRY_DISABLED=1
+ENV DATABASE_URL="postgresql://user:pass@localhost:5432/dummy"
 
 RUN npm run build-docker
 
 # Production image, copy all the files and run next
-FROM node:22-alpine AS runner
+FROM node:${NODE_IMAGE_VERSION} AS runner
 WORKDIR /app
 
+ARG PRISMA_VERSION="6.19.0"
 ARG NODE_OPTIONS
 
 ENV NODE_ENV=production
@@ -36,16 +37,14 @@ ENV NODE_OPTIONS=$NODE_OPTIONS
 
 RUN addgroup --system --gid 1001 nodejs
 RUN adduser --system --uid 1001 nextjs
-RUN npm install -g pnpm
-
 RUN set -x \
-    && apk add --no-cache curl
+    && apk add --no-cache curl \
+    && npm install -g pnpm
 
 # Script dependencies
-RUN pnpm add npm-run-all dotenv chalk semver prisma@6.18.0 @prisma/adapter-pg@6.18.0
-
-# Permissions for prisma
-RUN chown -R nextjs:nodejs node_modules/.pnpm/
+RUN pnpm --allow-build='@prisma/engines' add npm-run-all dotenv chalk semver \
+    prisma@${PRISMA_VERSION} \
+    @prisma/adapter-pg@${PRISMA_VERSION}
 
 COPY --from=builder --chown=nextjs:nodejs /app/public ./public
 COPY --from=builder /app/prisma ./prisma

.eslintrc.json

@@ -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
 
 ```bash
 git clone https://github.com/umami-software/umami.git
@@ -58,45 +58,44 @@ postgresql://username:mypassword@localhost:5432/mydb
 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**._
+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._
+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:
 
 ```bash
 git pull
 pnpm install
-pnpm run build
+pnpm build
 ```
 
 To update the Docker image, simply pull the new images and rebuild:

.prettierignore

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.3.6/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "includes": ["**", "!!**/dist"]
+  },
+  "formatter": {
+    "enabled": true,
+    "lineWidth": 100,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf"
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "a11y": "off",
+      "correctness": {
+        "useExhaustiveDependencies": "off"
+      },
+      "style": {
+        "noDescendingSpecificity": "off"
+      },
+      "complexity": {
+        "noImportantStyles": "off"
+      },
+      "suspicious": {
+        "noArrayIndexKey": "off",
+        "noExplicitAny": "off",
+        "noImplicitAnyLet": "off"
+      },
+      "performance": {
+        "noImgElement": "off"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "trailingCommas": "all",
+      "arrowParentheses": "asNeeded"
+    }
+  },
+  "css": {
+    "formatter": {
+      "enabled": true,
+      "indentStyle": "space",
+      "indentWidth": 2,
+      "lineEnding": "lf"
+    }
+  },
+  "assist": {
+    "enabled": true,
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  }
+}

.prettierrc.json

@@ -1,4 +1,4 @@
-import { NextRequest, NextResponse } from 'next/server';
+import { type NextRequest, NextResponse } from 'next/server';
 
 export const config = {
   matcher: '/:path*',

Dockerfile

@@ -1,5 +1,5 @@
 import 'dotenv/config';
-import pkg from './package.json' assert { type: 'json' };
+import pkg from './package.json' with { type: 'json' };
 
 const TRACKER_SCRIPT = '/script.js';