Add analytics support

Author: larsl-net

README.md

@@ -70,6 +70,19 @@ ui:
     enabled: false
     # Logo URL to display in the header
     logo: https://raw.githubusercontent.com/henrywhitaker3/prompage/refs/heads/main/internal/resources/static/icon.png
+analytics:
+  # Type of analytics (default: none)
+  # Options:
+  # - none: No Tracking
+  # - umami: umami.is tracking
+  type: umami
+
+  # umami settings
+  umami:
+    # Script for umami
+    script: http://localhost:3000/script.js
+    # Website ID for umami
+    websiteID: 3FD6E4BD-2CE9-4D9F-BD8B-65B3A2B870C9
 ```
 
 ## Installation

internal/config/config.go

@@ -46,6 +46,16 @@ type UIHeader struct {
 	Logo    string `yaml:"logo"`
 }
 
+type Analytics struct {
+	Type  string         `yaml:"type"`
+	Umami AnalyticsUmami `yaml:"umami"`
+}
+
+type AnalyticsUmami struct {
+	Script    string `yaml:"script"`
+	WebsiteID string `yaml:"websiteID"`
+}
+
 type Metrics struct {
 	Enabled bool `yaml:"enabled"`
 	Port    int  `yaml:"port"`
@@ -76,6 +86,8 @@ type Config struct {
 	Refresh time.Duration `yaml:"refresh"`
 
 	UI UI `yaml:"ui"`
+
+	Analytics Analytics `yaml:"analytics"`
 }
 
 func Load(path string) (*Config, error) {
@@ -159,6 +171,10 @@ func setDefaults(conf *Config) {
 	if conf.UI.Theme == "" {
 		conf.UI.Theme = "light"
 	}
+
+	if conf.Analytics.Type == "" {
+		conf.Analytics.Type = "none"
+	}
 }
 
 func setDefaultQueryValues(q *Query) {
@@ -216,6 +232,30 @@ func (c *Config) Validate() error {
 		}
 	}
 
+	analyticsTypeValid := false
+	analyticsTypes := []string{
+		"none",
+		"umami",
+	}
+
+	for _, val := range analyticsTypes {
+		if val == c.Analytics.Type {
+			analyticsTypeValid = true
+		}
+	}
+	if !analyticsTypeValid {
+		return errors.New("unsupportet analytics type")
+	}
+
+	if c.Analytics.Type == "umami" {
+		if c.Analytics.Umami.Script == "" {
+			return errors.New("analytics umami script must be set")
+		}
+		if c.Analytics.Umami.WebsiteID == "" {
+			return errors.New("analytics umami websiteID must be set")
+		}
+	}
+
 	return nil
 }
 

internal/resources/views/base.html

@@ -7,6 +7,9 @@
     <link rel="stylesheet" href="/static/tailwind.css?v={{ .Version }}" />
     <link rel="icon" type="image/png" href="/static/icon.png" />
     <title>{{ .Config.UI.PageTitle }}</title>
+    {{ if eq .Config.Analytics.Type "umami" }}
+    <script defer src="{{ .Config.Analytics.Umami.Script }}" data-website-id="{{ .Config.Analytics.Umami.WebsiteID }}"></script>
+    {{ end }}
 </head>
 
 <body