watson/umami
1
0
Fork 0
mirror of https://github.com/umami-software/umami.git synced 2026-02-04 04:37:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add x-umami-client-* headers as highest priority source for client detection.

Browse source
This commit is contained in:
Mike Cao 2026-01-23 19:33:39 -08:00
parent 518f0b66c6
commit fbd0564133
2 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/lib/detect.ts
View file

@ -10,6 +10,12 @@ import { safeDecodeURIComponent } from '@/lib/url';
const MAXMIND = 'maxmind'; const MAXMIND = 'maxmind';
const PROVIDER_HEADERS = [ const PROVIDER_HEADERS = [
// Umami custom headers
{
countryHeader: 'x-umami-client-country',
regionHeader: 'x-umami-client-region',
cityHeader: 'x-umami-client-city',
},
// Cloudflare headers // Cloudflare headers
{ {
countryHeader: 'cf-ipcountry', countryHeader: 'cf-ipcountry',
@ -60,13 +66,13 @@ function decodeHeader(s: string | undefined | null): string | undefined | null {
return Buffer.from(s, 'latin1').toString('utf-8'); return Buffer.from(s, 'latin1').toString('utf-8');
} }
export async function getLocation(ip: string = '', headers: Headers, hasPayloadIP: boolean) { export async function getLocation(ip: string = '', headers: Headers, skipHeaders: boolean) {
// Ignore local ips // Ignore local ips
if (!ip || (await isLocalhost(ip))) { if (!ip || (await isLocalhost(ip))) {
return null; return null;
} }
if (!hasPayloadIP && !process.env.SKIP_LOCATION_HEADERS) { if (!skipHeaders && !process.env.SKIP_LOCATION_HEADERS) {
for (const provider of PROVIDER_HEADERS) { for (const provider of PROVIDER_HEADERS) {
const countryHeader = headers.get(provider.countryHeader); const countryHeader = headers.get(provider.countryHeader);
if (countryHeader) { if (countryHeader) {

3
src/lib/ip.ts
View file

@ -1,4 +1,5 @@
export const IP_ADDRESS_HEADERS = [ export const IP_ADDRESS_HEADERS = [
'x-umami-client-ip', // Umami custom header
'true-client-ip', // CDN 'true-client-ip', // CDN
'cf-connecting-ip', // Cloudflare 'cf-connecting-ip', // Cloudflare
'fastly-client-ip', // Fastly 'fastly-client-ip', // Fastly
@ -31,7 +32,7 @@ export function getIpAddress(headers: Headers) {
} }
if (header === 'forwarded') { if (header === 'forwarded') {
const match = ip.match(/for=(\[?[0-9a-fA-F:.]+\]?)/); const match = ip.match(/for=(\[?[0-9a-fA-F:.]+]?)/);
if (match) { if (match) {
return match[1]; return match[1];