# foodtracks-gatsby-plugin-matomo > Gatsby plugin to add Matomo onto a site (expects window.currentUser to be set) Latest version **1.1.0** (published 2020-10-26) · MIT license · 0 weekly downloads ## Install ```sh npm install foodtracks-gatsby-plugin-matomo pnpm add foodtracks-gatsby-plugin-matomo yarn add foodtracks-gatsby-plugin-matomo bun add foodtracks-gatsby-plugin-matomo ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2020-10-26 | | First published | 2020-03-25 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 27.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Krystof Beuermann | | Maintainers | krystofbe | | Keywords | gatsby, gatsby-plugin, analytics, tracking, matomo, piwik | ## Links - npm: https://www.npmjs.com/package/foodtracks-gatsby-plugin-matomo - Repository: https://github.com/krystofbe/gatsby-plugin-matomo - Issues: https://github.com/krystofbe/gatsby-plugin-matomo/issues - npm.io page: https://npm.io/package/foodtracks-gatsby-plugin-matomo ## Alternatives - [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads - [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads - [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads - [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads - [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads ## Recent versions - 1.1.0 (latest) — 2020-10-26 - 1.0.3 — 2020-06-15 - 1.0.1 — 2020-03-25 ## README # gatsby-plugin-matomo > 🥂 Gatsby plugin to add Matomo (formerly Piwik) onto a site. --- - [Features](#features) - [Usage](#usage) - [Options](#options) - [Development](#development) - [Changelog](#changelog) - [License](#license) ## Features Plugin uses sensible defaults prioritizing user experience, performance & privacy: - expects `window.currentUser` to be set. Otherwise no events will be sent - include tracking code in all server-side rendered routes - track all route views as custom events - load tracking scripts at end of `body` tag - don't load anything when visitor has Do Not Track enabled - don't load anything in non-production environments - consent mode for privacy - allow loading tracking script locally - define paths to be excluded from tracking - `preconnect` to configured Matomo host url - dev mode for local development ## Usage 1. First, install the plugin from your project's root: ```bash cd yourproject/ npm i gatsby-plugin-matomo ``` 2. Then load the plugin from your `gatsby-config.js` and set the required variables: ```js plugins: [ { resolve: 'gatsby-plugin-matomo', options: { matomoUrl: 'https://YOUR_MATOMO_URL.COM' } } ] ``` 3. That's it! \_NOTE: this uses gatsby's `location.hostname` as sideId and `location.hostname` as sideURL _NOTE: By default, this plugin only generates output when run in production mode. To test your tracking code, run `gatsby build && gatsby serve`, or set `dev` option to `true`_. ### Options | Option | Explanation | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `siteId` | Your Matomo site ID configured in your Matomo installation. | | `matomoUrl` | The url of your Matomo installation. | | | `matomoPhpScript` | (optional) The name of your Matomo PHP script. Defaults to `piwik.php` | | `matomoJsScript` | (optional) The name of your Matomo JS script. Defaults to `piwik.js` | | `exclude` | (optional) Specify an array of pathnames where tracking code will be excluded. The pathname `/offline-plugin-app-shell-fallback/` is excluded by default. | | `requireConsent` | (optional) If true, tracking will be disabled until you call `window._paq.push(['setConsentGiven']);`. | | `disableCookies` | (optional) If true, no cookie will be used by Matomo. | | `cookieDomain` | (optional) Specify cookie domain. | | `localScript` | (optional) If set, load local `piwik.js` script from the given path, instead of loading it from your `matomoUrl`. | | `dev` | (optional) Activate dev mode by setting to `true`. Will load all scripts despite not running in `production` environment. Ignores your local browser's DNT header too. Outputs some information in console about what it is doing. Useful for local testing but careful: all hits will be send like in production. | | `ignoreTrackingSites` | (optional) An array of hostnames to ignore e.g. ['demo.customer.com'] | | `ignoreUserIds` | (optional) An array of strings (emails, names) to ignore for tracking e.g. ['@foodtracks.de'] | ```js plugins: [ { resolve: 'gatsby-plugin-matomo', options: { matomoUrl: 'https://YOUR_MATOMO_URL.COM', // All the optional settings matomoPhpScript: 'piwik.php', matomoJsScript: 'piwik.js', exclude: ['/offline-plugin-app-shell-fallback/'], requireConsent: false, disableCookies: false, cookieDomain: '*.example.org', localScript: '/piwik.js', dev: false, ignoreTrackingSites: ['demo.customer.com'] } } ] ``` ## Development ```bash npm i npm start # create production build npm run build #release npm run release ``` ## Changelog See [CHANGELOG.md](CHANGELOG.md). ## License The MIT License Copyright (c) 2020 Matthias Kretschmann Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. --- Made with ♥ by [Matthias Kretschmann](https://matthiaskretschmann.com) ([@kremalicious](https://github.com/kremalicious)) Modified by Krystof Beuermann for foodtracks.de --- _Source: https://npm.io/package/foodtracks-gatsby-plugin-matomo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._