Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

gatsby-plugin-umami

All Contributors

Easily add Umami to your Gatsby site.

Install

npm install --save gatsby-plugin-umami

How to use

// In your gatsby-config.js
plugins: [
  {
    resolve: `gatsby-plugin-umami`,
    options: {
      websiteId: "UMAMI_WEBSITE_ID",
      srcUrl: "https://umami.example.com/umami.js",
      includeInDevelopment: false,
      autoTrack: true,
      respectDoNotTrack: true,
      dataCache: false,
      dataDomains: "example.com,example2.com",
    },
  },
];

Configuration

  • websiteId - Required. The website id of your umami site
  • srcUrl - Required. The url to the hosted umami.js
  • includeInDevelopment - Optional. Defaults to false
  • autoTrack - Optional. Enables umami auto track feature. Defaults to true
  • respectDoNotTrack - Optional. Enables umami respect Do Not Track feature. Defaults to true
  • dataCache - Optional. Improves performance. Defaults to false
  • dataDomains - Optional. Allows tracking only on the specified domains. No default.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


William Weiss

💻

Matt Banner

🐛

Florian Kapfenberger

💬 📖 👀 💻 🔧

This project follows the all-contributors specification. Contributions of any kind welcome!

© 2024 Gatsby, Inc.