npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

directus-extension-umami

v1.0.5

Published

Add Umami analytics to Directus

Downloads

10

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

egidiusmengelbergegidiusmengelberg

Keywords

directusdirectus-extensiondirectus-custom-hookumamianalytics

Readme

Header

Umami Directus Extension

This project is a directus extension for integrating Umami analytics. It's configurable using environment variables.

Installation

There are two options to install this extension:

  1. Using the extension marketplace inside Directus
  2. Using npm (run npm install directus-extension-umami inside your directus installation)

Configuration

To configure the extension, you need to set the following environment variables:

  • UMAMI_SRC: The source of your umami analytics script (example: https://umami.yourdomain.com/script.js)
  • UMAMI_WEBSITE_ID: The ID of your website
  • CONTENT_SECURITY_POLICY_DIRECTIVES__SCRIPT_SRC: This is needed to allow loading your umami script. It's value should be: 'self' 'unsafe-eval' 'https://umami.yourdomain.com'

The following variables are optional:

  • UMAMI_HOST_URL: The source of your umami analytics script (example: https://umami.yourdomain.com)
  • UMAMI_AUTO_TRACK: The source of your umami analytics script (example: false)
  • UMAMI_CACHE: If the umami script should cache events (example: true)
  • UMAMI_DOMAINS: The domains the script should send events about (example: www.yourdomain.com,yourdomain.com)
  • UMAMI_DEBUG: If the extension should log debug messages (example: true)

For more info you can check the umami docs

You can find an example environment file at .env.example.

Usage

When configured correctly you should be able to see events pop up in your umami installation.

Development

  1. Clone the repository: git clone https://github.com/egidiusmengelberg/directus-extension-umami.git && cd directus-extension-umami
  2. Install dependencies: npm install
  3. Copy .env.example file to .env: cp .env.example .env
  4. Configure environment variables in .env (check configuration for detailed explanation)
  5. Run directus in docker: docker compose up
  6. Run npm run dev to watch and build the extension

Contributing

Contributions are welcome! Please create a PR and use the provided linting script inside the package.json (npm run lint)

License

This project is licensed under the MIT License.