Hugo Umami Analytics Module

October 13, 2024 1 min read Modules Analytics Docs Umami Analytics

Umami is an open-source, privacy-focused web analytics tool that serves as an alternative to Google Analytics.

Donate

Become a backer or sponsor to support our work.

On this page

Module	`github.com/hugomods/umami-analytics`
Stats

Installation

Import the Module

1module:
2  imports:
3  - path: github.com/hugomods/umami-analytics

1[module]
2  [[module.imports]]
3    path = 'github.com/hugomods/umami-analytics'

1{
2   "module": {
3      "imports": [
4         {
5            "path": "github.com/hugomods/umami-analytics"
6         }
7      ]
8   }
9}

Import the Template

Note
Please skip this step if your theme supports HugoPress, such as HB Framework themes.

1<head>
2  {{ partialCached "hugomods/umami-analytics/index" . .Params.analyze }}
3</head>

Site Configuration

`params.services.umamni_analytics.id`

Name	Context	Type	Required	Default	Since	Example
`params.services.umamni_analytics.id`	`-`	`string`	✓	-	-	-

Website ID.

`params.services.umamni_analytics.script_url`

Name	Context	Type	Required	Default	Since	Example
`params.services.umamni_analytics.script_url`	`-`	`string`	-	`https://cloud.umami.is/script.js`	-	-

The JavaScript URL.

Site Configuration Example

hugo.yaml

1params:
2  services:
3    umami_analytics:
4      id: XXXXXXXX
5      script_url: https://cloud.umami.is/script.js

hugo.toml

1[params]
2  [params.services]
3    [params.services.umami_analytics]
4      id = 'XXXXXXXX'
5      script_url = 'https://cloud.umami.is/script.js'

hugo.json

 1{
 2   "params": {
 3      "services": {
 4         "umami_analytics": {
 5            "id": "XXXXXXXX",
 6            "script_url": "https://cloud.umami.is/script.js"
 7         }
 8      }
 9   }
10}

Page Parameters

`analyze`

Name	Context	Type	Required	Default	Since	Example
`analyze`	`-`	`boolean`	-	`true`	-	-

Exclude pages from being tracked if false.

Plausible Analytics

Cloudflare Analytics

Browse Hugo Analytics Modules