https://github.com/egidiusmengelberg/directus-extension-umami

Add Umami analytics to Directus
https://github.com/egidiusmengelberg/directus-extension-umami

Last synced: about 2 months ago
JSON representation

Add Umami analytics to Directus

• Host: GitHub
• URL: https://github.com/egidiusmengelberg/directus-extension-umami
• Owner: egidiusmengelberg
• License: mit
• Created: 2024-03-06T08:21:29.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-19T18:39:33.000Z (5 months ago)
• Last Synced: 2024-10-03T07:09:48.706Z (3 months ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/directus-extension-umami
• Size: 385 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-directus - Umami Analytics - Add Umami analytics to Directus. (Extensions / Community)

README

        
![Header](https://raw.githubusercontent.com/egidiusmengelberg/directus-extension-umami/main/docs/header.png)

# 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](https://umami.is/docs/tracker-configuration)

You can find an example environment file at [`.env.example`](.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](LICENSE.md).