Self-hosted personal gallery application with online photo management and albums, supporting Live/Motion Photos, EXIF parsing, geolocation recognition, and an explore map.
TypeScript albumsexif-extractiongeocodinglive-photomotion-photophoto-galleryphoto-sharingwebgl-viewer
feat(experimental): matomo analytics integration
HoshinoSuzumi27756ff98134
diff --git a/.env.example b/.env.exampleindex 40c5542f..48fbcedf 100644--- a/.env.example+++ b/.env.example@@ -43,3 +43,7 @@ NUXT_ALLOW_INSECURE_COOKIE=false# Google Analytics Measurement ID (e.g. G-XXXXXXX)NUXT_PUBLIC_GTAG_ID=+# Matomo Analytics configuration+NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED=false+NUXT_PUBLIC_ANALYTICS_MATOMO_URL=+NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID=diff --git a/README.md b/README.mdindex bb3a9d98..51c2994b 100644--- a/README.md+++ b/README.md@@ -81,6 +81,13 @@ NUXT_SESSION_PASSWORD=NUXT_PUBLIC_OAUTH_GITHUB_ENABLED=falseNUXT_OAUTH_GITHUB_CLIENT_ID=NUXT_OAUTH_GITHUB_CLIENT_SECRET=++# Google Analytics Measurement ID (e.g. G-XXXXXXX)+NUXT_PUBLIC_GTAG_ID=+# Matomo Analytics configuration+NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED=false+NUXT_PUBLIC_ANALYTICS_MATOMO_URL=+NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID=```### Docker@@ -117,29 +124,33 @@ docker-compose up -d### Environment Variables-| Variable | Description | Default | Required |-| :--------------------------------- | :------------------------------------- | :---------- | :------------------------------ |-| CFRAME_ADMIN_EMAIL | Email of the initial admin user | None | Yes |-| CFRAME_ADMIN_NAME | Username of the initial admin | Chronoframe | No |-| CFRAME_ADMIN_PASSWORD | Password of the initial admin | CF1234@! | No |-| NUXT_PUBLIC_APP_TITLE | Application title | ChronoFrame | No |-| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |-| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |-| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |-| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token for map service | None | Yes |-| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token for location info | None | No |-| NUXT_STORAGE_PROVIDER | Storage provider (s3, github, local) | s3 | Yes |-| NUXT_PROVIDER_S3_ENDPOINT | S3 endpoint | None | Required if provider is s3 |-| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | chronoframe | Required if provider is s3 |-| NUXT_PROVIDER_S3_REGION | S3 bucket region | auto | Required if provider is s3 |-| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required if provider is s3 |-| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required if provider is s3 |-| NUXT_PROVIDER_S3_PREFIX | S3 object prefix | photos/ | No |-| NUXT_PROVIDER_S3_CDN_URL | S3 CDN URL | None | No |-| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | false | No |-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |-| NUXT_SESSION_PASSWORD | Session encryption password (32 chars) | None | Yes |+| Variable | Description | Default | Required |+| :----------------------------------- | :------------------------------------- | :---------- | :------------------------------ |+| CFRAME_ADMIN_EMAIL | Email of the initial admin user | None | Yes |+| CFRAME_ADMIN_NAME | Username of the initial admin | Chronoframe | No |+| CFRAME_ADMIN_PASSWORD | Password of the initial admin | CF1234@! | No |+| NUXT_PUBLIC_APP_TITLE | Application title | ChronoFrame | No |+| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |+| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |+| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |+| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token for map service | None | Yes |+| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token for location info | None | No |+| NUXT_STORAGE_PROVIDER | Storage provider (s3, github, local) | s3 | Yes |+| NUXT_PROVIDER_S3_ENDPOINT | S3 endpoint | None | Required if provider is s3 |+| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | chronoframe | Required if provider is s3 |+| NUXT_PROVIDER_S3_REGION | S3 bucket region | auto | Required if provider is s3 |+| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required if provider is s3 |+| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required if provider is s3 |+| NUXT_PROVIDER_S3_PREFIX | S3 object prefix | photos/ | No |+| NUXT_PROVIDER_S3_CDN_URL | S3 CDN URL | None | No |+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | false | No |+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |+| NUXT_SESSION_PASSWORD | Session encryption password (32 chars) | None | Yes |+| NUXT_PUBLIC_GTAG_ID | Google Analytics Measurement ID | None | No |+| NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED | Enable Matomo analytics | false | No |+| NUXT_PUBLIC_ANALYTICS_MATOMO_URL | Matomo instance URL | None | No (required if Matomo enabled) |+| NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID | Matomo site ID | None | No (required if Matomo enabled) |## 📖 User Guidediff --git a/README_zh.md b/README_zh.mdindex 889c4b2e..9ae51d4a 100644--- a/README_zh.md+++ b/README_zh.md@@ -83,6 +83,13 @@ NUXT_SESSION_PASSWORD=# GitHub OAuthNUXT_OAUTH_GITHUB_CLIENT_ID=NUXT_OAUTH_GITHUB_CLIENT_SECRET=++# Google Analytics Measurement ID (e.g. G-XXXXXXX)+NUXT_PUBLIC_GTAG_ID=+# Matomo Analytics configuration+NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED=false+NUXT_PUBLIC_ANALYTICS_MATOMO_URL=+NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID=```### Docker@@ -142,6 +149,10 @@ docker-compose up -d| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) || NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) || NUXT_SESSION_PASSWORD | 用于加密会话的密码,32 位随机字符串 | 无 | 是 |+| NUXT_PUBLIC_GTAG_ID | Google Analytics 追踪 ID | 无 | 否 |+| NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED | 是否启用 Matomo 分析 | false | 否 |+| NUXT_PUBLIC_ANALYTICS_MATOMO_URL | Matomo 实例 URL 地址 | 无 | 否(启用 Matomo 时必需) |+| NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID | Matomo 站点 ID | 无 | 否(启用 Matomo 时必需) |## 📖 使用指南diff --git a/app/plugins/analytics-tracker.client.ts b/app/plugins/analytics-tracker.client.tsnew file mode 100644index 00000000..8f47aac4--- /dev/null+++ b/app/plugins/analytics-tracker.client.ts@@ -0,0 +1,34 @@+export default defineNuxtPlugin((_nuxtApp) => {+ const config = useRuntimeConfig()++ if (+ config.public.analytics.matomo?.enabled &&+ config.public.analytics.matomo.url &&+ config.public.analytics.matomo.siteId+ ) {+ const matomoUrl = config.public.analytics.matomo.url.replace(/\/$/, '') // 移除末尾斜杠+ const siteId = config.public.analytics.matomo.siteId++ useHead({+ script: [+ {+ innerHTML: `+ var _paq = window._paq = window._paq || [];+ _paq.push(['trackPageView']);+ _paq.push(['enableLinkTracking']);+ (function() {+ var u="${matomoUrl}/";+ _paq.push(['setTrackerUrl', u+'matomo.php']);+ _paq.push(['setSiteId', '${siteId}']);+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];+ g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);+ })();+ `.trim(),+ type: 'text/javascript',+ tagPosition: 'head',+ },+ ],+ })+ return+ }+})diff --git a/docs/guide/configuration.md b/docs/guide/configuration.mdindex 4428c66a..f6a99894 100644--- a/docs/guide/configuration.md+++ b/docs/guide/configuration.md@@ -4,27 +4,30 @@ Whether using Docker or Docker Compose (.env) deployment, configuration is done## Environment Variables List-| Environment Variable | Description | Default | Required |-| ---------------------------------- | --------------------------------------------------------------- | ----------- | --------------------------------------------- |-| CFRAME_ADMIN_EMAIL | Initial admin user email | None | Yes |-| CFRAME_ADMIN_NAME | Initial admin username | Chronoframe | No |-| CFRAME_ADMIN_PASSWORD | Initial admin user password | CF1234@! | No |-| NUXT_PUBLIC_APP_TITLE | Application title | ChronoFrame | No |-| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |-| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |-| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |-| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token (URL restricted), for map services | None | Yes |-| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token (no URL restriction), for location services | None | No |-| NUXT_STORAGE_PROVIDER | Storage provider, supports `s3`, `github`, `local` | `s3` | Yes |-| NUXT_PROVIDER_S3_ENDPOINT | S3 compatible storage service endpoint | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |-| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | chronoframe | Required when `NUXT_STORAGE_PROVIDER` is `s3` |-| NUXT_PROVIDER_S3_REGION | S3 bucket region | auto | Required when `NUXT_STORAGE_PROVIDER` is `s3` |-| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |-| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |-| NUXT_PROVIDER_S3_PREFIX | S3 storage prefix | photos/ | No |-| NUXT_PROVIDER_S3_CDN_URL | S3 storage CDN URL | None | No |-| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | false | No |-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |-| NUXT_SESSION_PASSWORD | Password for encrypting sessions, 32-character random string | None | Yes |-| NUXT_PUBLIC_GTAG_ID | Google Analytics Tracking ID | None | No |+| Environment Variable | Description | Default | Required |+| ------------------------------------ | --------------------------------------------------------------- | ----------- | --------------------------------------------- |+| CFRAME_ADMIN_EMAIL | Initial admin user email | None | Yes |+| CFRAME_ADMIN_NAME | Initial admin username | Chronoframe | No |+| CFRAME_ADMIN_PASSWORD | Initial admin user password | CF1234@! | No |+| NUXT_PUBLIC_APP_TITLE | Application title | ChronoFrame | No |+| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |+| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |+| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |+| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token (URL restricted), for map services | None | Yes |+| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token (no URL restriction), for location services | None | No |+| NUXT_STORAGE_PROVIDER | Storage provider, supports `s3`, `github`, `local` | `s3` | Yes |+| NUXT_PROVIDER_S3_ENDPOINT | S3 compatible storage service endpoint | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |+| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | chronoframe | Required when `NUXT_STORAGE_PROVIDER` is `s3` |+| NUXT_PROVIDER_S3_REGION | S3 bucket region | auto | Required when `NUXT_STORAGE_PROVIDER` is `s3` |+| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |+| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |+| NUXT_PROVIDER_S3_PREFIX | S3 storage prefix | photos/ | No |+| NUXT_PROVIDER_S3_CDN_URL | S3 storage CDN URL | None | No |+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | false | No |+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |+| NUXT_SESSION_PASSWORD | Password for encrypting sessions, 32-character random string | None | Yes |+| NUXT_PUBLIC_GTAG_ID | Google Analytics Tracking ID | None | No |+| NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED | Enable Matomo analytics tracking | false | No |+| NUXT_PUBLIC_ANALYTICS_MATOMO_URL | Matomo instance URL (e.g., https://matomo.example.com) | None | No (required if Matomo is enabled) |+| NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID | Matomo site ID | None | No (required if Matomo is enabled) |diff --git a/docs/zh/guide/configuration.md b/docs/zh/guide/configuration.mdindex 18290e02..c57401ae 100644--- a/docs/zh/guide/configuration.md+++ b/docs/zh/guide/configuration.md@@ -4,27 +4,30 @@## 环境变量列表-| 环境变量 | 说明 | 默认值 | 必需 |-| ---------------------------------- | ---------------------------------------------- | ----------- | ----------------------------------------- |-| CFRAME_ADMIN_EMAIL | 初始管理员用户的邮箱 | 无 | 是 |-| CFRAME_ADMIN_NAME | 初始管理员用户的用户名 | Chronoframe | 否 |-| CFRAME_ADMIN_PASSWORD | 初始管理员用户的密码 | CF1234@! | 否 |-| NUXT_PUBLIC_APP_TITLE | 应用标题 | ChronoFrame | 否 |-| NUXT_PUBLIC_APP_SLOGAN | 应用口号 | 无 | 否 |-| NUXT_PUBLIC_APP_AUTHOR | 应用作者 | 无 | 否 |-| NUXT_PUBLIC_APP_AVATAR_URL | 应用头像 URL | 无 | 否 |-| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(可限制 URL),用于地图服务 | 无 | 是 |-| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(无 URL 限制),用于位置信息服务 | 无 | 否 |-| NUXT_STORAGE_PROVIDER | 存储提供者,支持 `s3`、`github`、`local` | `s3` | 是 |-| NUXT_PROVIDER_S3_ENDPOINT | S3 兼容存储服务的 Endpoint | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |-| NUXT_PROVIDER_S3_BUCKET | S3 存储桶名称 | chronoframe | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |-| NUXT_PROVIDER_S3_REGION | S3 存储桶区域 | auto | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |-| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 访问密钥 ID | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |-| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 访问密钥 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |-| NUXT_PROVIDER_S3_PREFIX | S3 存储前缀 | photos/ | 否 |-| NUXT_PROVIDER_S3_CDN_URL | S3 存储的 CDN 地址 | 无 | 否 |-| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | 是否启用 GitHub OAuth 登录 | false | 否 |-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) |-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) |-| NUXT_SESSION_PASSWORD | 用于加密会话的密码,32 位随机字符串 | 无 | 是 |-| NUXT_PUBLIC_GTAG_ID | Google Analytics 追踪 ID | 无 | 否 |+| 环境变量 | 说明 | 默认值 | 必需 |+| ------------------------------------ | ---------------------------------------------------- | ----------- | ----------------------------------------- |+| CFRAME_ADMIN_EMAIL | 初始管理员用户的邮箱 | 无 | 是 |+| CFRAME_ADMIN_NAME | 初始管理员用户的用户名 | Chronoframe | 否 |+| CFRAME_ADMIN_PASSWORD | 初始管理员用户的密码 | CF1234@! | 否 |+| NUXT_PUBLIC_APP_TITLE | 应用标题 | ChronoFrame | 否 |+| NUXT_PUBLIC_APP_SLOGAN | 应用口号 | 无 | 否 |+| NUXT_PUBLIC_APP_AUTHOR | 应用作者 | 无 | 否 |+| NUXT_PUBLIC_APP_AVATAR_URL | 应用头像 URL | 无 | 否 |+| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(可限制 URL),用于地图服务 | 无 | 是 |+| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(无 URL 限制),用于位置信息服务 | 无 | 否 |+| NUXT_STORAGE_PROVIDER | 存储提供者,支持 `s3`、`github`、`local` | `s3` | 是 |+| NUXT_PROVIDER_S3_ENDPOINT | S3 兼容存储服务的 Endpoint | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |+| NUXT_PROVIDER_S3_BUCKET | S3 存储桶名称 | chronoframe | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |+| NUXT_PROVIDER_S3_REGION | S3 存储桶区域 | auto | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |+| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 访问密钥 ID | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |+| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 访问密钥 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |+| NUXT_PROVIDER_S3_PREFIX | S3 存储前缀 | photos/ | 否 |+| NUXT_PROVIDER_S3_CDN_URL | S3 存储的 CDN 地址 | 无 | 否 |+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | 是否启用 GitHub OAuth 登录 | false | 否 |+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) |+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) |+| NUXT_SESSION_PASSWORD | 用于加密会话的密码,32 位随机字符串 | 无 | 是 |+| NUXT_PUBLIC_GTAG_ID | Google Analytics 追踪 ID | 无 | 否 |+| NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED | 是否启用 Matomo 分析追踪 | false | 否 |+| NUXT_PUBLIC_ANALYTICS_MATOMO_URL | Matomo 实例 URL 地址(如: https://matomo.example.com) | 无 | 否(启用 Matomo 时必需) |+| NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID | Matomo 站点 ID | 无 | 否(启用 Matomo 时必需) |diff --git a/nuxt.config.ts b/nuxt.config.tsindex cb3d77d7..78fb64a4 100644--- a/nuxt.config.ts+++ b/nuxt.config.ts@@ -1,5 +1,6 @@import pkg from './package.json'import tailwindcss from '@tailwindcss/vite'+import type { AnalyticsConfig } from './shared/types/config'// https://nuxt.com/docs/api/configuration/nuxt-configexport default defineNuxtConfig({@@ -41,6 +42,13 @@ export default defineNuxtConfig({author: '',avatarUrl: '',},+ analytics: {+ matomo: {+ enabled: false,+ url: '',+ siteId: '',+ },+ } satisfies AnalyticsConfig,oauth: {github: {enabled: false,diff --git a/shared/types/config.ts b/shared/types/config.tsindex 2a142ffc..5f0031d5 100644--- a/shared/types/config.ts+++ b/shared/types/config.ts@@ -3,3 +3,13 @@ import type { StorageConfig } from '../../server/services/storage'export interface ChronoConfig {storage: StorageConfig}++export interface MatomoConfig {+ enabled: boolean+ url: string+ siteId: string+}++export interface AnalyticsConfig {+ matomo: MatomoConfig+}