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
Add configurable internal API URL
Mike Cao2fd319f91004
diff --git a/README.md b/README.mdindex cd365a68d..2d0eafd75 100644--- a/README.md+++ b/README.md@@ -46,6 +46,10 @@ Create an `.env` file with the following:DATABASE_URL=connection-url```+Optional: set `API_URL` to change the base URL used by internal UI API calls.+Relative paths are served under `BASE_PATH`; absolute URLs are called directly by the browser.+For example, `API_URL=/internal-api` or `API_URL=https://api.example.com/api`.+The connection URL format:```bashdiff --git a/next.config.ts b/next.config.tsindex 1e96de41c..c9c717f94 100644--- a/next.config.ts+++ b/next.config.ts@@ -8,6 +8,7 @@ const TRACKER_SCRIPT = '/script.js';const isProd = process.env.NODE_ENV === 'production';+const apiUrl = process.env.API_URL || '';const basePath = process.env.BASE_PATH || '';const cloudMode = process.env.CLOUD_MODE || '';const cloudUrl = process.env.CLOUD_URL || '';@@ -22,12 +23,31 @@ const trackerScriptURL = process.env.TRACKER_SCRIPT_URL || '';const selfTrack = process.env.UMAMI_SELF_TRACK || '';const selfRecord = process.env.UMAMI_SELF_RECORD || '';+function getUrlOrigin(url: string) {+ try {+ return new URL(url).origin;+ } catch {+ return '';+ }+}++function isRelativeUrl(url: string) {+ return Boolean(url && !/^https?:\/\//i.test(url));+}++function normalizePath(url: string) {+ return `/${url.replace(/^\/+|\/+$/g, '')}`;+}++const apiUrlOrigin = getUrlOrigin(apiUrl);+const connectSrc = ["'self'", 'https:', apiUrlOrigin].filter(Boolean).join(' ');+const contentSecurityPolicy = `default-src 'self';img-src 'self' https: data:;script-src 'self' 'unsafe-eval' 'unsafe-inline';style-src 'self' 'unsafe-inline';- connect-src 'self' https:;+ connect-src ${connectSrc};frame-src 'self' http: https:;frame-ancestors 'self' ${frameAncestors};`;@@ -123,6 +143,22 @@ if (collectApiEndpoint) {});}+if (isRelativeUrl(apiUrl)) {+ const normalizedApiUrl = normalizePath(apiUrl);++ if (normalizedApiUrl !== '/' && normalizedApiUrl !== '/api') {+ headers.push({+ source: `${normalizedApiUrl}/:path*`,+ headers: apiHeaders,+ });++ rewrites.push({+ source: `${normalizedApiUrl}/:path*`,+ destination: '/api/:path*',+ });+ }+}+const redirects = [{source: '/teams/:id/dashboard/edit',@@ -188,6 +224,7 @@ if (isProd && cloudMode) {export default withNextIntl({reactStrictMode: false,env: {+ apiUrl,basePath,cloudMode,cloudUrl,diff --git a/podman/env.sample b/podman/env.sampleindex 06435e56b..832161a04 100644--- a/podman/env.sample+++ b/podman/env.sample@@ -10,6 +10,11 @@ DATABASE_TYPE=postgresql# A secret string used by Umami (replace with a strong random string)APP_SECRET=replace-me-with-a-random-string+# Optional API base URL for internal UI API calls. Relative paths are served under BASE_PATH;+# absolute URLs are called directly by the browser.+# Examples: /internal-api or https://api.example.com/api+API_URL=+# Postgres container defaults.POSTGRES_DB=umamiPOSTGRES_USER=umamidiff --git a/src/components/hooks/useApi.ts b/src/components/hooks/useApi.tsindex d89e6f18b..aaef8fced 100644--- a/src/components/hooks/useApi.ts+++ b/src/components/hooks/useApi.ts@@ -1,6 +1,7 @@import { useMutation, useQuery } from '@tanstack/react-query';import { usePathname } from 'next/navigation';import { useCallback } from 'react';+import { getApiUrl } from '@/lib/api-url';import { getClientAuthToken } from '@/lib/client';import { SHARE_CONTEXT_HEADER, SHARE_TOKEN_HEADER } from '@/lib/constants';import { type FetchResponse, httpDelete, httpGet, httpPost, httpPut } from '@/lib/fetch';@@ -31,10 +32,8 @@ export function useApi() {authorization: `Bearer ${getClientAuthToken()}`,...shareHeaders,};- const basePath = process.env.basePath;-const getUrl = (url: string) => {- return url.startsWith('http') ? url : `${basePath || ''}/api${url}`;+ return getApiUrl(url);};const getHeaders = (headers: any = {}) => {diff --git a/src/lib/__tests__/api-url.test.ts b/src/lib/__tests__/api-url.test.tsnew file mode 100644index 000000000..2cf9978fb--- /dev/null+++ b/src/lib/__tests__/api-url.test.ts@@ -0,0 +1,36 @@+import { expect, test } from '@jest/globals';+import { getApiUrl } from '../api-url';++test('uses the default api path', () => {+ expect(getApiUrl('/websites', { apiUrl: '', basePath: '' })).toBe('/api/websites');+});++test('uses basePath with the default api path', () => {+ expect(getApiUrl('/websites', { apiUrl: '', basePath: '/analytics' })).toBe(+ '/analytics/api/websites',+ );+});++test('uses a relative API_URL', () => {+ expect(getApiUrl('/websites', { apiUrl: '/backend/api', basePath: '' })).toBe(+ '/backend/api/websites',+ );+});++test('uses basePath with a relative API_URL', () => {+ expect(getApiUrl('/websites', { apiUrl: '/backend/api', basePath: '/analytics' })).toBe(+ '/analytics/backend/api/websites',+ );+});++test('uses an absolute API_URL directly', () => {+ expect(getApiUrl('/websites', { apiUrl: 'https://api.example.com/api', basePath: '' })).toBe(+ 'https://api.example.com/api/websites',+ );+});++test('leaves absolute request URLs unchanged', () => {+ expect(getApiUrl('https://example.com/custom', { apiUrl: '/backend/api', basePath: '' })).toBe(+ 'https://example.com/custom',+ );+});diff --git a/src/lib/api-url.ts b/src/lib/api-url.tsnew file mode 100644index 000000000..765c730b0--- /dev/null+++ b/src/lib/api-url.ts@@ -0,0 +1,39 @@+type ApiUrlOptions = {+ apiUrl?: string;+ basePath?: string;+};++function trimTrailingSlash(value: string) {+ return value.replace(/\/+$/, '');+}++function trimLeadingSlash(value: string) {+ return value.replace(/^\/+/, '');+}++function joinPath(base: string, path: string) {+ if (!base) {+ return `/${trimLeadingSlash(path)}`;+ }++ return `${trimTrailingSlash(base)}/${trimLeadingSlash(path)}`;+}++function isAbsoluteUrl(url: string) {+ return /^https?:\/\//i.test(url);+}++export function getApiUrl(url: string, options: ApiUrlOptions = {}) {+ if (isAbsoluteUrl(url)) {+ return url;+ }++ const { apiUrl = process.env.apiUrl || '', basePath = process.env.basePath || '' } = options;+ const baseUrl = apiUrl+ ? isAbsoluteUrl(apiUrl)+ ? apiUrl+ : joinPath(basePath, apiUrl)+ : joinPath(basePath, '/api');++ return joinPath(baseUrl, url);+}