Home

Awesome

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:

The following variables are optional:

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.