From 6f73fc630cd5157fd59f5a99c0a250a59b634546 Mon Sep 17 00:00:00 2001
From: Weaxs <459312872@qq.com>
Date: Fri, 5 Jul 2024 11:09:07 +0800
Subject: [PATCH] umami analytics support data-domains
---
config/_default/params.toml | 1 +
exampleSite/config/_default/params.toml | 1 +
.../content/docs/configuration/index.it.md | 9 +++++----
.../content/docs/configuration/index.ja.md | 9 +++++----
.../content/docs/configuration/index.md | 9 +++++----
.../content/docs/configuration/index.zh-cn.md | 9 +++++----
exampleSite/content/docs/partials/index.it.md | 2 ++
exampleSite/content/docs/partials/index.ja.md | 2 ++
exampleSite/content/docs/partials/index.md | 3 ++-
.../content/docs/partials/index.zh-cn.md | 2 ++
layouts/partials/analytics/umami.html | 19 ++++++++++++-------
11 files changed, 42 insertions(+), 24 deletions(-)
diff --git a/config/_default/params.toml b/config/_default/params.toml
index 19f15f82..fc4edcb2 100644
--- a/config/_default/params.toml
+++ b/config/_default/params.toml
@@ -134,6 +134,7 @@ disableTextInHeader = false
[umamiAnalytics]
# websiteid = "ABC12345"
# domain = "llama.yoursite.com"
+ # dataDomains = "yoursite.com,yoursite2.com"
[buymeacoffee]
# identifier = ""
diff --git a/exampleSite/config/_default/params.toml b/exampleSite/config/_default/params.toml
index 90f5cbaf..bd6b5345 100644
--- a/exampleSite/config/_default/params.toml
+++ b/exampleSite/config/_default/params.toml
@@ -133,6 +133,7 @@ smartTOCHideUnfocusedChildren = false
[umamiAnalytics]
# websiteid = "ABC12345"
# domain = "llama.yoursite.com"
+ # dataDomains = "yoursite.com,yoursite2.com"
[buymeacoffee]
identifier = "nunocoracao"
diff --git a/exampleSite/content/docs/configuration/index.it.md b/exampleSite/content/docs/configuration/index.it.md
index accb49c3..7ff3a897 100644
--- a/exampleSite/content/docs/configuration/index.it.md
+++ b/exampleSite/content/docs/configuration/index.it.md
@@ -318,10 +318,11 @@ Many of the article defaults here can be overridden on a per article basis by sp
### Umami Analytics
-| Name | Default | Description |
-| -------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. |
-| `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. |
+| Name | Default | Description |
+| -------------------------- | --------- |----------------------------------------------------------------------------------------------------------------------------------------------------|
+| `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. |
+| `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. |
+| `umamiAnalytics.dataDomains` | _Not set_ | If you want the tracker to only run on specific domains, provide it for your tracker script. This is a comma delimited list of domain names. Such as "yoursite.com,yoursite2.com". |
### BuyMeACoffee
diff --git a/exampleSite/content/docs/configuration/index.ja.md b/exampleSite/content/docs/configuration/index.ja.md
index 9ab5fc66..a9483139 100644
--- a/exampleSite/content/docs/configuration/index.ja.md
+++ b/exampleSite/content/docs/configuration/index.ja.md
@@ -317,10 +317,11 @@ Many of the article defaults here can be overridden on a per article basis by sp
### Umami Analytics
-| Name | Default | Description |
-| -------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. |
-| `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. |
+| Name | Default | Description |
+| -------------------------- | --------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. |
+| `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. |
+| `umamiAnalytics.dataDomains` | _Not set_ | If you want the tracker to only run on specific domains, provide it for your tracker script. This is a comma delimited list of domain names. Such as "yoursite.com,yoursite2.com". |
### BuyMeACoffee
diff --git a/exampleSite/content/docs/configuration/index.md b/exampleSite/content/docs/configuration/index.md
index ac070d79..7b3ce190 100644
--- a/exampleSite/content/docs/configuration/index.md
+++ b/exampleSite/content/docs/configuration/index.md
@@ -318,10 +318,11 @@ Many of the article defaults here can be overridden on a per article basis by sp
### Umami Analytics
-| Name | Default | Description |
-| -------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. |
-| `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. |
+| Name | Default | Description |
+| -------------------------- | --------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `umamiAnalytics.websiteid` | _Not set_ | The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details. |
+| `umamiAnalytics.domain` | _Not set_ | If using a custom domain with Umami Analytics, provide it here to serve `script.js` from the custom domain. |
+| `umamiAnalytics.dataDomains` | _Not set_ | If you want the tracker to only run on specific domains, provide it for your tracker script. This is a comma delimited list of domain names. Such as "yoursite.com,yoursite2.com". |
### BuyMeACoffee
diff --git a/exampleSite/content/docs/configuration/index.zh-cn.md b/exampleSite/content/docs/configuration/index.zh-cn.md
index bda9616d..aa8ef1f9 100644
--- a/exampleSite/content/docs/configuration/index.zh-cn.md
+++ b/exampleSite/content/docs/configuration/index.zh-cn.md
@@ -321,10 +321,11 @@ Blowfish 提供了大量控制主题功能的配置参数,下面的表格中
### Umami Analytics
-| Name | Default | Description |
-| -------------------------- | --------- | ------------------------------------------------------------------------------------------ |
-| `umamiAnalytics.websiteid` | _Not set_ | 支持 Umami 站点分析平台。更多详细内容请参考 [分析文档]({{< ref "partials#analytics" >}})。 |
-| `umamiAnalytics.domain` | _Not set_ | 如果使用自定义域名的 Umami Analytics,请在此提供,以便从自定义域名获取 `script.js`。 |
+| Name | Default | Description |
+| -------------------------- | --------- |-------------------------------------------------------------------------------------|
+| `umamiAnalytics.websiteid` | _Not set_ | 支持 Umami 站点分析平台。更多详细内容请参考 [分析文档]({{< ref "partials#analytics" >}})。 |
+| `umamiAnalytics.domain` | _Not set_ | 如果使用自定义域名的 Umami Analytics,请在此提供,以便从自定义域名获取 `script.js`。 |
+| `umamiAnalytics.dataDomains` | _Not set_ | 如果你只想在特别的数个域名中使用 tracker 功能,那么你需要设置它。这个参数的值是逗号分隔的域名列表,如:yoursite.com,yoursite2.com。 |
### BuyMeACoffee
diff --git a/exampleSite/content/docs/partials/index.it.md b/exampleSite/content/docs/partials/index.it.md
index 30c6ecd2..11911ae9 100644
--- a/exampleSite/content/docs/partials/index.it.md
+++ b/exampleSite/content/docs/partials/index.it.md
@@ -44,6 +44,7 @@ googleAnalytics = "G-MEASUREMENT_ID"
To enable Umami Analytics support, simply provide your [Umami tracking code](https://umami.is/docs/collect-data) in the `config/_default/params.toml` file.
If you also use the custom domain feature of Umami and would like to serve their script from your domain, you can also additionally provide the `domain` configuration value. If you don't provide a `domain` value, the script will load directly from Umami DNS (analytics.umami.is).
+If you want the tracker to only run on specific domains, you can provide the `dataDomains` configuration value. If you don't provide a `dataDomains` value, the script will run on any website where the `domain` and` websiteid` match.
```toml
# config/_default/params.toml
@@ -51,6 +52,7 @@ If you also use the custom domain feature of Umami and would like to serve their
[umamiAnalytics]
websiteid = "ABC12345"
domain = "llama.yoursite.com"
+ dataDomains = "yoursite.com,yoursite2.com"
```
### Custom analytics providers
diff --git a/exampleSite/content/docs/partials/index.ja.md b/exampleSite/content/docs/partials/index.ja.md
index 30c6ecd2..11911ae9 100644
--- a/exampleSite/content/docs/partials/index.ja.md
+++ b/exampleSite/content/docs/partials/index.ja.md
@@ -44,6 +44,7 @@ googleAnalytics = "G-MEASUREMENT_ID"
To enable Umami Analytics support, simply provide your [Umami tracking code](https://umami.is/docs/collect-data) in the `config/_default/params.toml` file.
If you also use the custom domain feature of Umami and would like to serve their script from your domain, you can also additionally provide the `domain` configuration value. If you don't provide a `domain` value, the script will load directly from Umami DNS (analytics.umami.is).
+If you want the tracker to only run on specific domains, you can provide the `dataDomains` configuration value. If you don't provide a `dataDomains` value, the script will run on any website where the `domain` and` websiteid` match.
```toml
# config/_default/params.toml
@@ -51,6 +52,7 @@ If you also use the custom domain feature of Umami and would like to serve their
[umamiAnalytics]
websiteid = "ABC12345"
domain = "llama.yoursite.com"
+ dataDomains = "yoursite.com,yoursite2.com"
```
### Custom analytics providers
diff --git a/exampleSite/content/docs/partials/index.md b/exampleSite/content/docs/partials/index.md
index 8a3ebbad..3fc0b3b5 100644
--- a/exampleSite/content/docs/partials/index.md
+++ b/exampleSite/content/docs/partials/index.md
@@ -44,13 +44,14 @@ googleAnalytics = "G-MEASUREMENT_ID"
To enable Umami Analytics support, simply provide your [Umami tracking code](https://umami.is/docs/collect-data) in the `config/_default/params.toml` file.
If you also use the custom domain feature of Umami and would like to serve their script from your domain, you can also additionally provide the `domain` configuration value. If you don't provide a `domain` value, the script will load directly from Umami DNS (analytics.umami.is).
-
+If you want the tracker to only run on specific domains, you can provide the `dataDomains` configuration value. If you don't provide a `dataDomains` value, the script will run on any website where the `domain` and` websiteid` match.
```toml
# config/_default/params.toml
[umamiAnalytics]
websiteid = "ABC12345"
domain = "llama.yoursite.com"
+ dataDomains = "yoursite.com,yoursite2.com"
```
### Custom analytics providers
diff --git a/exampleSite/content/docs/partials/index.zh-cn.md b/exampleSite/content/docs/partials/index.zh-cn.md
index fc02d69e..48295861 100644
--- a/exampleSite/content/docs/partials/index.zh-cn.md
+++ b/exampleSite/content/docs/partials/index.zh-cn.md
@@ -48,6 +48,7 @@ googleAnalytics = "G-MEASUREMENT_ID"
只需要在 `config/_default/params.toml` 文件提供你的 [Umami 跟踪代码](https://umami.is/docs/collect-data),就可以快速支持 Umami 站点分析。
如果你想使用自定义域名来获取跟踪脚本, 那么需要提供 `domain` 参数,否则会从 Umami 云服务版的地址 (analytics.umami.is) 获取脚本。
+如果你只想在特别的数个域名中使用 tracker 功能,那么需要提供 `dataDomains` 参数。否则任何一个匹配了 `websiteid` 和 `domain` 参数值的网站,Umami 脚本都会执行。
```toml
# config/_default/params.toml
@@ -55,6 +56,7 @@ googleAnalytics = "G-MEASUREMENT_ID"
[umamiAnalytics]
websiteid = "ABC12345"
domain = "llama.yoursite.com"
+ dataDomains = "yoursite.com,yoursite2.com"
```
### 提供自定义站点分析
diff --git a/layouts/partials/analytics/umami.html b/layouts/partials/analytics/umami.html
index 67bf4b71..f9fb0419 100644
--- a/layouts/partials/analytics/umami.html
+++ b/layouts/partials/analytics/umami.html
@@ -1,16 +1,21 @@
{{ if isset site.Params.umamiAnalytics "domain" }}
-
{{ else }}
-
{{ end }}
\ No newline at end of file