Compare commits

..

No commits in common. "33e927ed1fe04a9b2c8253b5f57f0b64f6bdcb48" and "33cb195fd010b88b357caa27d40cf70ed7b154ef" have entirely different histories.

12 changed files with 53 additions and 73 deletions

View file

@ -27,10 +27,10 @@ A detailed getting started guide can be found at [umami.is/docs](https://umami.i
### Requirements ### Requirements
- A server with Node.js version 18.18+. - A server with Node.js version 18.18 or newer
- A PostgreSQL database version v12.14+. - A database. Umami supports [PostgreSQL](https://www.postgresql.org/) (minimum v12.14) databases.
### Get the source code and install packages ### Get the Source Code and Install Packages
```bash ```bash
git clone https://github.com/umami-software/umami.git git clone https://github.com/umami-software/umami.git
@ -58,7 +58,7 @@ postgresql://username:mypassword@localhost:5432/mydb
pnpm run build 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 ### Start the Application
@ -66,36 +66,37 @@ The build step will create tables in your database if you are installing for the
pnpm run start 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 ## 🐳 Installing with Docker
Umami provides Docker images as well as a Docker compose file for easy deployment. To build the Umami container and start up a Postgres database, run:
Docker image:
```bash
docker pull docker.umami.is/umami-software/umami:latest
```
Docker compose to run Umami with a Postgres database, run:
```bash ```bash
docker compose up -d docker compose up -d
``` ```
Alternatively, to pull just the Umami Docker image with PostgreSQL support:
```bash
docker pull docker.umami.is/umami-software/umami:latest
```
--- ---
## 🔄 Getting Updates ## 🔄 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: To get the latest features, simply do a pull, install any new dependencies, and rebuild:
```bash ```bash
git pull git pull
pnpm install pnpm install
pnpm build pnpm run build
``` ```
To update the Docker image, simply pull the new images and rebuild: To update the Docker image, simply pull the new images and rebuild:

View file

@ -46,14 +46,6 @@
"arrowParentheses": "asNeeded" "arrowParentheses": "asNeeded"
} }
}, },
"css": {
"formatter": {
"enabled": true,
"indentStyle": "space",
"indentWidth": 2,
"lineEnding": "lf"
}
},
"assist": { "assist": {
"enabled": true, "enabled": true,
"actions": { "actions": {

View file

@ -1,6 +1,6 @@
{ {
"name": "umami", "name": "umami",
"version": "3.0.2", "version": "3.0.1",
"description": "A modern, privacy-focused alternative to Google Analytics.", "description": "A modern, privacy-focused alternative to Google Analytics.",
"author": "Umami Software, Inc. <hello@umami.is>", "author": "Umami Software, Inc. <hello@umami.is>",
"license": "MIT", "license": "MIT",

View file

@ -21,7 +21,6 @@ export function AdminLayout({ children }: { children: ReactNode }) {
border="right" border="right"
backgroundColor backgroundColor
marginRight="2" marginRight="2"
padding="3"
> >
<AdminNav /> <AdminNav />
</Column> </Column>

View file

@ -50,7 +50,7 @@ export function UserEditForm({ userId, onSave }: { userId: string; onSave?: () =
label={formatMessage(labels.role)} label={formatMessage(labels.role)}
rules={{ required: formatMessage(labels.required) }} rules={{ required: formatMessage(labels.required) }}
> >
<Select defaultValue={user.role}> <Select defaultSelectedKey={user.role}>
<ListItem id={ROLES.viewOnly} data-test="dropdown-item-viewOnly"> <ListItem id={ROLES.viewOnly} data-test="dropdown-item-viewOnly">
{formatMessage(labels.viewOnly)} {formatMessage(labels.viewOnly)}
</ListItem> </ListItem>

View file

@ -14,7 +14,6 @@ export function SettingsLayout({ children }: { children: ReactNode }) {
border="right" border="right"
backgroundColor backgroundColor
marginRight="2" marginRight="2"
padding="3"
> >
<SettingsNav /> <SettingsNav />
</Column> </Column>

View file

@ -3,7 +3,7 @@ import { SettingsLayout } from './SettingsLayout';
export default function ({ children }) { export default function ({ children }) {
if (process.env.cloudMode) { if (process.env.cloudMode) {
return null; //return null;
} }
return <SettingsLayout>{children}</SettingsLayout>; return <SettingsLayout>{children}</SettingsLayout>;

View file

@ -51,7 +51,7 @@ export function SideMenu({
}; };
return ( return (
<Column gap overflowY="auto" justifyContent="space-between" position="sticky" top="20px"> <Column gap overflowY="auto" justifyContent="space-between">
{title && ( {title && (
<Row padding> <Row padding>
<Heading size="1">{title}</Heading> <Heading size="1">{title}</Heading>

View file

@ -1,11 +1,10 @@
import { useToast } from '@umami/react-zen'; import { useToast } from '@umami/react-zen';
import type { ApiError } from '@/lib/types';
import { useApi } from '../useApi'; import { useApi } from '../useApi';
import { useModified } from '../useModified'; import { useModified } from '../useModified';
export function useUpdateQuery(path: string, params?: Record<string, any>) { export function useUpdateQuery(path: string, params?: Record<string, any>) {
const { post, useMutation } = useApi(); const { post, useMutation } = useApi();
const query = useMutation<any, ApiError, Record<string, any>>({ const query = useMutation({
mutationFn: (data: Record<string, any>) => post(path, { ...data, ...params }), mutationFn: (data: Record<string, any>) => post(path, { ...data, ...params }),
}); });
const { touch } = useModified(); const { touch } = useModified();

View file

@ -1,6 +1,5 @@
import { FormattedMessage, type MessageDescriptor, useIntl } from 'react-intl'; import { FormattedMessage, type MessageDescriptor, useIntl } from 'react-intl';
import { labels, messages } from '@/components/messages'; import { labels, messages } from '@/components/messages';
import type { ApiError } from '@/lib/types';
type FormatMessage = ( type FormatMessage = (
descriptor: MessageDescriptor, descriptor: MessageDescriptor,
@ -13,7 +12,7 @@ interface UseMessages {
messages: typeof messages; messages: typeof messages;
labels: typeof labels; labels: typeof labels;
getMessage: (id: string) => string; getMessage: (id: string) => string;
getErrorMessage: (error: ApiError) => string | undefined; getErrorMessage: (error: unknown) => string | undefined;
FormattedMessage: typeof FormattedMessage; FormattedMessage: typeof FormattedMessage;
} }
@ -26,7 +25,7 @@ export function useMessages(): UseMessages {
return message ? formatMessage(message) : id; return message ? formatMessage(message) : id;
}; };
const getErrorMessage = (error: ApiError) => { const getErrorMessage = (error: unknown) => {
if (!error) { if (!error) {
return undefined; return undefined;
} }

View file

@ -206,10 +206,6 @@ async function rawQuery(sql: string, data: Record<string, any>, name?: string):
return `$${params.length}${type ?? ''}`; return `$${params.length}${type ?? ''}`;
}); });
if (process.env.DATABASE_REPLICA_URL && '$replica' in client) {
return client.$replica().$queryRawUnsafe(query, ...params);
}
return client.$queryRawUnsafe(query, ...params); return client.$queryRawUnsafe(query, ...params);
} }
@ -300,54 +296,54 @@ function getSchema() {
} }
function getClient() { function getClient() {
if (!process.env.DATABASE_URL) {
return null;
}
const url = process.env.DATABASE_URL; const url = process.env.DATABASE_URL;
const replicaUrl = process.env.DATABASE_REPLICA_URL; const replicaUrl = process.env.DATABASE_REPLICA_URL;
const logQuery = process.env.LOG_QUERY; const logQuery = process.env.LOG_QUERY;
const schema = getSchema();
const baseAdapter = new PrismaPg({ connectionString: url }, { schema }); const connectionUrl = new URL(url);
const schema = connectionUrl.searchParams.get('schema') ?? undefined;
const baseClient = new PrismaClient({ const adapter = new PrismaPg({ connectionString: url.toString() }, { schema });
adapter: baseAdapter,
const prisma = new PrismaClient({
adapter,
errorFormat: 'pretty', errorFormat: 'pretty',
...(logQuery ? PRISMA_LOG_OPTIONS : {}), ...(logQuery ? PRISMA_LOG_OPTIONS : {}),
}); });
if (logQuery) { if (replicaUrl) {
baseClient.$on('query', log); const replicaAdapter = new PrismaPg({ connectionString: replicaUrl.toString() }, { schema });
const replicaClient = new PrismaClient({
adapter: replicaAdapter,
...(logQuery ? PRISMA_LOG_OPTIONS : {}),
});
prisma.$extends(
readReplicas({
replicas: [replicaClient],
}),
);
} }
if (!replicaUrl) {
log('Prisma initialized');
globalThis[PRISMA] ??= baseClient;
return baseClient;
}
const replicaAdapter = new PrismaPg({ connectionString: replicaUrl }, { schema });
const replicaClient = new PrismaClient({
adapter: replicaAdapter,
errorFormat: 'pretty',
...(logQuery ? PRISMA_LOG_OPTIONS : {}),
});
if (logQuery) { if (logQuery) {
replicaClient.$on('query', log); prisma.$on('query' as never, log);
} }
const extended = baseClient.$extends( log('Prisma initialized');
readReplicas({
replicas: [replicaClient],
}),
);
log('Prisma initialized (with replica)'); if (!globalThis[PRISMA]) {
globalThis[PRISMA] ??= extended; globalThis[PRISMA] = prisma;
}
return extended; return prisma;
} }
const client = (globalThis[PRISMA] || getClient()) as ReturnType<typeof getClient>; const client: PrismaClient = globalThis[PRISMA] || getClient();
export default { export default {
client, client,

View file

@ -136,8 +136,3 @@ export interface RealtimeData {
urls: Record<string, number>; urls: Record<string, number>;
visitors: any[]; visitors: any[];
} }
export interface ApiError extends Error {
code?: string;
message: string;
}